DtPseudoAggregateMovementPSR; deprecated class needed for reading. More...

Inheritance diagram for DtPseudoAggregateMovementPSR:

Public Member Functions
	DtPseudoAggregateMovementPSR (DtVrfObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)
	default constructor
virtual	~DtPseudoAggregateMovementPSR ()
	destructor
	DtPseudoAggregateMovementPSR (const DtPseudoAggregateMovementPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor - not implemented
DtPseudoAggregateMovementPSR &	operator= (const DtPseudoAggregateMovementPSR &orig)
	assignment operator - not implemented
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	setCurrentlyTaskedLeaderId (const DtEntityIdentifier &objectId)
	Set/get object name of lead subordinate currently carrying out movement task.
virtual const DtEntityIdentifier &	currentlyTaskedLeaderId () const
virtual DtVrfObject *	currentlyTaskedLeader () const
	Shortcut which simply uses the stored currrentlyTaskedLeaderId to lookup the object and return a pointer to it.
virtual DtPromotionEntryList *	promotionList () const
	Get ordered list of DtPromotionEntrys, used to maintain relationship of who's following whom in formation.
virtual DtAggregateFormation	formation () const
	Set/get DIS/RPR formation enumeration.
virtual void	setFormation (DtAggregateFormation formation)
virtual void	setLeaderOrderedSpeed (DtReal speed)
virtual DtReal	leaderOrderedSpeed () const
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Overridden from base so that we can make a mapping from object ID to object name and back when saving and loading.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry)
	Returns a newly created instance of this class.
static void	objectAddedCallback (DtVrfObject object, void usr)
Protected Member Functions
virtual void	processObjectAdded (DtVrfObject *object)
	If the object added name matches currentlyTaskedLeader name, then currentlyTaskedLeadedId is set to this object ID, and the callback is removed.
Protected Attributes
DtRwString	myCurrentlyTaskedLeader
	Moved here from DtPseudoAggregateMoveController (psdAggMvCltr.h)
DtEntityIdentifier	myCurrentlyTaskedLeaderId
DtRwReal	myLeaderOrderedSpeed
	Speed that was last ordered for the leader by the formation controller.
DtRwInt	myFormation
	Copied here from DtSubordinateManager (subordMgr.h).
DtPromotionEntryList	myPromotionList
	Moved here from DtPseudoAggregateFormationController (psdAggFrmCltr.h)

Detailed Description

DtPseudoAggregateMovementPSR; deprecated class needed for reading.

scenarios created in previous releases.

Deprecated:: To be removed after VR-Forces version 3.11 Needed for backwards compatibiltiy with scenario files created in the previous release.

class DtPseudoAggregateMovementPSR:

Instances of DtPseudoAggregateMovementPSR are used to hold the shared/checkpointable state for a pseudo-aggregate's movement processes.

This class has been DEPRECATED from the VR-Forces toolkit and is no longer supported. This class was used in conjunction with the DtDisaggregatedFormationController and DtDisaggregatedMoveController components. The behavior offered by these components has been replaced by several new components. The new components along with their corresponding PSR classes are as follows:

Component class (header file) : (optional) Process State Repository class (header file)

DtDisaggregatedFormationController (disaaggregatedFormationController.h)

DtDisaggregatedMoveAlongController (disaggregatedMoveAlongController.h) : DtAggregateMoveAlongPSR (aggregateMoveAlongPSR.h)

DtDisaggregatedMoveToController (disaggregatedMoveToController.h) : DtAggregateMoveToPSR (aggregateMoveToPSR.h)

DtDisaggregatedMoveToLocationController (disaggregatedMoveToLocationController.h)

DtDisaggregatedPatrolAlongController (disaggregatedPatrolAlongController.h) DtAggregatePatrolAlongPSR (aggregatePatrolAlongPSR.h) DtDisaggregatedPatrolBetweenController (disaggregatedPatrolBetweenController.h) : DtAggregatePatrolBetweenPSR (aggregatePatrolBetweenPSR.h)

