DtAggregateMoveAlongPSR; process state repository used by DtAggregateMoveAlongController DtAggregateMoveAlongPSR is the PSR for the Entity Level aggregate movement controller DtDisaggregatedMoveAlongController (not the Aggregate Level move along controller, which uses DtAggregatedMoveAlongPSR).

Inheritance diagram for DtAggregateMoveAlongPSR:

[legend]

Public Member Functions
	DtAggregateMoveAlongPSR (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)

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

virtual	~DtAggregateMoveAlongPSR ()

DtAggregateMoveAlongPSR &	operator= (const DtAggregateMoveAlongPSR &orig)

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

virtual DtString	type () const

virtual void	setTimeToNextMaintainFormationTick (DtTime simTime)

virtual DtTime	timeToNextMaintainFormationTick () const

virtual DtUUID	lookupRoute (int promotionId) const

virtual DtUUID	lookupRoute (const DtUUID &subordinate) const

virtual void	clearPromotionIdRouteList ()

virtual void	addPromotionIdRouteEntry (int promotionId, const DtUUID &route)

virtual const DtPromotionIdUUIDMap &	promotionIdRouteMap () const

virtual void	addTaskedSubordinatePromotionIdEntry (const DtUUID &subordinate, int promotionId)

virtual void	removeTaskedSubordinate (const DtUUID &subordiante)

virtual bool	isATaskedSubordinate (const DtUUID &subordinate)

virtual void	removeRoute (const DtUUID &route)

virtual void	clearTaskSubordinates ()

virtual bool	taskedSubordinatesEmpty () const

virtual const DtUUIDPromotionIdMap &	taskedSubordinates () const

virtual void	setFormationName (const DtString &name)

virtual DtString	formationName () const

virtual void	setFormationLeader (const DtUUID &leader)

virtual DtUUID	formationLeader () const

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

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


virtual void	setRoute (const DtUUID &route)

virtual DtSimObjectReference	route () const


virtual void	setMovingToRoute (bool trueOrFalse)

virtual bool	movingToRoute () const


virtual void	setRouteIsDiscovered (bool value)

virtual bool	routeIsDiscovered () const


virtual void	setIsGeneratingFormationRoutes (bool value)

virtual bool	isGeneratingFormationRoutes () const


virtual void	setIsReevaluatingFormationRoutes (bool value)

virtual bool	isReevaluatingFormationRoutes () const


virtual void	setSpeed (double aSpeed)

virtual double	speed () 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

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)

virtual	~DtReaderWriter ()

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	wasUpdatedSince (DtTime t) 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
DtPromotionIdUUIDMap	myPromotionIndexRouteMap

DtUUIDPromotionIdMap	myCurrentlyTaskedSubordinates

DtRwUUID	myFormationLeader

DtRwSimObjectReference	myRoute

DtPromotionIdUUIDList	myPromotionIdRouteList

DtPromotionIdUUIDList	myPromotionIdEntityList

DtRwReal	myTimeToNextMaintainFormationTick

DtRwBoolean	myMovingToRoute

DtRwBoolean	myRouteIsDiscovered

DtRwBoolean	myIsGeneratingFormationRoutes

DtRwBoolean	myIsReevaluatingFormationRoutes

DtRwReal	mySpeed

DtRwString	myFormationName

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

Private Types
typedef std::map< DtUUID, int >	DtUUIDPromotionIdMap

typedef std::map< int, DtUUID >	DtPromotionIdUUIDMap

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

Member Typedef Documentation

typedef std::map<DtUUID, int> DtAggregateMoveAlongPSR::DtUUIDPromotionIdMap

private

typedef std::map<int, DtUUID> DtAggregateMoveAlongPSR::DtPromotionIdUUIDMap

private

Constructor & Destructor Documentation

