GNU CommonC++
Public Member Functions | List of all members
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>

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.

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

Author
Sergio Repetto s.rep.nosp@m.etto.nosp@m.@pent.nosp@m.aeng.nosp@m.ineer.nosp@m.ing..nosp@m.it

Index object to access MapTable elements

Constructor & Destructor Documentation

◆ MapIndex() [1/3]

ost::MapIndex::MapIndex ( )
inline

Creates an empty map index (pointing to nothing).

◆ MapIndex() [2/3]

ost::MapIndex::MapIndex ( MapObject theObject)
inline

Creates a map index pointing to a specific map object.

Parameters
theindexed object

◆ MapIndex() [3/3]

ost::MapIndex::MapIndex ( const MapIndex theIndex)
inline

Creates a copy of a given map index.

Parameters
thesource index object

Member Function Documentation

◆ operator!=() [1/2]

bool ost::MapIndex::operator!= ( const MapIndex theIndex) const
inline

◆ operator!=() [2/2]

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

◆ operator*()

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.

◆ operator++() [1/2]

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

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

Returns
the object itself, as changed.

◆ operator++() [2/2]

MapIndex ost::MapIndex::operator++ ( int  )
inline

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

Returns
the object itself, as changed.

◆ operator=()

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

Assignment operator to avoid implicit cast.

Returns
the object itself, as changed.

◆ operator==() [1/2]

bool ost::MapIndex::operator== ( const MapIndex theIndex) const
inline

Comparison operator, between two MapIndex's.

Returns
the object itself, as changed.

◆ operator==() [2/2]

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.

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