DtMoveAlongWithActionsPSR Class Reference

Inheritance diagram for DtMoveAlongWithActionsPSR:

Public Member Functions
	DtMoveAlongWithActionsPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtMoveAlongWithActionsPSR (const DtMoveAlongWithActionsPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtMoveAlongWithActionsPSR () override
DtMoveAlongWithActionsPSR &	operator= (const DtMoveAlongWithActionsPSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	type () const override
virtual void	setRoute (const DtUUID &routeId)
virtual void	setClosestLeg (const DtLocalVertexList &localVertices)
virtual void	setHoldPointPosition (double p)
virtual double	holdPointPosition () const
virtual void	setHoldPointLocation (const DtVector &localPos)
virtual DtVector	holdPointLocation () const
virtual void	setTargetPointPosition (double p)
virtual double	targetPointPosition () const
virtual void	setTargetPointLocation (const DtVector &localPos)
virtual DtVector	targetPointLocation () const
virtual void	setTimeOnTarget (double t)
virtual double	timeOnTarget () const
virtual void	postGetSelf () override
virtual DtSimObjectReference	route () const
virtual void	setRouteLegActions (const DtRwRouteActionList &actionsList)
virtual const DtRouteLegActionsEntryList &	routeLegActionsEntryList () const
virtual void	clearLegsActionsList ()
virtual void	reorganizeLegsActionsList ()
virtual void	setReverseFlag (bool reverse)
virtual bool	reverseFlag () const
virtual void	setStartAtClosestVertex (bool flag)
virtual bool	startAtClosestVertex () const
virtual void	setAbandonTaskIfTimeOnTargetNotAchievable (bool b)
virtual bool	abandonTaskIfTimeOnTargetNotAchievable () const
virtual void	setMoveAlongSubtaskId (int subtaskId)
virtual int	moveAlongSubtaskId () const
virtual void	setSuspendedMoveAlongId (int suspendId)
virtual int	suspendedMoveAlongId () const
virtual void	setInitialOrderedSpeed (double s)
virtual double	initialOrderedSpeed () const
virtual void	setOrderedSpeedIsRequired (bool c)
virtual bool	isOrderedSpeedRequired () const
virtual void	setRouteTraversalComplete (bool c)
virtual bool	routeTraversalComplete () const
virtual DtRouteLegActionsEntryIterator *	legIterator () const
virtual void	proceedToNextLegIndex ()
virtual bool	compareLocalVertices (const DtVector &firstLocalPos, const DtVector &secondLocalPos)
virtual const DtRwRouteActionList &	validRouteActions () const
virtual void	updateValidRouteActions ()
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 () override
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) const
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	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
virtual void	resetLegIterator ()
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
DtRwSimObjectReference	myRoute
DtRwInt	myCurrentLegIndex
DtRwBoolean	myReverseFlag
DtRwBoolean	myStartAtClosestVertex
DtRwBoolean	myRouteTraversalComplete
DtRwBoolean	myAbandonTaskIfTimeOnTargetNotAchievable
DtRwReal	myInitialOrderedSpeed
DtRwBoolean	myOrderedSpeedIsRequired
DtRwReal	myTimeOnTarget
DtRwReal	myHoldPointRoutePosition
DtRwReal	myTargetPointRoutePosition
DtRwVector	myHoldPointLocation
DtRwVector	myTargetPointLocation
DtRouteLegActionsEntryList	myRouteLegActionsEntryList
DtRwInt	myMoveAlongSubtaskId
DtRwInt	mySuspendedMoveAlongId
DtRouteLegActionsEntryIterator *	myCurrentLegIterator
DtRwRouteActionList	myValidRouteActions
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

DtMoveAlongWithActionsPSR::DtMoveAlongWithActionsPSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

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

copy constructor

virtual DtMoveAlongWithActionsPSR::~DtMoveAlongWithActionsPSR ( )

overridevirtual

destructor

Member Function Documentation

DtMoveAlongWithActionsPSR& DtMoveAlongWithActionsPSR::operator=

(

const DtMoveAlongWithActionsPSR &

orig

)

assignment operator

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

overridevirtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtMoveAlongWithActionsPSR::type ( ) const

overridevirtual

Returns the string type of the repository, as defined in psrTypes.h. (DtMoveAlongWithActionsProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

virtual void DtMoveAlongWithActionsPSR::setRoute ( const DtUUID &  routeId )

virtual

set the route id

virtual void DtMoveAlongWithActionsPSR::setClosestLeg ( const DtLocalVertexList &  localVertices )

virtual

set up the legs actions, depending on the closest vertex to the current position of the entity

virtual void DtMoveAlongWithActionsPSR::setHoldPointPosition ( double  p )

virtual

The hold point position along the route. Value is based on the vertices of the route, e.g. 2.75 is 75% of the way between vertex 2 and vertex 3.

virtual double DtMoveAlongWithActionsPSR::holdPointPosition ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setHoldPointLocation ( const DtVector &  localPos )

virtual

The hold point location in local coordinates.

virtual DtVector DtMoveAlongWithActionsPSR::holdPointLocation ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setTargetPointPosition ( double  p )

virtual

The target position along the route. Value is based on the vertices of the route, e.g. 2.75 is 75% of the way between vertex 2 and vertex 3.

virtual double DtMoveAlongWithActionsPSR::targetPointPosition ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setTargetPointLocation ( const DtVector &  localPos )

virtual

The target point location in local coordinates.

virtual DtVector DtMoveAlongWithActionsPSR::targetPointLocation ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setTimeOnTarget ( double  t )

virtual

The sim time we should arrive at the target.

virtual double DtMoveAlongWithActionsPSR::timeOnTarget ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::postGetSelf ( )

overridevirtual

restore the route legs entries state

Reimplemented from DtReaderWriter.

virtual DtSimObjectReference DtMoveAlongWithActionsPSR::route ( ) const

virtual

return the route

virtual void DtMoveAlongWithActionsPSR::setRouteLegActions ( const DtRwRouteActionList &  actionsList )

virtual

insert the route actions into the legs list. a valid route need to be set beforehand to add the actions to the corresponding legs

virtual const DtRouteLegActionsEntryList& DtMoveAlongWithActionsPSR::routeLegActionsEntryList ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::clearLegsActionsList ( )

virtual

empty the actionList

virtual void DtMoveAlongWithActionsPSR::reorganizeLegsActionsList ( )

virtual

reorganize the actionList in case the route was changed.

virtual void DtMoveAlongWithActionsPSR::setReverseFlag ( bool  reverse )

virtual

Reverse the direction of the leg list and leg actions list.

virtual bool DtMoveAlongWithActionsPSR::reverseFlag ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setStartAtClosestVertex ( bool  flag )

virtual

Start at closest vertex flag.

virtual bool DtMoveAlongWithActionsPSR::startAtClosestVertex ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setAbandonTaskIfTimeOnTargetNotAchievable ( bool  b )

virtual

Abandon the task if the time on target cannot be achieved.

virtual bool DtMoveAlongWithActionsPSR::abandonTaskIfTimeOnTargetNotAchievable ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setMoveAlongSubtaskId ( int  subtaskId )

virtual

The subtask id of the move-along task.

virtual int DtMoveAlongWithActionsPSR::moveAlongSubtaskId ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setSuspendedMoveAlongId ( int  suspendId )

virtual

The suspend id of the move-along task.

virtual int DtMoveAlongWithActionsPSR::suspendedMoveAlongId ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setInitialOrderedSpeed ( double  s )

virtual

The initial ordered speed when the task starts.

virtual double DtMoveAlongWithActionsPSR::initialOrderedSpeed ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setOrderedSpeedIsRequired ( bool  c )

virtual

Whether the ordered speed set from Set Ordered Speed is recommended or required Default is false (i.e. speed is recommended)

virtual bool DtMoveAlongWithActionsPSR::isOrderedSpeedRequired ( ) const

virtual

virtual void DtMoveAlongWithActionsPSR::setRouteTraversalComplete ( bool  c )

virtual

Whether the route traversal subtask has completed.

virtual bool DtMoveAlongWithActionsPSR::routeTraversalComplete ( ) const

virtual

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

static

Returns a newly created instance of this class.

virtual DtRouteLegActionsEntryIterator* DtMoveAlongWithActionsPSR::legIterator ( ) const

virtual

Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).

virtual void DtMoveAlongWithActionsPSR::proceedToNextLegIndex ( )

virtual

virtual bool DtMoveAlongWithActionsPSR::compareLocalVertices ( const DtVector &  firstLocalPos, const DtVector &  secondLocalPos  )

virtual

virtual const DtRwRouteActionList& DtMoveAlongWithActionsPSR::validRouteActions ( ) const

virtual

return valid actions list.

virtual void DtMoveAlongWithActionsPSR::updateValidRouteActions ( )

virtual

iterate over the legs entry and insert valid actions to myValidRouteActions should be called whenever an action is skipped.

virtual void DtMoveAlongWithActionsPSR::resetLegIterator ( )

protectedvirtual

Member Data Documentation

DtRwSimObjectReference DtMoveAlongWithActionsPSR::myRoute

protected

DtRwInt DtMoveAlongWithActionsPSR::myCurrentLegIndex

protected

DtRwBoolean DtMoveAlongWithActionsPSR::myReverseFlag

protected

DtRwBoolean DtMoveAlongWithActionsPSR::myStartAtClosestVertex

protected

DtRwBoolean DtMoveAlongWithActionsPSR::myRouteTraversalComplete

protected

DtRwBoolean DtMoveAlongWithActionsPSR::myAbandonTaskIfTimeOnTargetNotAchievable

protected

DtRwReal DtMoveAlongWithActionsPSR::myInitialOrderedSpeed

protected

DtRwBoolean DtMoveAlongWithActionsPSR::myOrderedSpeedIsRequired

protected

DtRwReal DtMoveAlongWithActionsPSR::myTimeOnTarget

protected

DtRwReal DtMoveAlongWithActionsPSR::myHoldPointRoutePosition

protected

DtRwReal DtMoveAlongWithActionsPSR::myTargetPointRoutePosition

protected

DtRwVector DtMoveAlongWithActionsPSR::myHoldPointLocation

protected

DtRwVector DtMoveAlongWithActionsPSR::myTargetPointLocation

protected

DtRouteLegActionsEntryList DtMoveAlongWithActionsPSR::myRouteLegActionsEntryList

protected

DtRwInt DtMoveAlongWithActionsPSR::myMoveAlongSubtaskId

protected

DtRwInt DtMoveAlongWithActionsPSR::mySuspendedMoveAlongId

protected

DtRouteLegActionsEntryIterator* DtMoveAlongWithActionsPSR::myCurrentLegIterator

protected

DtRwRouteActionList DtMoveAlongWithActionsPSR::myValidRouteActions

protected

a list that manages valid actions. a non valid action is an action that was skipped. the list is not saved as part of the scenario and is updated on several cases when myRouteLegActionsEntryList is updated (a leg is deleted, an action is skipped, etc.)

---

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

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