DtConvoyPSR Class Reference

This is a process state repository for the DtConvoyController that stores the list of the names of currently tasked entities. More...

Inheritance diagram for DtConvoyPSR:

Public Types
typedef DtRwTemplatedListPtr < DtRwString, true >	DtRwSubordinateList

Public Member Functions
	DtConvoyPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtConvoyPSR (const DtConvoyPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtConvoyPSR ()
	destructor
DtConvoyPSR &	operator= (const DtConvoyPSR &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
	Returns the string type of this process state repository, defined in procSRTypes.h.
virtual void	setPathPlanFlag (bool flag)
	Accessors, setters, checkers and utilities for private members.
virtual bool	pathPlanFlag () const
virtual void	setConvoyPhase (const DtString &phase)
virtual const DtString &	convoyPhase () const
virtual void	setDestination (const DtString &destinationObjectName)
virtual const DtString &	destination () const
virtual const DtRwSubordinateList &	subordinates () const
virtual void	addSubordinate (const DtString &objectName)
virtual void	removeSubordinate (const DtString &objectName)
virtual bool	isASubordinate (const DtString &objectName) const
virtual bool	isSubordinatesEmpty () const
virtual void	clearSubordinates ()
virtual void	addAwaitingTaskSubordinate (const DtString &objectName)
virtual void	removeAwaitingTaskSubordinate (const DtString &objectName)
virtual const DtString &	lastTaskedSubordinate () const
virtual const DtString &	firstAwaitingTaskSubordinate () const
virtual void	clearAwaitingTaskSubordinates ()
virtual bool	isAwaitingTaskSubordinatesEmpty () const
virtual void	setAssemblyPoint (const DtVector &assemblyPoint)
virtual const DtVector &	assemblyPoint () const
virtual void	setConvoyLeader (const DtString &name)
virtual const DtString &	convoyLeader () const
virtual void	setLeadOnDistance (const float distance)
virtual const float	leadOnDistance () const
virtual void	setFollowDistance (const float distance)
virtual const float	followDistance () const
virtual void	setLastGeneratedEntryRail (const DtRwRailSegment &entryRail)
virtual DtRwRailSegment *	lastGeneratedEntryRail ()
virtual void	setLastOrderedSpeed (const float speed)
virtual const float	lastOrderedSpeed () const
virtual void	setStopIfEntityDestroyed (bool)
virtual bool	stopIfEntityDestroyed () const
virtual void	addRailSegment (const DtRailSegment &railSegment)
virtual void	addRailSegment (const DtRwRailSegment &railSegment)
virtual void	addRailSegment (const DtRwRailSegment *railSegment)
virtual void	addRailSegmentToFront (const DtRwRailSegment *railSegment)
virtual DtRwRailSegment	removeRailSegmentFromFront ()
virtual void	setRailSegments (const DtRwRailSegmentList &segments)
virtual void	setRailSegments (const DtRailSegmentList &segments)
virtual const DtRwRailSegmentList &	railSegmentList () const
virtual void	clearRailSegments ()
virtual DtRailSegmentList *	railSegments ()
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
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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 Member Functions
void	clearTempRailList ()
	Deletes all rails on myTempListPtr, and clears the list.
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.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtRwBoolean	myPathPlanFlag
DtRwString	myConvoyPhase
DtRwString	myDestination
DtRwVector	myAssemblyPoint
DtRwString	myConvoyLeader
DtRwString	myLastTaskedSubordinate
DtRwReal	myLeadOnDistance
DtRwReal	myFollowDistance
DtRwReal	myLastOrderedSpeed
DtRwSubordinateList	mySubordinates
DtRwSubordinateList	myAwaitingTaskSubordinates
DtRwRailSegmentList	myRailSegments
DtRwRailSegment	myLastGeneratedEntryRail
DtRailSegmentList *	myTempListPtr
DtRwBoolean	myStopIfEntityDestroyed
bool	myRegenerateTempRailList
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.

Additional Inherited Members
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

This is a process state repository for the DtConvoyController that stores the list of the names of currently tasked entities.

Member Typedef Documentation

typedef DtRwTemplatedListPtr<DtRwString, true> DtConvoyPSR::DtRwSubordinateList

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtConvoyPSR::~DtConvoyPSR ( )

virtual

destructor

Member Function Documentation

DtConvoyPSR& DtConvoyPSR::operator=

(

const DtConvoyPSR &

orig

)

assignment operator

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtConvoyPSR::type ( ) const

virtual

Returns the string type of this process state repository, defined in procSRTypes.h.

Returns "vrf-convoy-process-state-repository".

Implements DtVrfProcessStateRepository.

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

static

Returns a newly created instance of this class.

virtual void DtConvoyPSR::setPathPlanFlag ( bool  flag )

virtual

Accessors, setters, checkers and utilities for private members.

virtual bool DtConvoyPSR::pathPlanFlag ( ) const

virtual

virtual void DtConvoyPSR::setConvoyPhase ( const DtString &  phase )

virtual

virtual const DtString& DtConvoyPSR::convoyPhase ( ) const

virtual

virtual void DtConvoyPSR::setDestination ( const DtString &  destinationObjectName )

virtual

virtual const DtString& DtConvoyPSR::destination ( ) const

virtual

virtual const DtRwSubordinateList& DtConvoyPSR::subordinates ( ) const

virtual

virtual void DtConvoyPSR::addSubordinate ( const DtString &  objectName )

virtual

virtual void DtConvoyPSR::removeSubordinate ( const DtString &  objectName )

virtual

virtual bool DtConvoyPSR::isASubordinate ( const DtString &  objectName ) const

virtual

virtual bool DtConvoyPSR::isSubordinatesEmpty ( ) const

virtual

virtual void DtConvoyPSR::clearSubordinates ( )

virtual

virtual void DtConvoyPSR::addAwaitingTaskSubordinate ( const DtString &  objectName )

virtual

virtual void DtConvoyPSR::removeAwaitingTaskSubordinate ( const DtString &  objectName )

virtual

virtual const DtString& DtConvoyPSR::lastTaskedSubordinate ( ) const

virtual

virtual const DtString& DtConvoyPSR::firstAwaitingTaskSubordinate ( ) const

virtual

virtual void DtConvoyPSR::clearAwaitingTaskSubordinates ( )

virtual

virtual bool DtConvoyPSR::isAwaitingTaskSubordinatesEmpty ( ) const

virtual

virtual void DtConvoyPSR::setAssemblyPoint ( const DtVector &  assemblyPoint )

virtual

virtual const DtVector& DtConvoyPSR::assemblyPoint ( ) const

virtual

virtual void DtConvoyPSR::setConvoyLeader ( const DtString &  name )

virtual

virtual const DtString& DtConvoyPSR::convoyLeader ( ) const

virtual

virtual void DtConvoyPSR::setLeadOnDistance ( const float  distance )

virtual

virtual const float DtConvoyPSR::leadOnDistance ( ) const

virtual

virtual void DtConvoyPSR::setFollowDistance ( const float  distance )

virtual

virtual const float DtConvoyPSR::followDistance ( ) const

virtual

virtual void DtConvoyPSR::setLastGeneratedEntryRail ( const DtRwRailSegment &  entryRail )

virtual

virtual DtRwRailSegment* DtConvoyPSR::lastGeneratedEntryRail ( )

virtual

virtual void DtConvoyPSR::setLastOrderedSpeed ( const float  speed )

virtual

virtual const float DtConvoyPSR::lastOrderedSpeed ( ) const

virtual

virtual void DtConvoyPSR::setStopIfEntityDestroyed ( bool  )

virtual

virtual bool DtConvoyPSR::stopIfEntityDestroyed ( ) const

virtual

virtual void DtConvoyPSR::addRailSegment ( const DtRailSegment &  railSegment )

virtual

virtual void DtConvoyPSR::addRailSegment ( const DtRwRailSegment &  railSegment )

virtual

virtual void DtConvoyPSR::addRailSegment ( const DtRwRailSegment *  railSegment )

virtual

virtual void DtConvoyPSR::addRailSegmentToFront ( const DtRwRailSegment *  railSegment )

virtual

virtual DtRwRailSegment DtConvoyPSR::removeRailSegmentFromFront ( )

virtual

virtual void DtConvoyPSR::setRailSegments ( const DtRwRailSegmentList &  segments )

virtual

virtual void DtConvoyPSR::setRailSegments ( const DtRailSegmentList &  segments )

virtual

virtual const DtRwRailSegmentList& DtConvoyPSR::railSegmentList ( ) const

virtual

virtual void DtConvoyPSR::clearRailSegments ( )

virtual

virtual DtRailSegmentList* DtConvoyPSR::railSegments ( )

virtual

void DtConvoyPSR::clearTempRailList ( )

protected

Deletes all rails on myTempListPtr, and clears the list.

Non-virtual so it can be used from the destructor.

Member Data Documentation

DtRwBoolean DtConvoyPSR::myPathPlanFlag

protected

DtRwString DtConvoyPSR::myConvoyPhase

protected

DtRwString DtConvoyPSR::myDestination

protected

DtRwVector DtConvoyPSR::myAssemblyPoint

protected

DtRwString DtConvoyPSR::myConvoyLeader

protected

DtRwString DtConvoyPSR::myLastTaskedSubordinate

protected

DtRwReal DtConvoyPSR::myLeadOnDistance

protected

DtRwReal DtConvoyPSR::myFollowDistance

protected

DtRwReal DtConvoyPSR::myLastOrderedSpeed

protected

DtRwSubordinateList DtConvoyPSR::mySubordinates

protected

DtRwSubordinateList DtConvoyPSR::myAwaitingTaskSubordinates

protected

DtRwRailSegmentList DtConvoyPSR::myRailSegments

protected

DtRwRailSegment DtConvoyPSR::myLastGeneratedEntryRail

protected

DtRailSegmentList* DtConvoyPSR::myTempListPtr

protected

DtRwBoolean DtConvoyPSR::myStopIfEntityDestroyed

protected

bool DtConvoyPSR::myRegenerateTempRailList

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/convoyPSR.h