Constructor & Destructor Documentation

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

default constructor

virtual DtPseudoAggregateMovementPSR::~DtPseudoAggregateMovementPSR ( ) [virtual]

destructor

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

copy constructor - not implemented

Member Function Documentation

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

assignment operator - not implemented

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

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtPseudoAggregateMovementPSR::type ( ) const [virtual]

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

(DtVrfAutomotiveProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

virtual void DtPseudoAggregateMovementPSR::setCurrentlyTaskedLeaderId ( const DtEntityIdentifier & objectId ) [virtual]

Set/get object name of lead subordinate currently carrying out movement task.

Note that this value may not be avaliable immediatly after a getSelf, as it may be waiting for the object with the stored name to be created.

virtual const DtEntityIdentifier& DtPseudoAggregateMovementPSR::currentlyTaskedLeaderId ( ) const [virtual]

virtual DtVrfObject* DtPseudoAggregateMovementPSR::currentlyTaskedLeader ( ) const [virtual]

Shortcut which simply uses the stored currrentlyTaskedLeaderId to lookup the object and return a pointer to it.

virtual DtPromotionEntryList* DtPseudoAggregateMovementPSR::promotionList ( ) const [virtual]

Get ordered list of DtPromotionEntrys, used to maintain relationship of who's following whom in formation.

virtual DtAggregateFormation DtPseudoAggregateMovementPSR::formation ( ) const [virtual]

Set/get DIS/RPR formation enumeration.

virtual void DtPseudoAggregateMovementPSR::setFormation ( DtAggregateFormation formation ) [virtual]

virtual void DtPseudoAggregateMovementPSR::setLeaderOrderedSpeed ( DtReal speed ) [virtual]

virtual DtReal DtPseudoAggregateMovementPSR::leaderOrderedSpeed ( ) const [virtual]

virtual void DtPseudoAggregateMovementPSR::putSelf	(	FILE *	fp,
		int	indentLevel = `0`,
		bool	writeUnspecified = `false`,
		const DtFilename &	path = `DtReaderWriter::appPath()`
	)		`[virtual]`

Overridden from base so that we can make a mapping from object ID to object name and back when saving and loading.

Reimplemented from DtReaderWriter.

virtual void DtPseudoAggregateMovementPSR::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		`[virtual]`

Reimplemented from DtVrfProcessStateRepository.

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

Returns a newly created instance of this class.

static void DtPseudoAggregateMovementPSR::objectAddedCallback	(	DtVrfObject *	object,
		void *	usr
	)		`[static]`

virtual void DtPseudoAggregateMovementPSR::processObjectAdded ( DtVrfObject * object ) [protected, virtual]

If the object added name matches currentlyTaskedLeader name, then currentlyTaskedLeadedId is set to this object ID, and the callback is removed.

Member Data Documentation

DtRwString DtPseudoAggregateMovementPSR::myCurrentlyTaskedLeader [protected]

Moved here from DtPseudoAggregateMoveController (psdAggMvCltr.h)

Name of the lead subordinate currently carrying out movement task. (valid only for the save/load. Used to save the state of the object ID for this entity)

DtEntityIdentifier DtPseudoAggregateMovementPSR::myCurrentlyTaskedLeaderId [protected]

DtRwReal DtPseudoAggregateMovementPSR::myLeaderOrderedSpeed [protected]

Speed that was last ordered for the leader by the formation controller.

DtRwInt DtPseudoAggregateMovementPSR::myFormation [protected]

Copied here from DtSubordinateManager (subordMgr.h).

Note - still exists in DtSubordinateManager, but is not read/writeable there.

DtPromotionEntryList DtPseudoAggregateMovementPSR::myPromotionList [protected]

Moved here from DtPseudoAggregateFormationController (psdAggFrmCltr.h)

List of DtPromoteEntry objects, keyed on promotion index.

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

include/vrfobjcore/pseudoMovePSR.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation