DtMapIteratorBase< K, T > Class Template Reference

template<class K, class T>
class DtMapIteratorBase< K, T >

Description: DtMapIteratorBase is the base class for iterators used to iterate over a std::map. It wraps the std::map::iterator to provide an interface similar to DtIteratorBase.

Public Member Functions
	DtMapIteratorBase (const std::map< K, T * > &map)
	DtMapIteratorBase (const DtMapIteratorBase &orig)
virtual	~DtMapIteratorBase ()
virtual unsigned int	size () const
virtual bool	empty () const
virtual const std::map< K, T * > &	map ()
virtual bool	reset (bool reverse=false)
virtual bool	reset (DtIteratorLocation location, DtIteratorDirection direction=DtIteratorForward)
virtual void	reverse ()
virtual void	setDirection (DtIteratorDirection direction)
virtual DtIteratorDirection	direction ()
virtual T *	internalFirst (bool move=true)
T *	operator-> ()
T *	operator* ()
virtual T *	internalCurrent () const
virtual T *	internalNext (bool move=true)
virtual T *	internalLast (bool move=true)
virtual T *	internalWrapNext (bool move=true)
virtual T *	internalPrev (bool move=true)
virtual T *	internalWrapPrev (bool move=true)
virtual T *	current ()
virtual T *	first (bool move=true)
virtual T *	next (bool move=true)
virtual T *	prev (bool move=true)
virtual T *	last (bool move=true)
virtual T *	wrapNext (bool move=true)
virtual T *	wrapPrev (bool move=true)
T *	operator++ ()
T *	operator-- ()

Protected Attributes
std::map< K, T * >	myMap
std::map< K, T * >::const_iterator	myCursor
DtIteratorDirection	myDirection

Private Member Functions
	DtMapIteratorBase ()
const DtMapIteratorBase &	operator= (const DtMapIteratorBase &orig)

Constructor & Destructor Documentation

template<class K , class T >

DtMapIteratorBase< K, T >::DtMapIteratorBase ( )

private

template<class K , class T >

DtMapIteratorBase< K, T >::DtMapIteratorBase ( const std::map< K, T * > &  map )

inline

Constructor. Supply the DtList to be iterated over.

References DtMapIteratorBase< K, T >::first().

template<class K , class T >

DtMapIteratorBase< K, T >::DtMapIteratorBase ( const DtMapIteratorBase< K, T > &  orig )

inline

Copy constructor.

template<class K , class T >

virtual DtMapIteratorBase< K, T >::~DtMapIteratorBase ( )

inlinevirtual

Member Function Documentation

template<class K , class T >

const DtMapIteratorBase& DtMapIteratorBase< K, T >::operator= ( const DtMapIteratorBase< K, T > &  orig )

private

Assignment Operator.

template<class K , class T >

virtual unsigned int DtMapIteratorBase< K, T >::size ( ) const

inlinevirtual

Returns

The size of the container being iterated over.

References DtMapIteratorBase< K, T >::myMap.

template<class K , class T >

virtual bool DtMapIteratorBase< K, T >::empty ( ) const

inlinevirtual

Returns

A boolean specifying whether or not the container being iterated over is empty or not.

References DtMapIteratorBase< K, T >::myMap.

template<class K , class T >

virtual const std::map<K, T*>& DtMapIteratorBase< K, T >::map ( )

inlinevirtual

References DtMapIteratorBase< K, T >::myMap.

template<class K , class T >

virtual bool DtMapIteratorBase< K, T >::reset ( bool  reverse = false )

inlinevirtual

Sets the cursor and the direction of this iterator over the list. If reverse is false, DtIteratorBeginning and DtIteratorForward are used, otherwise, DtIteratorEnd and DtIteratorReverse are used. Returns true unless the list is empty.

References DtIteratorBeginning, DtIteratorEnd, DtIteratorForward, DtIteratorReverse, and DtMapIteratorBase< K, T >::reverse().

Referenced by DtMapIteratorBase< K, T >::internalFirst(), and DtMapIteratorBase< K, T >::internalLast().

template<class K , class T >

virtual bool DtMapIteratorBase< K, T >::reset ( DtIteratorLocation  location, DtIteratorDirection  direction = DtIteratorForward  )

