| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Public Member Functions
TeNeighbours Class Reference

A class to representate the neighbours of a object. More...

`#include <TeNeighbours.h>`

List of all members.

## Public Types

typedef neigh_vector::iterator | iterator
typedef neigh_vector::const_iterator | const_iterator

## Public Member Functions

| TeNeighbours ()
| Empty constructor.
| TeNeighbours (const TeNeighboursMap &neigh)
| Copy constructor.
| TeNeighbours (const TeNeighbours &neigh)
| Copy constructor.
int | size () const
| Return the number of the neighbours.
iterator | begin ()
| Return a iterator to the begin of the neighbours.
iterator | end ()
| Return a iterator to the one past end of the neighbours.
string | ObjectId (int n)
| Return the n-th neighbour object_id, if n < map size.
string | operator[] (int n)
| Return the n-th neighbour object_id, if n < map size.
double | Weight (int n)
| Return the n-th connection weight (corresponding to the n-th neighbour), if n < map size.
double | Weight (const string &object_id)
| Return the connection weight, given the neighbour object_id.
TeProxMatrixAttributes | Attributes (int n)
| Return the complete set of connection attributes (corresponding to the ith neighbour), packed in a TeProxMatrixAttributes object.
bool | Insert (const string &object_id, const TeProxMatrixAttributes &attr)
| Insert a new neighbour.
bool | Remove (const string &object_id)
| Remove a neighbour.
TeNeighbours & | operator= (const TeNeighbours &neigh)
| Copy operator.
bool | operator== (const TeNeighbours &p)
| Comparison Operator.
virtual | ~TeNeighbours ()
| Destructor.

## Detailed Description

A class to representate the neighbours of a object.

## Member Typedef Documentation

typedef neigh_vector::const_iterator TeNeighbours::const_iterator

typedef neigh_vector::iterator TeNeighbours::iterator

## Constructor & Destructor Documentation

TeNeighbours::TeNeighbours | ( |  | ) | `[inline]`

Empty constructor.

TeNeighbours::TeNeighbours | ( | const TeNeighboursMap & | neigh | ) |

Copy constructor.

TeNeighbours::TeNeighbours | ( | const TeNeighbours & | neigh | ) |

Copy constructor.

virtual TeNeighbours::~TeNeighbours | ( |  | ) | `[inline, virtual]`

Destructor.

## Member Function Documentation

TeProxMatrixAttributes TeNeighbours::Attributes | ( | int | n | ) |

Return the complete set of connection attributes (corresponding to the ith neighbour), packed in a TeProxMatrixAttributes object.

iterator TeNeighbours::begin | ( | void |  | ) | `[inline]`

Return a iterator to the begin of the neighbours.

iterator TeNeighbours::end | ( | void |  | ) | `[inline]`

Return a iterator to the one past end of the neighbours.

bool TeNeighbours::Insert | ( | const string & | object_id,
|  | const TeProxMatrixAttributes & | attr
| ) |  |

Insert a new neighbour.

string TeNeighbours::ObjectId | ( | int | n | ) |

Return the n-th neighbour object_id, if n < map size.

TeNeighbours & TeNeighbours::operator= | ( | const TeNeighbours & | neigh | ) |

Copy operator.

bool TeNeighbours::operator== | ( | const TeNeighbours & | p | ) |

Comparison Operator.

string TeNeighbours::operator[] | ( | int | n | ) |

Return the n-th neighbour object_id, if n < map size.

bool TeNeighbours::Remove | ( | const string & | object_id | ) |

Remove a neighbour.

int TeNeighbours::size | ( | void |  | ) | const`[inline]`

Return the number of the neighbours.

double TeNeighbours::Weight | ( | const string & | object_id | ) |

Return the connection weight, given the neighbour object_id.

double TeNeighbours::Weight | ( | int | n | ) |

Return the n-th connection weight (corresponding to the n-th neighbour), if n < map size.

The documentation for this class was generated from the following files:

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/kernel/TeNeighbours.h
- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/kernel/TeNeighbours.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines