File: recRsrcIter.h.

Class: DtRecursiveResourceIterator Description: 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.

Inheritance diagram for DtRecursiveResourceIterator:

[legend]

Public Member Functions
	DtRecursiveResourceIterator (const DtList &list)

virtual	~DtRecursiveResourceIterator ()

DtSimResource *	first (bool move=true)

DtSimResource *	current () const

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

void	reset ()

Public Member Functions inherited from DtIteratorBase< DtSimResource >
	DtIteratorBase (const DtList &list)

	DtIteratorBase (const DtIteratorBase &orig)

virtual	~DtIteratorBase ()

virtual unsigned int	size () const

virtual bool	empty () const

virtual const DtList &	list () const

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 int	cursorIndex () const

virtual void	setCursorIndex (int i)

virtual DtSimResource *	internalFirst (bool move=true)

DtSimResource *	operator-> ()

DtSimResource *	operator* ()

virtual DtSimResource *	internalCurrent () const

virtual DtListItem *	cursor () const

virtual DtSimResource *	itemToObject (DtListItem *item, bool move)

virtual DtSimResource *	internalNext (bool move=true)

virtual DtSimResource *	internalLast (bool move=true)

virtual DtSimResource *	internalWrapNext (bool move=true)

virtual DtSimResource *	internalPrev (bool move=true)

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

	DtRecursiveResourceIterator (const DtRecursiveResourceIterator &orig)

const DtRecursiveResourceIterator &	operator= (const DtRecursiveResourceIterator &orig)

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 >.

References DtIteratorBase< T >::first().

Referenced by DtMunitionResourceIterator::first().

DtSimResource* DtRecursiveResourceIterator::current ( ) const

inline

returns the current object. List index is unmodified.

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.

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.

References DtIteratorBase< T >::reset().

Member Data Documentation

DtRecursiveResourceIterator* DtRecursiveResourceIterator::myChildIterator

protected

Referenced by current().

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

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

Public Member Functions

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation