DtRecursiveResourceIterator Class Reference

File: recRsrcIter.h. More...

Inheritance diagram for DtRecursiveResourceIterator:

Public Member Functions
	DtRecursiveResourceIterator (const DtList &list)
	Constructor.
virtual	~DtRecursiveResourceIterator ()
	Destructor.
DtSimResource *	first (bool move=true)
	Calls reset() if reset arg is true (useful for for() loops).
DtSimResource *	current () const
	returns the current object. List index is unmodified.
DtSimResource *	next (bool move=true, bool recurse=false)
	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< DtSimResource >
	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 DtSimResource *	internalFirst (bool move=true)
	Returns the first vertex in the list if going DtIteratorForward, and the last vertex if going DtIteratorReverse.
virtual DtSimResource *	internalCurrent () const
	Returns the current vertex. The cursor is not moved.
virtual DtListItem *	cursor () const
	Returns the current cursor. Use with caution.
virtual DtSimResource *	itemToObject (DtListItem *item, bool move)
virtual DtSimResource *	internalNext (bool move=true)
virtual DtSimResource *	internalLast (bool move=true)
	Returns the last vertex in the list if going DtIteratorForward, and the first vertex if going DtIteratorReverse.
virtual DtSimResource *	internalWrapNext (bool move=true)
	If the cursor is 0, returns 0 (move is ignored in this case).
virtual DtSimResource *	internalPrev (bool move=true)
	If the cursor is 0, returns 0 (move is ignored in this case).
virtual DtSimResource *	internalWrapPrev (bool move=true)
virtual DtSimResource *	current ()
virtual DtSimResource *	next (bool move=true)
virtual DtSimResource *	prev (bool move=true)
virtual DtSimResource *	last (bool move=true)
virtual DtSimResource *	wrapNext (bool move=true)
virtual DtSimResource *	wrapPrev (bool move=true)
DtSimResource *	operator++ ()
DtSimResource *	operator-- ()

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

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

Detailed Description

File: recRsrcIter.h.

Class: DtRecursiveResourceIteratorDescription: DtRecursiveResourceIterator is an iterator for iterating over a DtResourceList of DtSimResource pointers. It has recursive ability if the user wants to iterator over all resources and their subresources. Default is no recursion.

Constructor & Destructor Documentation

DtRecursiveResourceIterator::DtRecursiveResourceIterator ( )

private

Default Constructor. Do not use.

DtRecursiveResourceIterator::DtRecursiveResourceIterator ( const DtRecursiveResourceIterator &  orig )

private

Copy Constructor.

DtRecursiveResourceIterator::DtRecursiveResourceIterator ( const DtList &  list )

inline

Constructor.

virtual DtRecursiveResourceIterator::~DtRecursiveResourceIterator ( )

inlinevirtual

Destructor.

Member Function Documentation

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

private

Assignment Operator.

DtSimResource* DtRecursiveResourceIterator::first ( bool  move = true )

inlinevirtual

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

Returns the first object on the list

Reimplemented from DtIteratorBase< DtSimResource >.

Referenced by DtMunitionResourceIterator::first().

DtSimResource* DtRecursiveResourceIterator::current ( ) const

inline

returns the current object. List index is unmodified.

Reimplemented in DtMunitionResourceIterator.

References myChildIterator.

Referenced by DtMunitionResourceIterator::current(), and DtMunitionResourceIterator::firstMatch().

DtSimResource* DtRecursiveResourceIterator::next ( bool  move = true, bool  recurse = false  )

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. By default we don't recurse into the subresources.

Reimplemented in DtMunitionResourceIterator.

References DtIteratorBase< T >::current(), and DtSimResource::subresources().

Referenced by DtMunitionResourceIterator::firstMatch(), and DtMunitionResourceIterator::next().

void DtRecursiveResourceIterator::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

DtRecursiveResourceIterator* DtRecursiveResourceIterator::myChildIterator

protected

Referenced by current().

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/recRscrIter.h