inlinevirtual

Sets the cursor and the direction of this iterator over the list.

References DtMapIteratorBase< K, T >::direction(), DtIteratorBeginning, DtIteratorEnd, DtMapIteratorBase< K, T >::myCursor, DtMapIteratorBase< K, T >::myDirection, and DtMapIteratorBase< K, T >::myMap.

template<class K , class T >

virtual void DtMapIteratorBase< K, T >::reverse ( )

inlinevirtual

Reverses the direction of this iterator. The cursor is not moved.

References DtIteratorForward, DtIteratorReverse, and DtMapIteratorBase< K, T >::myDirection.

Referenced by DtMapIteratorBase< K, T >::reset().

template<class K , class T >

virtual void DtMapIteratorBase< K, T >::setDirection ( DtIteratorDirection  direction )

inlinevirtual

Sets the direction of this iterator. The cursor is not moved.

References DtMapIteratorBase< K, T >::direction(), and DtMapIteratorBase< K, T >::myDirection.

template<class K , class T >

virtual DtIteratorDirection DtMapIteratorBase< K, T >::direction ( )

inlinevirtual

Returns the current direction of the iterator.

References DtMapIteratorBase< K, T >::myDirection.

Referenced by DtMapIteratorBase< K, T >::reset(), and DtMapIteratorBase< K, T >::setDirection().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::internalFirst ( bool  move = true )

inlinevirtual

Returns the first vertex in the list if going DtIteratorForward, and the last vertex if going DtIteratorReverse. If move is true, first() resets this iterator to DtIteratorBeginning and DtIteratorForward if going DtIteratorForward DtIteratorEnd and DtIteratorReverse if going DtIteratorReverse.

References DtIteratorForward, DtMapIteratorBase< K, T >::myDirection, DtMapIteratorBase< K, T >::myMap, and DtMapIteratorBase< K, T >::reset().

Referenced by DtMapIteratorBase< K, T >::first().

template<class K , class T >

T* DtMapIteratorBase< K, T >::operator-> ( )

inline

References DtMapIteratorBase< K, T >::current().

template<class K , class T >

T* DtMapIteratorBase< K, T >::operator* ( )

inline

References DtMapIteratorBase< K, T >::current().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::internalCurrent ( ) const

inlinevirtual

Returns the current vertex. The cursor is not moved.

References DtMapIteratorBase< K, T >::myCursor, and DtMapIteratorBase< K, T >::myMap.

Referenced by DtMapIteratorBase< K, T >::current().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::internalNext ( bool  move = true )

inlinevirtual

References DtIteratorForward, DtMapIteratorBase< K, T >::myCursor, DtMapIteratorBase< K, T >::myDirection, and DtMapIteratorBase< K, T >::myMap.

Referenced by DtMapIteratorBase< K, T >::next().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::internalLast ( bool  move = true )

inlinevirtual

Returns the last vertex in the list if going DtIteratorForward, and the first vertex if going DtIteratorReverse. If move is true, last() resets this iterator to DtIteratorEnd and DtIteratorReverse if going DtIteratorForward DtIteratorBeginning and DtIteratorForward if going DtIteratorReverse.

References DtIteratorForward, DtMapIteratorBase< K, T >::myDirection, DtMapIteratorBase< K, T >::myMap, and DtMapIteratorBase< K, T >::reset().

Referenced by DtMapIteratorBase< K, T >::last().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::internalWrapNext ( bool  move = true )

inlinevirtual

If the cursor is 0, returns 0 (move is ignored in this case). Otherwise, returns the vertex at the next position in the list in the current direction and if move is true, moves the cursor there.

References DtIteratorForward, DtMapIteratorBase< K, T >::myCursor, DtMapIteratorBase< K, T >::myDirection, and DtMapIteratorBase< K, T >::myMap.

Referenced by DtMapIteratorBase< K, T >::wrapNext().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::internalPrev ( bool  move = true )

inlinevirtual

If the cursor is 0, returns 0 (move is ignored in this case). Otherwise, returns the vertex at the previous position in the list in the current direction and if move is true, moves the cursor there.

