DtPseudoAggregateMovementPSR Class Reference

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)
	Top level to read itself from an input stream.
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject *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 ()
	Used for virtual construction. This base method simply returns true.
virtual bool	loadedFromMTL () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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)
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
	Creates a new state repository object, using the factory.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.

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 Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

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)
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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::pair < DtSymbolString, DtString >	DtVariableNameType
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

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

Top level to read itself from an input stream.

searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

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 )

protectedvirtual

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