DtAggregateMoveAlongPSR Class Reference

file aggregateMoveAlongPSR.h More...

Inheritance diagram for DtAggregateMoveAlongPSR:

Public Member Functions
	DtAggregateMoveAlongPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtAggregateMoveAlongPSR (const DtAggregateMoveAlongPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtAggregateMoveAlongPSR ()
	destructor
DtAggregateMoveAlongPSR &	operator= (const DtAggregateMoveAlongPSR &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
	String type of this process state repository, defined in procSRTypes.h.
virtual void	setTimeToNextMaintainFormationTick (DtTime simTime)
	Simulation time of next maintain formation tick (in which we monitor the current state of the formation and issue slow down/speed up requests as needed.
virtual DtTime	timeToNextMaintainFormationTick () const
virtual DtString	lookupRouteName (int promotionId) const
	Lookup route name associated with given formation position id.
virtual DtString	lookupRouteName (const DtString &objectName) const
	Lookup route name associated with given subordinate name.
virtual void	clearPromotionIdRouteNameList ()
	Empty map of promotion Ids to route names.
virtual void	addPromotionIdRouteNameEntry (int promotionId, const DtString &routeName)
	Add an entry to the promotion Id/route name map.
virtual const DtPromotionIdObjectNameMap &	promotionIdRouteNameList () const
virtual void	addTaskedSubordinateNamePromotionIdEntry (const DtString &objectName, int promotionId)
	Add entry to the subordinate name/promotion Id map.
virtual void	removeTaskedSubordinateName (const DtString &objectName)
	Remove subordinate with given object name.
virtual bool	isATaskedSubordinate (const DtString &objectName)
	Returns true is if the given object name is in the subordinate name/promotion Id map.
virtual void	removeRoute (const DtString &routeName)
	Remove route with given object name.
virtual void	clearTaskSubordinateNames ()
	Remove all tasked subordinate names.
virtual bool	taskedSubordinateNamesEmpty () const
	Check if there are any tasked subordinates.
virtual const DtObjectNamePromotionIdMap &	taskedSubordinateNames () const
	Map of subordinate names/promotion Ids.
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to put contents of myPromotionIndexRouteNameMap into myPromotionIdRouteNameList, to put it in a writeable form.
virtual void	getSelf (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Override to put contents of myPromotionIdRouteNameList into myPromotionIndexRouteNameMap.
virtual void	setRouteName (const DtString &routeName)
	Name of the route the aggregate (as a whole) is moving along.
virtual const DtString &	routeName () const
	Name of the route the aggregate (as a whole) is moving along.
virtual void	setMovingToRoute (bool trueOrFalse)
	Flag indicating whether we're in the 'moving to route state'.
virtual bool	movingToRoute () const
	Flag indicating whether we're in the 'moving to route state'.
virtual void	setRouteIsDiscovered (bool value)
	Flag indicating whether the current task has been sucessfully initialized.
virtual bool	routeIsDiscovered () const
	Flag indicating whether the current task has been sucessfully initialized.
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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 void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
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.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
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 char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Attributes
DtPromotionIdObjectNameMap	myPromotionIndexRouteNameMap
	Map of promotion Ids (formation positions) to route names.
DtObjectNamePromotionIdMap	myCurrentlyTaskedSubordinateNames
	Map of currently tasked subordinate object names to promotion Id.
DtRwString	myRouteName
	Name of the route the aggregate is currently moving along.
DtPromotionIdObjectNameList	myPromotionIdRouteNameList
	Readable writeable list of promotion Id/route name/.
DtPromotionIdObjectNameList	myPromotionIdEntityNameList
	Readable writeable list of promotion Id/entity name/.
DtRwReal	myTimeToNextMaintainFormationTick
	Time in seconds until next tick in which to perform formation monitoring.
DtRwBoolean	myMovingToRoute
	Flag indicating whether we're in the moving to route phase of the task.
DtRwBoolean	myRouteIsDiscovered
	Flag indicating whether has been discovered or not.
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Types
typedef std::map< DtString, int >	DtObjectNamePromotionIdMap
typedef std::map< int, DtString >	DtPromotionIdObjectNameMap

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 ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

file aggregateMoveAlongPSR.h

DtAggregateMoveAlongPSR; process state repository used by DtAggregateMoveAlongController DtAggregateMoveAlongPSR is a process state repository for the DtAggregateMoveAlongController. It stores the list of the names of subordinates and the corresponding routes they have been tasked to follow by the aggregate. Maintains the association between promotion Ids (position in formation), subordinate names, and route names. Also maintains the time to next tick for monitoring formation.

Member Typedef Documentation

typedef std::map<DtString, int> DtAggregateMoveAlongPSR::DtObjectNamePromotionIdMap

private

typedef std::map<int, DtString> DtAggregateMoveAlongPSR::DtPromotionIdObjectNameMap

private

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtAggregateMoveAlongPSR::~DtAggregateMoveAlongPSR ( )

virtual

destructor

Member Function Documentation

DtAggregateMoveAlongPSR& DtAggregateMoveAlongPSR::operator=

(

const DtAggregateMoveAlongPSR &

orig

)

assignment operator

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtAggregateMoveAlongPSR::type ( ) const

virtual

String type of this process state repository, defined in procSRTypes.h.

Returns

"vrf-aggregate-move-along-process-state-repository".

Implements DtVrfProcessStateRepository.

virtual void DtAggregateMoveAlongPSR::setRouteName ( const DtString &  routeName )

virtual

Name of the route the aggregate (as a whole) is moving along.

virtual const DtString& DtAggregateMoveAlongPSR::routeName ( ) const

virtual

Name of the route the aggregate (as a whole) is moving along.

virtual void DtAggregateMoveAlongPSR::setTimeToNextMaintainFormationTick ( DtTime  simTime )

virtual

Simulation time of next maintain formation tick (in which we monitor the current state of the formation and issue slow down/speed up requests as needed.

{@

virtual DtTime DtAggregateMoveAlongPSR::timeToNextMaintainFormationTick ( ) const

virtual

virtual DtString DtAggregateMoveAlongPSR::lookupRouteName ( int  promotionId ) const

virtual

Lookup route name associated with given formation position id.

virtual DtString DtAggregateMoveAlongPSR::lookupRouteName ( const DtString &  objectName ) const

virtual

Lookup route name associated with given subordinate name.

virtual void DtAggregateMoveAlongPSR::clearPromotionIdRouteNameList ( )

virtual

Empty map of promotion Ids to route names.

virtual void DtAggregateMoveAlongPSR::addPromotionIdRouteNameEntry ( int  promotionId, const DtString &  routeName  )

virtual

Add an entry to the promotion Id/route name map.

virtual const DtPromotionIdObjectNameMap& DtAggregateMoveAlongPSR::promotionIdRouteNameList ( ) const

virtual

Returns

Promotion Id/route name map

virtual void DtAggregateMoveAlongPSR::addTaskedSubordinateNamePromotionIdEntry ( const DtString &  objectName, int  promotionId  )

virtual

Add entry to the subordinate name/promotion Id map.

virtual void DtAggregateMoveAlongPSR::removeTaskedSubordinateName ( const DtString &  objectName )

virtual

Remove subordinate with given object name.

virtual bool DtAggregateMoveAlongPSR::isATaskedSubordinate ( const DtString &  objectName )

virtual

Returns true is if the given object name is in the subordinate name/promotion Id map.

virtual void DtAggregateMoveAlongPSR::removeRoute ( const DtString &  routeName )

virtual

Remove route with given object name.

virtual void DtAggregateMoveAlongPSR::clearTaskSubordinateNames ( )

virtual

Remove all tasked subordinate names.

virtual bool DtAggregateMoveAlongPSR::taskedSubordinateNamesEmpty ( ) const

virtual

Check if there are any tasked subordinates.

virtual void DtAggregateMoveAlongPSR::setMovingToRoute ( bool  trueOrFalse )

virtual

Flag indicating whether we're in the 'moving to route state'.

virtual bool DtAggregateMoveAlongPSR::movingToRoute ( ) const

virtual

Flag indicating whether we're in the 'moving to route state'.

virtual const DtObjectNamePromotionIdMap& DtAggregateMoveAlongPSR::taskedSubordinateNames ( ) const

virtual

Map of subordinate names/promotion Ids.

virtual void DtAggregateMoveAlongPSR::setRouteIsDiscovered ( bool  value )

virtual

Flag indicating whether the current task has been sucessfully initialized.

virtual bool DtAggregateMoveAlongPSR::routeIsDiscovered ( ) const

virtual

Flag indicating whether the current task has been sucessfully initialized.

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

virtual

Override to put contents of myPromotionIndexRouteNameMap into myPromotionIdRouteNameList, to put it in a writeable form.

Reimplemented from DtReaderWriter.

virtual void DtAggregateMoveAlongPSR::getSelf ( DtlObjPtr  args, const SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Override to put contents of myPromotionIdRouteNameList into myPromotionIndexRouteNameMap.

Reimplemented from DtVrfProcessStateRepository.

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

static

Returns a newly created instance of this class.

Member Data Documentation

DtPromotionIdObjectNameMap DtAggregateMoveAlongPSR::myPromotionIndexRouteNameMap

protected

Map of promotion Ids (formation positions) to route names.

DtObjectNamePromotionIdMap DtAggregateMoveAlongPSR::myCurrentlyTaskedSubordinateNames

protected

Map of currently tasked subordinate object names to promotion Id.

DtRwString DtAggregateMoveAlongPSR::myRouteName

protected

Name of the route the aggregate is currently moving along.

DtPromotionIdObjectNameList DtAggregateMoveAlongPSR::myPromotionIdRouteNameList

protected

Readable writeable list of promotion Id/route name/.

Valid only immediately after getSelf() has been called. Used to populate the contents of myPromotionIndexRouteNameMap. (valid for the lifetime of this object).

DtPromotionIdObjectNameList DtAggregateMoveAlongPSR::myPromotionIdEntityNameList

protected

Readable writeable list of promotion Id/entity name/.

Valid only immediately after getSelf() has been called. Used to populate the contents of myCurrentlyTaskedSubordinateNames. (valid for the lifetime of this object).

DtRwReal DtAggregateMoveAlongPSR::myTimeToNextMaintainFormationTick

protected

Time in seconds until next tick in which to perform formation monitoring.

DtRwBoolean DtAggregateMoveAlongPSR::myMovingToRoute

protected

Flag indicating whether we're in the moving to route phase of the task.

DtRwBoolean DtAggregateMoveAlongPSR::myRouteIsDiscovered

protected

Flag indicating whether has been discovered or not.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfobjcore/aggregateMoveAlongPSR.h