DtFormationEntry Class Reference

DtFormationEntry; readable/writeable entry in a DtFormation. More...

Inheritance diagram for DtFormationEntry:

List of all members.

Public Member Functions
	DtFormationEntry ()
	default constructor
	DtFormationEntry (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	constructor
	DtFormationEntry (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtFormationEntry ()
	destructor
	DtFormationEntry (const DtString &name, const DtFormationEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtFormationEntry (const DtSymbolString &name, const DtFormationEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtFormationEntry &	operator= (const DtFormationEntry &orig)
	assignment operator
DtFormationEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Clones a formation entry.
DtFormationEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
bool	operator== (const DtFormationEntry &) const
bool	operator!= (const DtFormationEntry &) const
virtual const DtRwInt &	promotionId () const
	Accessor/mutator for myPromotionId.
virtual void	setPromotionId (int id)
	Accessor/mutator for myPromotionId.
virtual const DtRwInt &	leaderPromotionId () const
	Accessor/mutator for myLeaderPromotionId.
virtual void	setLeaderPromotionId (int id)
	Accessor/mutator for myLeaderPromotionId.
virtual const DtRwVector &	positionOffset () const
	Accessor/mutator for myPositionOffsetRelLeader.
virtual void	setPositionOffset (const DtVector &offset)
	Accessor/mutator for myPositionOffsetRelLeader.
virtual const DtRwString &	subordinateFormation () const
	Accessor/mutator for mySubordinateFormation.
virtual void	setSubordinateFormation (const DtString &formationName)
	Accessor/mutator for mySubordinateFormation.
virtual void	setListItem (DtListItem *item)
	Used by DtFormation.
virtual DtListItem *	listItem ()
	Used by DtFormation.
Protected Attributes
DtListItem *	myListItem
parameters
These parameters are available for setting in the OPD files.
DtRwInt	myPromotionId
	Parameter Name: promotion-id Parameter Description: Integer identifying position in formation.
DtRwInt	myLeaderPromotionId
	Parameter Name: leader-promotion-id Parameter Description: promotion-id of the formation position that this formation position is relative to.
DtRwVector	myPositionOffsetRelLeader
	Parameter Name: position-offset Parameter Description: Offset relative to the to leader-promotion-id.
DtRwString	mySubordinateFormation
	Parameter Name: subordinate-formation Parameter Description: The formation that will be used for the subordinates of the entity in this formation position.

---

Detailed Description

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).

---

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 position in formation.

Values start with 0, in order of decreasing importance (so in the case of a column formation, the head of the column would have the lowest number, and the tail would have the highest).
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, then this offset is relative to the aggregate as a whole. 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:

• include/vrfutil/formEntry.h