DtConvoyPSR Class Reference

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

Inheritance diagram for DtConvoyPSR:

Public Member Functions
	DtConvoyPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtConvoyPSR (const DtConvoyPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtConvoyPSR ()
DtConvoyPSR &	operator= (const DtConvoyPSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
virtual void	setPathPlanFlag (bool flag)
virtual bool	pathPlanFlag () const
virtual void	setConvoyPhase (const DtString &phase)
virtual const DtString &	convoyPhase () const
virtual void	setDestination (const DtUUID &destination)
virtual DtSimObjectReference	destination () const
virtual const DtRwSimObjectReferenceList &	subordinates () const
virtual void	addSubordinate (const DtUUID &subordinate)
virtual void	removeSubordinate (const DtUUID &subordinate)
virtual bool	isASubordinate (const DtUUID &subordinate) const
virtual bool	isSubordinatesEmpty () const
virtual void	clearSubordinates ()
virtual void	addAwaitingTaskSubordinate (const DtUUID &subordinate)
virtual void	removeAwaitingTaskSubordinate (const DtUUID &subordinate)
virtual DtSimObjectReference	lastTaskedSubordinate () const
virtual DtSimObjectReference	firstAwaitingTaskSubordinate () const
virtual void	clearAwaitingTaskSubordinates ()
virtual bool	isAwaitingTaskSubordinatesEmpty () const
virtual void	setAssemblyPoint (const DtVector &assemblyPoint)
virtual const DtVector &	assemblyPoint () const
virtual void	setConvoyLeader (const DtUUID &name)
virtual DtSimObjectReference	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 (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)
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 Member Functions
void	clearTempRailList ()
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
const DtSimObject *	vrfObject () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

DtConvoyPSR::DtConvoyPSR	(	DtLocalObject *	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, DtLocalObject *  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 DtUUID &  destination )

virtual

virtual DtSimObjectReference DtConvoyPSR::destination ( ) const

virtual

virtual const DtRwSimObjectReferenceList& DtConvoyPSR::subordinates ( ) const

virtual

virtual void DtConvoyPSR::addSubordinate ( const DtUUID &  subordinate )

virtual

virtual void DtConvoyPSR::removeSubordinate ( const DtUUID &  subordinate )

virtual

virtual bool DtConvoyPSR::isASubordinate ( const DtUUID &  subordinate ) const

virtual

virtual bool DtConvoyPSR::isSubordinatesEmpty ( ) const

virtual

virtual void DtConvoyPSR::clearSubordinates ( )

virtual

virtual void DtConvoyPSR::addAwaitingTaskSubordinate ( const DtUUID &  subordinate )

virtual

virtual void DtConvoyPSR::removeAwaitingTaskSubordinate ( const DtUUID &  subordinate )

virtual

virtual DtSimObjectReference DtConvoyPSR::lastTaskedSubordinate ( ) const

virtual

virtual DtSimObjectReference 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 DtUUID &  name )

virtual

virtual DtSimObjectReference 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

DtRwSimObjectReference DtConvoyPSR::myDestination

protected

DtRwVector DtConvoyPSR::myAssemblyPoint

protected

DtRwSimObjectReference DtConvoyPSR::myConvoyLeader

protected

DtRwSimObjectReference DtConvoyPSR::myLastTaskedSubordinate

protected

DtRwReal DtConvoyPSR::myLeadOnDistance

protected

DtRwReal DtConvoyPSR::myFollowDistance

protected

DtRwReal DtConvoyPSR::myLastOrderedSpeed

protected

DtRwSimObjectReferenceList DtConvoyPSR::mySubordinates

protected

DtRwSimObjectReferenceList 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:

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