ost::MapIndex Class Reference
The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key. More...
#include <object.h>
Collaboration diagram for ost::MapIndex:
Public Member Functions | |
| MapIndex (const MapIndex &theIndex) | |
| Creates a copy of a given map index. | |
| MapIndex (MapObject *theObject) | |
| Creates a map index pointing to a specific map object. | |
| MapIndex () | |
| Creates an empty map index (pointing to nothing). | |
| bool | operator!= (const MapObject *theObject) const |
| bool | operator!= (const MapIndex &theIndex) const |
| void * | operator* () const |
| Dereference operator: the pointed object it is returned as void * for easy re-cast. | |
| MapIndex | operator++ (int) |
| Postfix increment operator, to be used in loops and such. | |
| MapIndex & | operator++ () |
| Prefix increment operator, to be used in loops and such. | |
| MapIndex & | operator= (MapObject *theObject) |
| Assignment operator to avoid implicit cast. | |
| bool | operator== (const MapObject *theObject) const |
| Comparison operator, between the MapIndex and a MapObject, useful to avoid casts for sake of clearness. | |
| bool | operator== (const MapIndex &theIndex) const |
| Comparison operator, between two MapIndex's. | |
Detailed Description
The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key.
It can be increased, checked and dereferenced like a pointer, by means of suitable operators.
Definition at line 469 of file object.h.
Constructor & Destructor Documentation
| ost::MapIndex::MapIndex | ( | MapObject * | theObject | ) | [inline] |
| ost::MapIndex::MapIndex | ( | const MapIndex & | theIndex | ) | [inline] |
Member Function Documentation
| void* ost::MapIndex::operator* | ( | ) | const [inline] |
| MapIndex ost::MapIndex::operator++ | ( | int | ) | [inline] |
| MapIndex& ost::MapIndex::operator++ | ( | ) |
Prefix increment operator, to be used in loops and such.
- Returns:
- the object itself, as changed.
Assignment operator to avoid implicit cast.
- Returns:
- the object itself, as changed.
| bool ost::MapIndex::operator== | ( | const MapObject * | theObject | ) | const [inline] |
| bool ost::MapIndex::operator== | ( | const MapIndex & | theIndex | ) | const [inline] |
The documentation for this class was generated from the following file:
- commoncpp/object.h
