DtRecursiveResourceIterator Class Reference

File: recRsrcIter.h. More...

Inheritance diagram for DtRecursiveResourceIterator:

List of all members.

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.
Protected Attributes
DtRecursiveResourceIterator *	myChildIterator
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: 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.

---

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

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

const DtRecursiveResourceIterator& DtRecursiveResourceIterator::operator=

(

const DtRecursiveResourceIterator &

orig

)

[private]

Assignment Operator.

DtSimResource* DtRecursiveResourceIterator::first

(

bool

move = true

)

[inline, virtual]

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:

• include/vrfutil/recRscrIter.h