VR-Forces 4.0.4 Class Documentation
Public Member Functions | Private Member Functions
DtMunitionResourceIterator Class Reference

File: munitRsrcIter.h. More...

Inheritance diagram for DtMunitionResourceIterator:
Inheritance graph
[legend]

List of all members.

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.

Private Member Functions

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

Detailed Description

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.


Constructor & Destructor Documentation

Default Constructor. Do not use.

Copy Constructor.

DtMunitionResourceIterator::DtMunitionResourceIterator ( const DtList &  list) [inline]

Constructor.

Destructor.


Member Function Documentation

const DtMunitionResourceIterator& DtMunitionResourceIterator::operator= ( const DtMunitionResourceIterator orig) [private]

Assignment Operator.

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

Returns the first object on the list

References DtRecursiveResourceIterator::first().

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 Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)