DtAggregateMoveAlongPSR::DtAggregateMoveAlongPSR	(	DtLocalObject *	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::setRoute ( const DtUUID & route )

virtual

UUID of the route the aggregate (as a whole) is moving along.Was: setRouteName.

virtual DtSimObjectReference DtAggregateMoveAlongPSR::route ( ) const

virtual

Was: routeName.

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 DtUUID DtAggregateMoveAlongPSR::lookupRoute ( int promotionId ) const

virtual

Lookup route name associated with given formation position id.

virtual DtUUID DtAggregateMoveAlongPSR::lookupRoute ( const DtUUID & subordinate ) const

virtual

Lookup route associated with given subordinate.

virtual void DtAggregateMoveAlongPSR::clearPromotionIdRouteList ( )

virtual

Empty map of promotion Ids to routes.

virtual void DtAggregateMoveAlongPSR::addPromotionIdRouteEntry	(	int	promotionId,
		const DtUUID &	route
	)

virtual

Add an entry to the promotion Id/route map.

virtual const DtPromotionIdUUIDMap& DtAggregateMoveAlongPSR::promotionIdRouteMap ( ) const

virtual

Returns: Promotion Id/route map

virtual void DtAggregateMoveAlongPSR::addTaskedSubordinatePromotionIdEntry	(	const DtUUID &	subordinate,
		int	promotionId
	)

virtual

Add entry to the subordinate/promotion Id map.

virtual void DtAggregateMoveAlongPSR::removeTaskedSubordinate ( const DtUUID & subordiante )

virtual

Remove subordinate with given uuid.

virtual bool DtAggregateMoveAlongPSR::isATaskedSubordinate ( const DtUUID & subordinate )

virtual

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

virtual void DtAggregateMoveAlongPSR::removeRoute ( const DtUUID & route )

virtual

Remove route with given uuid.

virtual void DtAggregateMoveAlongPSR::clearTaskSubordinates ( )

virtual

Remove all tasked subordinates.

virtual bool DtAggregateMoveAlongPSR::taskedSubordinatesEmpty ( ) 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 DtUUIDPromotionIdMap& DtAggregateMoveAlongPSR::taskedSubordinates ( ) const

virtual

Map of subordinates/promotion Ids.

virtual void DtAggregateMoveAlongPSR::setRouteIsDiscovered ( bool value )

virtual

Flag indicating whether the current task has been successfully initialized.

virtual bool DtAggregateMoveAlongPSR::routeIsDiscovered ( ) const

virtual

Flag indicating whether the current task has been successfully initialized.

virtual void DtAggregateMoveAlongPSR::setIsGeneratingFormationRoutes ( bool value )

virtual

Flag indicating whether we are still generating formation routes for subordinates.

virtual bool DtAggregateMoveAlongPSR::isGeneratingFormationRoutes ( ) const

virtual

Flag indicating whether we are still generating formation routes for subordinates.

virtual void DtAggregateMoveAlongPSR::setIsReevaluatingFormationRoutes ( bool value )

virtual

Flag indicating whether we are still reevaluating formation routes for subordinates.

virtual bool DtAggregateMoveAlongPSR::isReevaluatingFormationRoutes ( ) const

virtual

Flag indicating whether we are still reevaluating formation routes for subordinates.

virtual void DtAggregateMoveAlongPSR::setSpeed ( double aSpeed )

virtual

Task speed or ordered speed.

virtual double DtAggregateMoveAlongPSR::speed ( ) const

virtual

Task speed or ordered speed.

virtual void DtAggregateMoveAlongPSR::setFormationName ( const DtString & name )

virtual

Current formation. This is saved so that if there is a formation-change callback, the controller can tell whether it was a formation name change or something else.

virtual DtString DtAggregateMoveAlongPSR::formationName ( ) const

virtual

virtual void DtAggregateMoveAlongPSR::setFormationLeader ( const DtUUID & leader )

virtual

The formation leader (subordinate)

virtual DtUUID DtAggregateMoveAlongPSR::formationLeader ( ) const

virtual

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

virtual

Override to put contents of myPromotionIndexRouteMap into myPromotionIdRouteList, 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 myPromotionIdRouteList into myPromotionIndexRouteMap.

Reimplemented from DtVrfProcessStateRepository.

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

static

Returns a newly created instance of this class.

Member Data Documentation

DtPromotionIdUUIDMap DtAggregateMoveAlongPSR::myPromotionIndexRouteMap

protected

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

DtUUIDPromotionIdMap DtAggregateMoveAlongPSR::myCurrentlyTaskedSubordinates

protected

Map of currently tasked subordinate object uuids to promotion Id.

DtRwUUID DtAggregateMoveAlongPSR::myFormationLeader

protected

The leader of the formation (for leadFollowInFormation)

DtRwSimObjectReference DtAggregateMoveAlongPSR::myRoute

protected

Route the aggregate is currently moving along.

DtPromotionIdUUIDList DtAggregateMoveAlongPSR::myPromotionIdRouteList

protected

Readable writeable list of promotion Id/route. Valid only immediately after getSelf() has been called. Used to populate the contents of myPromotionIndexRouteMap. (valid for the lifetime of this object).

DtPromotionIdUUIDList DtAggregateMoveAlongPSR::myPromotionIdEntityList

protected

Readable writeable list of promotion Id/entity. Valid only immediately after getSelf() has been called. Used to populate the contents of myCurrentlyTaskedSubordinates. (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.

DtRwBoolean DtAggregateMoveAlongPSR::myIsGeneratingFormationRoutes

protected

Flag indicating whether we are currently generating formation routes.

DtRwBoolean DtAggregateMoveAlongPSR::myIsReevaluatingFormationRoutes

protected

Flag indicating whether we are currently reevaluating formation routes.

DtRwReal DtAggregateMoveAlongPSR::mySpeed

protected

Speed from task or ordered speed.

DtRwString DtAggregateMoveAlongPSR::myFormationName

protected

The current formation name.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/aggregateMoveAlongPSR.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation