DtHumanMoveAlongPSR Class Reference

class DtHumanMoveAlongPSR: More...

Inheritance diagram for DtHumanMoveAlongPSR:

Public Member Functions
	DtHumanMoveAlongPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtHumanMoveAlongPSR (const DtHumanMoveAlongPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtHumanMoveAlongPSR ()
	destructor
DtHumanMoveAlongPSR &	operator= (const DtHumanMoveAlongPSR &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 the repository, as defined in procSRTypes.h.
virtual void	emptyRouteVertices ()
	Empty route vertices.
virtual DtLocalVectorIterator *	routeState () const
	Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to set myCurrentVertex from route state before writing.
virtual void	setWorldDestination (const DtVector &destination)
	Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.
virtual const DtVector &	worldDestination () const
	Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.
virtual void	setRouteName (const DtString &routeObjectName)
	Get/set the name of the route DtVrfObject to move along.
virtual const DtString &	routeName () const
	Get/set the name of the route DtVrfObject to move along.
virtual void	setRouteVertices (const DtLocalVectorIterator &routeIterator)
	Set/get route vertices (local coordinates).
virtual void	setRouteVertices (const DtLocalVertexList &routeVertices)
	Set/get route vertices (local coordinates).
virtual const DtLocalVertexList &	routeVertices () const
	Set/get route vertices (local coordinates).
virtual void	setReversePatrol (bool flag)
	Get/set the reverse flag for patrolling (along route or between points).
virtual bool	reversePatrol () const
	Get/set the reverse flag for patrolling (along route or between points).
virtual void	setRouteIsDiscovered (bool value)
virtual bool	routeIsDiscovered () const
virtual void	setCurrentVertex (int vertex)
virtual int	currentVertex () const
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 DtFilename &searchPath, 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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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 DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Attributes
DtRwString	myRouteName
	If tasked() is true, this is the name of the route object we're moving to.
DtLocalVectorIterator *	myRouteState
	Route state used to get info about the current route we're trying to follow (e.g.
DtLocalVertexList	myVertices
	my copy of the current route
DtRwInt	myCurrentVertex
	Read/write variables to capture route state.
DtRwBoolean	myReverseFlag
	From DtGroundPatrolRouteController (gndPtrlRtCtl.h)
DtRwVector	myWorldDestination
	World point for move to location tasks.
DtRwBoolean	myRouteIsDiscovered
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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
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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

class DtHumanMoveAlongPSR:

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

Constructor & Destructor Documentation

DtHumanMoveAlongPSR::DtHumanMoveAlongPSR	(	DtVrfObject *	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 ( )

virtual

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtHumanMoveAlongPSR::type ( ) const

virtual

Returns the string type of the repository, as defined in procSRTypes.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::setRouteName ( const DtString &  routeObjectName )

virtual

Get/set the name of the route DtVrfObject to move along.

virtual const DtString& DtHumanMoveAlongPSR::routeName ( ) const

virtual

Get/set the name of the route DtVrfObject to move along.

virtual void DtHumanMoveAlongPSR::setRouteVertices ( const DtLocalVectorIterator &  routeIterator )

virtual

Set/get route vertices (local coordinates).

Once route is set, can access routeState() to query and set current position along route.

virtual void DtHumanMoveAlongPSR::setRouteVertices ( const DtLocalVertexList &  routeVertices )

virtual

Set/get route vertices (local coordinates).

Once route is set, can access routeState() to query and set current position along route.

virtual const DtLocalVertexList& DtHumanMoveAlongPSR::routeVertices ( ) const

virtual

Set/get route vertices (local coordinates).

Once route is set, can access routeState() to query and set current position along route.

virtual void DtHumanMoveAlongPSR::emptyRouteVertices ( )

virtual

Empty route vertices.

virtual DtLocalVectorIterator* DtHumanMoveAlongPSR::routeState ( ) 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 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::setRouteIsDiscovered ( bool  value )

virtual

Sets whether the current task has been sucessfully initialized

virtual bool DtHumanMoveAlongPSR::routeIsDiscovered ( ) const

virtual

Sets whether the current task has been sucessfully initialized

virtual void DtHumanMoveAlongPSR::setCurrentVertex ( int  vertex )

virtual

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

virtual int DtHumanMoveAlongPSR::currentVertex ( ) const

virtual

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

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

virtual

Override to set myCurrentVertex from route state before writing.

Reimplemented from DtReaderWriter.

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

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwString DtHumanMoveAlongPSR::myRouteName

protected

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

DtLocalVectorIterator* DtHumanMoveAlongPSR::myRouteState

protected

Route state used to get info about the current route we're trying to follow (e.g.

which vertex to move toward).

DtLocalVertexList DtHumanMoveAlongPSR::myVertices

protected

my copy of the current route

DtRwInt DtHumanMoveAlongPSR::myCurrentVertex

protected

Read/write variables to capture route state.

DtRwBoolean DtHumanMoveAlongPSR::myRouteIsDiscovered

protected

From DtGroundMoveAlongController (gndMvAlgCtl.h)

Flag indicating whether route to follow has been discovered or not.

DtRwBoolean DtHumanMoveAlongPSR::myReverseFlag

protected

From DtGroundPatrolRouteController (gndPtrlRtCtl.h)

DtRwVector DtHumanMoveAlongPSR::myWorldDestination

protected

World point for move to location tasks.

---

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

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