File: munitRsrcIter.h.

Class: DtMunitionResourceIterator Description: DtMunitionResourceIterator is an iterator for iterating over only the munition resources in a resource list. It has recursive ability if the user wants to iterator over all resources and their subresources. Default is no recursion.

Inheritance diagram for DtMunitionResourceIterator:

[legend]

Public Member Functions
	DtMunitionResourceIterator (const DtList &list)

virtual	~DtMunitionResourceIterator ()

DtMunitionResource *	first ()

DtMunitionResource *	current () const

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

DtMunitionResource *	firstMatch (DtSimResource *initial, bool move=true, bool recurse=false)

Public Member Functions inherited from DtRecursiveResourceIterator
	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-- ()

Private Member Functions
	DtMunitionResourceIterator ()

	DtMunitionResourceIterator (const DtMunitionResourceIterator &orig)

const DtMunitionResourceIterator &	operator= (const DtMunitionResourceIterator &orig)

Additional Inherited Members
Protected Attributes inherited from DtRecursiveResourceIterator
DtRecursiveResourceIterator *	myChildIterator

Protected Attributes inherited from DtIteratorBase< DtSimResource >
const DtList &	myList

DtListItem *	myCursor

DtIteratorDirection	myDirection

Constructor & Destructor Documentation

DtMunitionResourceIterator::DtMunitionResourceIterator ( )

private

Default Constructor. Do not use.

DtMunitionResourceIterator::DtMunitionResourceIterator ( const DtMunitionResourceIterator & orig )

private

Copy Constructor.

DtMunitionResourceIterator::DtMunitionResourceIterator ( const DtList & list )

inline

Constructor.

virtual DtMunitionResourceIterator::~DtMunitionResourceIterator ( )

inlinevirtual

Destructor.

Member Function Documentation

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

private

Assignment Operator.

DtMunitionResource* DtMunitionResourceIterator::first ( )

inline

Calls reset() if reset arg is true (useful for for() loops). Returns the first object on the list.

References DtRecursiveResourceIterator::first().

DtMunitionResource* DtMunitionResourceIterator::current ( ) const

inline

returns the current object. List index is unmodified.

References DtRecursiveResourceIterator::current().

DtMunitionResource* DtMunitionResourceIterator::next	(	bool	move = `true`,
		bool	recurse = `false`
	)

inline

moves the index to the next munition resource found in the list 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 DtRecursiveResourceIterator::next().

DtMunitionResource* DtMunitionResourceIterator::firstMatch	(	DtSimResource *	initial,
		bool	move = `true`,
		bool	recurse = `false`
	)

inline

Returns the first item matching the filter test, starting with the given initial item.

References DtRecursiveResourceIterator::current(), DtMunitionResourceType, DtRecursiveResourceIterator::next(), and DtSimResource::type().

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

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

Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation