Horizon
Public Member Functions | List of all members
SHAPE_INDEX< T >::Iterator Class Reference

Public Member Functions

 Iterator (SHAPE_INDEX *aIndex)
 Iterator constructor. More...
 
operator* ()
 Operator * (prefix) More...
 
bool operator++ ()
 Operator ++ (prefix) More...
 
bool operator++ (int)
 Operator ++ (postfix) More...
 
bool IsNull ()
 Function IsNull() More...
 
bool IsNotNull ()
 Function IsNotNull() More...
 
Next ()
 Function Next() More...
 

Constructor & Destructor Documentation

◆ Iterator()

template<class T = SHAPE*>
SHAPE_INDEX< T >::Iterator::Iterator ( SHAPE_INDEX aIndex)
inline

Iterator constructor.

Creates an iterator for the index object

Parameters
aIndexSHAPE_INDEX object to iterate

Member Function Documentation

◆ IsNotNull()

template<class T = SHAPE*>
bool SHAPE_INDEX< T >::Iterator::IsNotNull ( )
inline

Function IsNotNull()

Checks if the iterator has not reached the end.

Returns
true if it is in an valid position (data not finished)

◆ IsNull()

template<class T = SHAPE*>
bool SHAPE_INDEX< T >::Iterator::IsNull ( )
inline

Function IsNull()

Checks if the iterator has reached the end.

Returns
true if it is in an invalid position (data finished)

◆ Next()

template<class T = SHAPE*>
T SHAPE_INDEX< T >::Iterator::Next ( )
inline

Function Next()

Returns the current element of the iterator and moves to the next position.

Returns
SHAPE object pointed by the iterator before moving to the next position.

◆ operator*()

template<class T = SHAPE*>
T SHAPE_INDEX< T >::Iterator::operator* ( )
inline

Operator * (prefix)

Returns the next data element.

◆ operator++() [1/2]

template<class T = SHAPE*>
bool SHAPE_INDEX< T >::Iterator::operator++ ( )
inline

Operator ++ (prefix)

Shifts the iterator to the next element.

◆ operator++() [2/2]

template<class T = SHAPE*>
bool SHAPE_INDEX< T >::Iterator::operator++ ( int  )
inline

Operator ++ (postfix)

Shifts the iterator to the next element.


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