DtHumanMoveAlongPSR Class Reference

class DtHumanMoveAlongPSR:

Instances of DtHumanMoveAlongPSR are used to hold the shared/checkpointable data for a DtHumanMoveAlongController.

Inheritance diagram for DtHumanMoveAlongPSR:

Public Member Functions
	DtHumanMoveAlongPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtHumanMoveAlongPSR (const DtHumanMoveAlongPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtHumanMoveAlongPSR () override
DtHumanMoveAlongPSR &	operator= (const DtHumanMoveAlongPSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	type () const override
virtual const DtLocalVertexList &	routeVertices () const
virtual void	resetRouteState ()
virtual bool	currentVertexIsValid () const
virtual void	moveToNextVertex ()
virtual DtVector	currentVertexLocation () const
virtual DtVector	previousVertexLocation () const
virtual DtVector	lastVertexLocation () const
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath()) override
virtual void	setWorldDestination (const DtVector &destination)
virtual const DtVector &	worldDestination () const
virtual void	setRoute (const DtUUID &)
virtual DtSimObjectReference	route () const
virtual void	setMoveToPoint (const DtUUID &)
virtual DtSimObjectReference	moveToPoint () const
virtual void	setReversePatrol (bool flag)
virtual bool	reversePatrol () const
virtual void	setCurrentVertex (int vertex)
virtual int	currentVertex () const
virtual void	setSpeedOverride (double speed)
virtual double	speedOverride () const
virtual void	setIsSpeedOverrideSpecified (bool o)
virtual bool	isSpeedOverrideSpecified () 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 () 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	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 Attributes
DtRwSimObjectReference	myRoute
DtRwSimObjectReference	myMoveToPoint
DtRwInt	myCurrentVertex
DtRwBoolean	myReverseFlag
DtRwVector	myWorldDestination
DtRwReal	mySpeedOverride
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 )()
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

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtHumanMoveAlongPSR::~DtHumanMoveAlongPSR ( )

overridevirtual

destructor

Member Function Documentation

DtHumanMoveAlongPSR& DtHumanMoveAlongPSR::operator=

(

const DtHumanMoveAlongPSR &

orig

)

assignment operator

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

overridevirtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtHumanMoveAlongPSR::type ( ) const

overridevirtual

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

Implements DtVrfProcessStateRepository.

virtual void DtHumanMoveAlongPSR::setWorldDestination ( const DtVector &  destination )

virtual

Get/set the location to which this entity is moving towards for a move to destination (or derivative) task. This point is only valid for that task and is set in world (geocentric) coordinates.

virtual const DtVector& DtHumanMoveAlongPSR::worldDestination ( ) const

virtual

Get/set the location to which this entity is moving towards for a move to destination (or derivative) task. This point is only valid for that task and is set in world (geocentric) coordinates.

virtual void DtHumanMoveAlongPSR::setRoute ( const DtUUID &  )

virtual

Get/set the name of the route to move along.Was setRouteName.

virtual DtSimObjectReference DtHumanMoveAlongPSR::route ( ) const

virtual

Was: routeName.

virtual void DtHumanMoveAlongPSR::setMoveToPoint ( const DtUUID &  )

virtual

Get/set the name of the move to pointWas setMoveToPoint.

virtual DtSimObjectReference DtHumanMoveAlongPSR::moveToPoint ( ) const

virtual

Was: routeName.

virtual const DtLocalVertexList& DtHumanMoveAlongPSR::routeVertices ( ) const

virtual

Get route vertices (local coordinates).

virtual void DtHumanMoveAlongPSR::resetRouteState ( )

virtual

Reset the current state of route following.

virtual void DtHumanMoveAlongPSR::setReversePatrol ( bool  flag )

virtual

Get/set the reverse flag for patrolling (along route or between points).

virtual bool DtHumanMoveAlongPSR::reversePatrol ( ) const

virtual

Get/set the reverse flag for patrolling (along route or between points).

virtual void DtHumanMoveAlongPSR::setCurrentVertex ( int  vertex )

virtual

Sets current vertex we are heading toward. Vertices are numbered starting from zero.

virtual int DtHumanMoveAlongPSR::currentVertex ( ) const

virtual

Sets current vertex we are heading toward. Vertices are numbered starting from zero.

virtual bool DtHumanMoveAlongPSR::currentVertexIsValid ( ) const

virtual

Returns true if the current vertex is valid.

virtual void DtHumanMoveAlongPSR::moveToNextVertex ( )

virtual

Increments the current vertex to the next vertex on the route.

virtual DtVector DtHumanMoveAlongPSR::currentVertexLocation ( ) const

virtual

Returns the location, in local coordinates, of the current vertex we are heading toward.

virtual DtVector DtHumanMoveAlongPSR::previousVertexLocation ( ) const

virtual

Returns the location, in local coordinates, of the previous vertex we were heading toward.

virtual DtVector DtHumanMoveAlongPSR::lastVertexLocation ( ) const

virtual

Returns the location, in local coordinates, of the last vertex on the route in the direction we are currently heading.

virtual void DtHumanMoveAlongPSR::setSpeedOverride ( double  speed )

virtual

Get/set the override speed. If not specified, ordered speed is used.

virtual double DtHumanMoveAlongPSR::speedOverride ( ) const

virtual

Get/set the override speed. If not specified, ordered speed is used.

virtual void DtHumanMoveAlongPSR::setIsSpeedOverrideSpecified ( bool  o )

virtual

Get/set the override speed. If not specified, ordered speed is used.

virtual bool DtHumanMoveAlongPSR::isSpeedOverrideSpecified ( ) const

virtual

Get/set the override speed. If not specified, ordered speed is used.

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

overridevirtual

Override to set myCurrentVertex from route state before writing.

Reimplemented from DtReaderWriter.

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

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwSimObjectReference DtHumanMoveAlongPSR::myRoute

protected

If tasked() is true, this is the name of the route object we're moving to.

DtRwSimObjectReference DtHumanMoveAlongPSR::myMoveToPoint

protected

When the move to subtask is issued, this is the point moving to.

DtRwInt DtHumanMoveAlongPSR::myCurrentVertex

protected

Read/write variables to capture route state.

DtRwBoolean DtHumanMoveAlongPSR::myReverseFlag

protected

From DtGroundPatrolRouteController (gndPtrlRtCtl.h)

DtRwVector DtHumanMoveAlongPSR::myWorldDestination

protected

World point for move to location tasks.

DtRwReal DtHumanMoveAlongPSR::mySpeedOverride

protected

The speed override.

---

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

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