DtPseudoAggregateMovementPSR Class Reference

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)

Inheritance diagram for DtPseudoAggregateMovementPSR:

Public Member Functions
	DtPseudoAggregateMovementPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtPseudoAggregateMovementPSR ()
	DtPseudoAggregateMovementPSR (const DtPseudoAggregateMovementPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
DtPseudoAggregateMovementPSR &	operator= (const DtPseudoAggregateMovementPSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
virtual void	setCurrentlyTaskedLeader (const DtUUID &objectId)
virtual DtSimObjectReference	currentlyTaskedLeader () const
virtual DtPromotionEntryList *	promotionList () const
virtual DtAggregateFormation	formation () const
virtual void	setFormation (DtAggregateFormation formation)
virtual void	setLeaderOrderedSpeed (DtReal speed)
virtual DtReal	leaderOrderedSpeed () const
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository ()
virtual bool	init ()
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
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	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)

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
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 Attributes
DtRwSimObjectReference	myCurrentlyTaskedLeader
DtRwReal	myLeaderOrderedSpeed
DtRwInt	myFormation
DtPromotionEntryList	myPromotionList
Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	myVrfObject
bool	myLoadedFromMTL
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 )()
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
const DtSimObject *	vrfObject () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory
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

DtPseudoAggregateMovementPSR::DtPseudoAggregateMovementPSR	(	DtLocalObject *	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::setCurrentlyTaskedLeader ( const DtUUID &  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 DtSimObjectReference DtPseudoAggregateMovementPSR::currentlyTaskedLeader ( ) const

virtual

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

static DtVrfProcessStateRepository* DtPseudoAggregateMovementPSR::creator ( const DtString &  rwName, DtLocalObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

Member Data Documentation

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

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/pseudoAggregateMovementPSR.h