Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Examples

ost::MapIndex Class Reference

The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key. Index object to access MapTable elements. More...

#include <object.h>

List of all members.

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.

void * operator * () const
 Dereference operator: the pointed object it is returned as void * for easy re-cast.

MapIndexoperator= (MapObject *theObject)
 Assignment operator to avoid implicit cast.

MapIndexoperator++ ()
 Prefix increment operator, to be used in loops and such.

MapIndex operator++ (int)
 Postfix increment operator, to be used in loops and such.

bool operator== (const MapIndex &theIndex) const
 Comparison operator, between two MapIndex's.

bool operator!= (const MapIndex &theIndex) const
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 MapObject *theObject) const


Detailed Description

The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key. Index object to access MapTable elements.

It can be increased, checked and dereferenced like a pointer, by means of suitable operators.

Author:
Sergio Repetto <s.repetto@pentaengineering.it>


Constructor & Destructor Documentation

ost::MapIndex::MapIndex  )  [inline]
 

Creates an empty map index (pointing to nothing).

ost::MapIndex::MapIndex MapObject theObject  )  [inline]
 

Creates a map index pointing to a specific map object.

Parameters:
the indexed object

ost::MapIndex::MapIndex const MapIndex theIndex  )  [inline]
 

Creates a copy of a given map index.

Parameters:
the source index object


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.

bool ost::MapIndex::operator!= const MapObject theObject  )  const [inline]
 

bool ost::MapIndex::operator!= const MapIndex theIndex  )  const [inline]
 

MapIndex ost::MapIndex::operator++ int   )  [inline]
 

Postfix increment operator, to be used in loops and such.

Returns:
the object itself, as changed.

MapIndex& ost::MapIndex::operator++  ) 
 

Prefix increment operator, to be used in loops and such.

Returns:
the object itself, as changed.

MapIndex& ost::MapIndex::operator= MapObject theObject  ) 
 

Assignment operator to avoid implicit cast.

Returns:
the object itself, as changed.

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.

bool ost::MapIndex::operator== const MapIndex theIndex  )  const [inline]
 

Comparison operator, between two MapIndex's.

Returns:
the object itself, as changed.


The documentation for this class was generated from the following file:
Generated on Sun Mar 21 21:44:16 2010 for GNU CommonC++ by doxygen 1.3.5