SHAPE_INDEX< T >::Iterator Class Reference

Public Member Functions
	Iterator (SHAPE_INDEX *aIndex)
	Create an iterator for the index object. More...
T	operator* ()
	Return the next data element.
bool	operator++ ()
	Shift the iterator to the next element.
bool	operator++ (int)
	Shift the iterator to the next element.
bool	IsNull () const
	Check if the iterator has reached the end. More...
bool	IsNotNull () const
	Check if the iterator has not reached the end. More...
T	Next ()
	Return the current element of the iterator and moves to the next position. More...

Constructor & Destructor Documentation

Iterator()

template<class T = SHAPE*>

SHAPE_INDEX< T >::Iterator::Iterator ( SHAPE_INDEX *  aIndex )

inline

Create an iterator for the index object.

Parameters

aIndex

is a SHAPE_INDEX object to iterate.

Member Function Documentation

IsNotNull()

template<class T = SHAPE*>

bool SHAPE_INDEX< T >::Iterator::IsNotNull ( ) const

inline

Check 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 ( ) const

inline

Check 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

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

Returns

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

---

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

• 3rd_party/router/kimath/include/geometry/shape_index.h