DtFormationPSR Class Reference

class DtFormationPSR: More...

Inheritance diagram for DtFormationPSR:

List of all members.

Public Member Functions
	DtFormationPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtFormationPSR (const DtFormationPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtFormationPSR ()
	destructor
DtFormationPSR &	operator= (const DtFormationPSR &orig)
	assignment operator
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual void	setWorkingFormation (const DtFormation &formation)
virtual const DtFormation &	workingFormation () const
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Protected Attributes
DtFormation	myWorkingFormation

---

Detailed Description

class DtFormationPSR:

Instances of DtFormationPSR are used to maintain the savable state associated with the current 'working' formation (DtOtherAggregateFormation). The working formation is an ad hoc formation, supplied at the time it is needed by a given aggregate controller. It is typically based on the relative positions of an aggregate's subordinates at the time a movement command is issued.

---

Constructor & Destructor Documentation

DtFormationPSR::DtFormationPSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtFormationPSR::DtFormationPSR	(	const DtFormationPSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtFormationPSR::~DtFormationPSR

(

)

[virtual]

destructor

---

Member Function Documentation

DtFormationPSR& DtFormationPSR::operator=

(

const DtFormationPSR &

orig

)

assignment operator

virtual DtVrfProcessStateRepository* DtFormationPSR::clone	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtFormationPSR::type

(

)

const [virtual]

Returns the string type of the repository, as defined in procSRTypes.h.

(DtVrfFormationProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

virtual void DtFormationPSR::setWorkingFormation

(

const DtFormation &

formation

)

[virtual]

virtual const DtFormation& DtFormationPSR::workingFormation

(

)

const [virtual]

static DtVrfProcessStateRepository* DtFormationPSR::creator	(	const DtString &	rwName,
		DtVrfObject *	vrfObject,
		DtReaderWriterRegistry *	parentRegistry
	)		[static]

Returns a newly created instance of this class.

---

Member Data Documentation

DtFormation DtFormationPSR::myWorkingFormation [protected]

---

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

• include/vrfobjcore/formationPSR.h