The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key.
More...
#include <object.h>
Public Member Functions |
| MapIndex () |
| Creates an empty map index (pointing to nothing).
|
| MapIndex (MapObject *theObject) |
| Creates a map index pointing to a specific map object.
|
| MapIndex (const MapIndex &theIndex) |
| Creates a copy of a given map index.
|
bool | operator!= (const MapIndex &theIndex) const |
bool | operator!= (const MapObject *theObject) const |
void * | operator* () const |
| Dereference operator: the pointed object it is returned as void * for easy re-cast.
|
MapIndex & | operator++ () |
| Prefix increment operator, to be used in loops and such.
|
MapIndex | operator++ (int) |
| Postfix increment operator, to be used in loops and such.
|
MapIndex & | operator= (MapObject *theObject) |
| Assignment operator to avoid implicit cast.
|
bool | operator== (const MapIndex &theIndex) const |
| Comparison operator, between two MapIndex's.
|
bool | operator== (const MapObject *theObject) const |
| Comparison operator, between the MapIndex and a MapObject, useful to avoid casts for sake of clearness.
|
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.
- Author:
- Sergio Repetto <s.repetto@pentaengineering.it> Index object to access MapTable elements
Definition at line 469 of file object.h.
Constructor & Destructor Documentation
Creates a map index pointing to a specific map object.
- Parameters:
-
Definition at line 485 of file object.h.
Creates a copy of a given map index.
- Parameters:
-
Definition at line 492 of file object.h.
Member Function Documentation
void* ost::MapIndex::operator* |
( |
| ) |
const [inline] |
Dereference operator: the pointed object it is returned as void * for easy re-cast.
- Returns:
- pointer to indexed object.
Definition at line 500 of file object.h.
Prefix increment operator, to be used in loops and such.
- Returns:
- the object itself, as changed.
MapIndex ost::MapIndex::operator++ |
( |
int |
| ) |
[inline] |
Postfix increment operator, to be used in loops and such.
- Returns:
- the object itself, as changed.
Definition at line 522 of file object.h.
Assignment operator to avoid implicit cast.
- Returns:
- the object itself, as changed.
bool ost::MapIndex::operator== |
( |
const MapIndex & |
theIndex | ) |
const [inline] |
Comparison operator, between two MapIndex's.
- Returns:
- the object itself, as changed.
Definition at line 530 of file object.h.
bool ost::MapIndex::operator== |
( |
const MapObject * |
theObject | ) |
const [inline] |
Comparison operator, between the MapIndex and a MapObject, useful to avoid casts for sake of clearness.
- Returns:
- the object itself, as changed.
Definition at line 542 of file object.h.
The documentation for this class was generated from the following file: