DtFormationEntry; readable/writeable entry in a DtFormation.

Instances of DtFormationEntry are entries in a DtFormation. Each entry contains the promotion ID of a given entity, the promotion ID of the entity it should be following in the formation, and the relative position it should maintain in following (in body coordinates of the entity being followed).

Inheritance diagram for DtFormationEntry:

[legend]

Public Member Functions
	DtFormationEntry ()

	DtFormationEntry (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)

	DtFormationEntry (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)

virtual	~DtFormationEntry ()

	DtFormationEntry (const DtString &name, const DtFormationEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtFormationEntry (const DtSymbolString &name, const DtFormationEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtFormationEntry &	operator= (const DtFormationEntry &orig)

DtFormationEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

DtFormationEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

bool	operator== (const DtFormationEntry &) const

bool	operator!= (const DtFormationEntry &) const


virtual const DtRwInt &	promotionId () const

virtual void	setPromotionId (int id)


virtual const DtRwInt &	leaderPromotionId () const

virtual void	setLeaderPromotionId (int id)


virtual const DtRwVector &	positionOffset () const

virtual void	setPositionOffset (const DtVector &offset)


virtual const DtRwString &	subordinateFormation () const

virtual void	setSubordinateFormation (const DtString &formationName)


virtual void	setListItem (DtListItem *item)

virtual DtListItem *	listItem ()

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Attributes
DtListItem *	myListItem

parameters
These parameters are available for setting in the OPD files.
DtRwInt	myPromotionId

DtRwInt	myLeaderPromotionId

DtRwVector	myPositionOffsetRelLeader

DtRwString	mySubordinateFormation

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtFormationEntry::DtFormationEntry ( )

default constructor

DtFormationEntry::DtFormationEntry	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

constructor

DtFormationEntry::DtFormationEntry	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

virtual DtFormationEntry::~DtFormationEntry ( )

virtual

destructor

DtFormationEntry::DtFormationEntry	(	const DtString &	name,
		const DtFormationEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

DtFormationEntry::DtFormationEntry	(	const DtSymbolString &	name,
		const DtFormationEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Member Function Documentation

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

assignment operator

virtual const DtRwInt& DtFormationEntry::promotionId ( ) const

virtual

Accessor/mutator for myPromotionId.

virtual void DtFormationEntry::setPromotionId ( int id )

virtual

Accessor/mutator for myPromotionId.

virtual const DtRwInt& DtFormationEntry::leaderPromotionId ( ) const

virtual

Accessor/mutator for myLeaderPromotionId.

virtual void DtFormationEntry::setLeaderPromotionId ( int id )

virtual

Accessor/mutator for myLeaderPromotionId.

virtual const DtRwVector& DtFormationEntry::positionOffset ( ) const

virtual

Accessor/mutator for myPositionOffsetRelLeader.

virtual void DtFormationEntry::setPositionOffset ( const DtVector & offset )

virtual

Accessor/mutator for myPositionOffsetRelLeader.

virtual const DtRwString& DtFormationEntry::subordinateFormation ( ) const

virtual

Accessor/mutator for mySubordinateFormation.

virtual void DtFormationEntry::setSubordinateFormation ( const DtString & formationName )

virtual

Accessor/mutator for mySubordinateFormation.

virtual void DtFormationEntry::setListItem ( DtListItem * item )

virtual

Used by DtFormation.

virtual DtListItem* DtFormationEntry::listItem ( )

virtual

Used by DtFormation.

DtFormationEntry* DtFormationEntry::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Clones a formation entry.

DtFormationEntry* DtFormationEntry::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

bool DtFormationEntry::operator== ( const DtFormationEntry & ) const

bool DtFormationEntry::operator!= ( const DtFormationEntry & ) const

Member Data Documentation

DtRwInt DtFormationEntry::myPromotionId

protected

Parameter Name: promotion-id
Parameter Description: Integer identifying the "promotion order" of the position, with 0 being the first. Each formationEntry in a formation must have a unique promotion-id. When a subordinate is missing from a unit, and the unit is "reorganized", subordinates in formation slots with higher promotion-ids are promoted to fill in the empty slot.
Parameter Default Value: -1
.

DtRwInt DtFormationEntry::myLeaderPromotionId

protected

Parameter Name: leader-promotion-id
Parameter Description: promotion-id of the formation position that this formation position is relative to. A value of -1 indicates that this entry is the overall leader.
Parameter Default Value: -1
.

DtRwVector DtFormationEntry::myPositionOffsetRelLeader

protected

Parameter Name: position-offset
Parameter Description: Offset relative to the to leader-promotion-id. If leader-promotion-id is -1, this offset is ignored. Parameter Default Value: (0. 0. 0.)
.

DtRwString DtFormationEntry::mySubordinateFormation

protected

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: ""
.

DtListItem* DtFormationEntry::myListItem

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation