logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

ost::MapIndex - The MapIndex allows linear access into a MapTable, that otherwise could have its elements

Author

       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++                                    Sun Dec 27 2020                                ost::MapIndex(3)

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.

       Parametersthe indexed object

   ost::MapIndex::MapIndex(constMapIndex&theIndex)[inline]
       Creates a copy of a given map index.

       Parametersthe source index object

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

Member Function Documentation

boolost::MapIndex::operator!=(constMapIndex&theIndex)const[inline]boolost::MapIndex::operator!=(constMapObject*theObject)const[inline]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.

   MapIndex&ost::MapIndex::operator++()
       Prefix increment operator, to be used in loops and such.

       Returns
           the object itself, as changed.

   MapIndexost::MapIndex::operator++(int)[inline]
       Postfix 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.

   boolost::MapIndex::operator==(constMapIndex&theIndex)const[inline]
       Comparison operator, between two MapIndex's.

       Returns
           the object itself, as changed.

   boolost::MapIndex::operator==(constMapObject*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.

Name

       ost::MapIndex - The MapIndex allows linear access into a MapTable, that otherwise could have its elements
       being retrieved only by key.

Synopsis

       #include <object.h>

   PublicMemberFunctionsMapIndex ()
           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.
       MapIndex & operator= (MapObject *theObject)
           Assignment operator to avoid implicit cast.
       MapIndex & operator++ ()
           Prefix increment operator, to be used in loops and such.
       MapIndexoperator++ (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

See Also