VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Private Member Functions
DtMunitionResourceIterator Class Reference

File: munitRsrcIter.h. More...

Inheritance diagram for DtMunitionResourceIterator:
Inheritance graph
[legend]

Public Member Functions

 DtMunitionResourceIterator (const DtList &list)
 Constructor.
virtual ~DtMunitionResourceIterator ()
 Destructor.
DtMunitionResourcefirst ()
 Calls reset() if reset arg is true (useful for for() loops).
DtMunitionResourcecurrent () const
 returns the current object. List index is unmodified.
DtMunitionResourcenext (bool move=true, bool recurse=false)
 moves the index to the next munition resource found in the list and returns the object at that position in the list.
DtMunitionResourcefirstMatch (DtSimResource *initial, bool move=true, bool recurse=false)
 Returns the first item matching the filter test, starting with the given initial item.
- Public Member Functions inherited from DtRecursiveResourceIterator
 DtRecursiveResourceIterator (const DtList &list)
 Constructor.
virtual ~DtRecursiveResourceIterator ()
 Destructor.
DtSimResourcefirst (bool move=true)
 Calls reset() if reset arg is true (useful for for() loops).
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 DtSimResourceinternalFirst (bool move=true)
 Returns the first vertex in the list if going DtIteratorForward, and the last vertex if going DtIteratorReverse.
virtual DtSimResourceinternalCurrent () const
 Returns the current vertex. The cursor is not moved.
virtual DtListItem * cursor () const
 Returns the current cursor. Use with caution.
virtual DtSimResourceitemToObject (DtListItem *item, bool move)
virtual DtSimResourceinternalNext (bool move=true)
virtual DtSimResourceinternalLast (bool move=true)
 Returns the last vertex in the list if going DtIteratorForward, and the first vertex if going DtIteratorReverse.
virtual DtSimResourceinternalWrapNext (bool move=true)
 If the cursor is 0, returns 0 (move is ignored in this case).
virtual DtSimResourceinternalPrev (bool move=true)
 If the cursor is 0, returns 0 (move is ignored in this case).
virtual DtSimResourceinternalWrapPrev (bool move=true)
virtual DtSimResourcecurrent ()
virtual DtSimResourcenext (bool move=true)
virtual DtSimResourceprev (bool move=true)
virtual DtSimResourcelast (bool move=true)
virtual DtSimResourcewrapNext (bool move=true)
virtual DtSimResourcewrapPrev (bool move=true)
DtSimResourceoperator++ ()
DtSimResourceoperator-- ()

Private Member Functions

 DtMunitionResourceIterator ()
 Default Constructor. Do not use.
 DtMunitionResourceIterator (const DtMunitionResourceIterator &orig)
 Copy Constructor.
const DtMunitionResourceIteratoroperator= (const DtMunitionResourceIterator &orig)
 Assignment Operator.

Additional Inherited Members

- Protected Attributes inherited from DtRecursiveResourceIterator
DtRecursiveResourceIteratormyChildIterator

Detailed Description

File: munitRsrcIter.h.

Class: DtMunitionResourceIteratorDescription: 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.

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.

Reimplemented from DtRecursiveResourceIterator.

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.

Reimplemented from DtRecursiveResourceIterator.

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:

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)