References DtIteratorForward, DtMapIteratorBase< K, T >::myCursor, DtMapIteratorBase< K, T >::myDirection, and DtMapIteratorBase< K, T >::myMap.

Referenced by DtMapIteratorBase< K, T >::prev().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::internalWrapPrev ( bool  move = true )

inlinevirtual

References DtIteratorForward, DtMapIteratorBase< K, T >::myCursor, DtMapIteratorBase< K, T >::myDirection, and DtMapIteratorBase< K, T >::myMap.

Referenced by DtMapIteratorBase< K, T >::wrapPrev().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::current ( )

inlinevirtual

References DtMapIteratorBase< K, T >::internalCurrent().

Referenced by DtMapIteratorBase< K, T >::operator*(), and DtMapIteratorBase< K, T >::operator->().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::first ( bool  move = true )

inlinevirtual

References DtMapIteratorBase< K, T >::internalFirst().

Referenced by DtMapIteratorBase< K, T >::DtMapIteratorBase().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::next ( bool  move = true )

inlinevirtual

References DtMapIteratorBase< K, T >::internalNext().

Referenced by DtMapIteratorBase< K, T >::operator++().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::prev ( bool  move = true )

inlinevirtual

References DtMapIteratorBase< K, T >::internalPrev().

Referenced by DtMapIteratorBase< K, T >::operator--().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::last ( bool  move = true )

inlinevirtual

References DtMapIteratorBase< K, T >::internalLast().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::wrapNext ( bool  move = true )

inlinevirtual

References DtMapIteratorBase< K, T >::internalWrapNext().

template<class K , class T >

virtual T* DtMapIteratorBase< K, T >::wrapPrev ( bool  move = true )

inlinevirtual

References DtMapIteratorBase< K, T >::internalWrapPrev().

template<class K , class T >

T* DtMapIteratorBase< K, T >::operator++ ( )

inline

References DtMapIteratorBase< K, T >::next().

template<class K , class T >

T* DtMapIteratorBase< K, T >::operator-- ( )

inline

References DtMapIteratorBase< K, T >::prev().

Member Data Documentation

template<class K , class T >

std::map<K, T*> DtMapIteratorBase< K, T >::myMap

protected

const std::map<K, T*>& myMap; Will be slower, but, in order to be thread safe this must be a copy, not a pointer to the list

Referenced by DtMapIteratorBase< K, T >::empty(), DtMapIteratorBase< K, T >::internalCurrent(), DtMapIteratorBase< K, T >::internalFirst(), DtMapIteratorBase< K, T >::internalLast(), DtMapIteratorBase< K, T >::internalNext(), DtMapIteratorBase< K, T >::internalPrev(), DtMapIteratorBase< K, T >::internalWrapNext(), DtMapIteratorBase< K, T >::internalWrapPrev(), DtMapIteratorBase< K, T >::map(), DtMapIteratorBase< K, T >::reset(), and DtMapIteratorBase< K, T >::size().

template<class K , class T >

std::map<K, T*>::const_iterator DtMapIteratorBase< K, T >::myCursor

protected

Referenced by DtMapIteratorBase< K, T >::internalCurrent(), DtMapIteratorBase< K, T >::internalNext(), DtMapIteratorBase< K, T >::internalPrev(), DtMapIteratorBase< K, T >::internalWrapNext(), DtMapIteratorBase< K, T >::internalWrapPrev(), and DtMapIteratorBase< K, T >::reset().

template<class K , class T >

DtIteratorDirection DtMapIteratorBase< K, T >::myDirection

protected

Referenced by DtMapIteratorBase< K, T >::direction(), DtMapIteratorBase< K, T >::internalFirst(), DtMapIteratorBase< K, T >::internalLast(), DtMapIteratorBase< K, T >::internalNext(), DtMapIteratorBase< K, T >::internalPrev(), DtMapIteratorBase< K, T >::internalWrapNext(), DtMapIteratorBase< K, T >::internalWrapPrev(), DtMapIteratorBase< K, T >::reset(), DtMapIteratorBase< K, T >::reverse(), and DtMapIteratorBase< K, T >::setDirection().

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/mapIteratorBase.h