VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes
DtSubordinateAggregateEntry Class Reference
Inheritance diagram for DtSubordinateAggregateEntry:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSubordinateAggregateEntry ()
 default constructor
 DtSubordinateAggregateEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 DtSubordinateAggregateEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtSubordinateAggregateEntry (const DtString &name, const DtSubordinateAggregateEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtSubordinateAggregateEntry (const DtSymbolString &name, const DtSubordinateAggregateEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtSubordinateAggregateEntryoperator= (const DtSubordinateAggregateEntry &orig)
 assignment operator
virtual ~DtSubordinateAggregateEntry ()
virtual
DtSubordinateAggregateEntry
clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual
DtSubordinateAggregateEntry
clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void setFormationName (const DtString &formationName)
 Accessor/mutator for mySubordinateFormationName.
virtual const DtStringformationName () const
 Accessor/mutator for mySubordinateFormationName.
virtual const
DtSubordinateObjectsList
subordinateObjectsList () const
 Accessor/mutator for mySubordinateObjectsList.
virtual void setSubordinateObjectsList (const DtSubordinateObjectsList &subordList)
 Accessor/mutator for mySubordinateObjectsList.
virtual DtSubordinateObjectsListgetSubordinateObjects ()
 Accessor/mutator for mySubordinateObjectsList.

Static Public Member Functions

static
DtSubordinateAggregateEntry
createSubordinateEntry (const DtString &rwName, DtReaderWriterRegistry *parentRegistry)
static DtSubordinateEntrycreator ()

Protected Attributes

DtRwString mySubordinateFormationName
 Parameter Name: subordinate-formation
Parameter Description: The formation that will be used for the subordinates of the entity in this formation position.
DtSubordinateObjectsList mySubordinateObjectsList
 Parameter Name: subordinate-objects
Parameter Description: List of SubordinateObjects
Parameter Default Value:
.

Constructor & Destructor Documentation

default constructor

real constructor

copy constructor


Member Function Documentation

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

assignment operator

virtual DtSubordinateAggregateEntry* DtSubordinateAggregateEntry::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]

Reimplemented from DtSubordinateEntry.

virtual DtSubordinateAggregateEntry* DtSubordinateAggregateEntry::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]

Reimplemented from DtSubordinateEntry.

virtual void DtSubordinateAggregateEntry::setFormationName ( const DtString formationName) [virtual]

Accessor/mutator for mySubordinateFormationName.

virtual const DtString& DtSubordinateAggregateEntry::formationName ( ) const [virtual]

Accessor/mutator for mySubordinateFormationName.

Accessor/mutator for mySubordinateObjectsList.

Accessor/mutator for mySubordinateObjectsList.

Accessor/mutator for mySubordinateObjectsList.


Member Data Documentation

Parameter Name: subordinate-formation
Parameter Description: The formation that will be used for the subordinates of the entity in this formation position.

This allows for formations such as a line of columns. This parameter is ignored if an individual entity occupies the formation position. If the string is empty, then default formation will be used. Parameter Default Value: ""

Parameter Name: subordinate-objects
Parameter Description: List of SubordinateObjects
Parameter Default Value:
.


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)