DtRecursiveStateRepositoryIterator Class Reference

File: recSRIter.h. More...

Inheritance diagram for DtRecursiveStateRepositoryIterator:

Public Member Functions
	DtRecursiveStateRepositoryIterator (const DtList &list)
	Constructor.
virtual	~DtRecursiveStateRepositoryIterator ()
	Destructor.
DtSimObjectStateRepository *	first (bool reset=true)
	Calls reset() if reset arg is true (useful for for() loops).
DtSimObjectStateRepository *	current () const
	returns the current object. List index is unmodified.
DtSimObjectStateRepository *	next ()
	moves the index to the next position and returns the object at that position in the list.
void	reset ()
	sets the current pointer to the start of the list.
Public Member Functions inherited from DtIteratorBase< DtSimObjectStateRepository >
	DtIteratorBase (const DtList &list)
	Constructor. Supply the DtList to be iterated over.
	DtIteratorBase (const DtIteratorBase &orig)
	Copy constructor.
virtual	~DtIteratorBase ()
virtual unsigned int	size () const
virtual bool	empty () const
virtual const DtList &	list ()
virtual bool	reset (bool reverse=false)
	Sets the cursor and the direction of this iterator over the list.
virtual bool	reset (DtIteratorLocation location, DtIteratorDirection direction=DtIteratorForward)
	Sets the cursor and the direction of this iterator over the list.
virtual void	reverse ()
	Reverses the direction if this iterator. The cursor is not moved.
virtual void	setDirection (DtIteratorDirection direction)
	Sets the direction of this iterator. The cursor is not moved.
virtual DtIteratorDirection	direction ()
	Returns the current direction of the iterator.
virtual int	cursorIndex () const
	Returns current cursor index in list.
virtual void	setCursorIndex (int i)
virtual DtSimObjectStateRepository *	internalFirst (bool move=true)
	Returns the first vertex in the list if going DtIteratorForward, and the last vertex if going DtIteratorReverse.
virtual DtSimObjectStateRepository *	internalCurrent () const
	Returns the current vertex. The cursor is not moved.
virtual DtListItem *	cursor () const
	Returns the current cursor. Use with caution.
virtual DtSimObjectStateRepository *	itemToObject (DtListItem *item, bool move)
virtual DtSimObjectStateRepository *	internalNext (bool move=true)
virtual DtSimObjectStateRepository *	internalLast (bool move=true)
	Returns the last vertex in the list if going DtIteratorForward, and the first vertex if going DtIteratorReverse.
virtual DtSimObjectStateRepository *	internalWrapNext (bool move=true)
	If the cursor is 0, returns 0 (move is ignored in this case).
virtual DtSimObjectStateRepository *	internalPrev (bool move=true)
	If the cursor is 0, returns 0 (move is ignored in this case).
virtual DtSimObjectStateRepository *	internalWrapPrev (bool move=true)
virtual DtSimObjectStateRepository *	current ()
virtual DtSimObjectStateRepository *	next (bool move=true)
virtual DtSimObjectStateRepository *	prev (bool move=true)
virtual DtSimObjectStateRepository *	last (bool move=true)
virtual DtSimObjectStateRepository *	wrapNext (bool move=true)
virtual DtSimObjectStateRepository *	wrapPrev (bool move=true)
DtSimObjectStateRepository *	operator++ ()
DtSimObjectStateRepository *	operator-- ()

Protected Attributes
DtRecursiveStateRepositoryIterator *	myChildIterator
Protected Attributes inherited from DtIteratorBase< DtSimObjectStateRepository >
const DtList &	myList
DtListItem *	myCursor
DtIteratorDirection	myDirection

Private Member Functions
	DtRecursiveStateRepositoryIterator ()
	Default Constructor. Do not use.
	DtRecursiveStateRepositoryIterator (const DtRecursiveStateRepositoryIterator &orig)
	Copy Constructor.
const DtRecursiveStateRepositoryIterator &	operator= (const DtRecursiveStateRepositoryIterator &orig)
	Assignment Operator.

Detailed Description

File: recSRIter.h.

Class: DtRecursiveStateRepositoryIterator Iterator for iterating over a DtList of state repositories and all its descendants (as represented by each repository's attachment manager). This iterator performs an pre-order iteration over the 'forest' that represents the SR's descendants. Spawned by DtAttachmentManager.

Constructor & Destructor Documentation

DtRecursiveStateRepositoryIterator::DtRecursiveStateRepositoryIterator ( )

private

Default Constructor. Do not use.

DtRecursiveStateRepositoryIterator::DtRecursiveStateRepositoryIterator ( const DtRecursiveStateRepositoryIterator &  orig )

private

Copy Constructor.

DtRecursiveStateRepositoryIterator::DtRecursiveStateRepositoryIterator ( const DtList &  list )

inline

Constructor.

virtual DtRecursiveStateRepositoryIterator::~DtRecursiveStateRepositoryIterator ( )

inlinevirtual

Destructor.

Member Function Documentation

const DtRecursiveStateRepositoryIterator& DtRecursiveStateRepositoryIterator::operator= ( const DtRecursiveStateRepositoryIterator &  orig )

private

Assignment Operator.

DtSimObjectStateRepository* DtRecursiveStateRepositoryIterator::first ( bool  reset = true )

inlinevirtual

Calls reset() if reset arg is true (useful for for() loops).

Returns the first object on the list

Reimplemented from DtIteratorBase< DtSimObjectStateRepository >.

Referenced by next().

DtSimObjectStateRepository* DtRecursiveStateRepositoryIterator::current ( ) const

inline

returns the current object. List index is unmodified.

References myChildIterator.

DtSimObjectStateRepository* DtRecursiveStateRepositoryIterator::next ( )

inline

moves the index to the next position and returns the object at that position in the list.

Returns null if already at the end of list.

References DtSimObjectStateRepository::attachments(), DtIteratorBase< T >::current(), DtAttachmentManager::elements(), first(), and DtAttachmentManager::numAttachments().

void DtRecursiveStateRepositoryIterator::reset ( )

inline

sets the current pointer to the start of the list.

Normally this isn't needed if you use the standard for loop syntax.

Member Data Documentation

DtRecursiveStateRepositoryIterator* DtRecursiveStateRepositoryIterator::myChildIterator

protected

Referenced by current().

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/recSRIter.h