DtRailPathTask Class Reference

File: railPathTask.h.

Class: DtRailPathTask DtRailPathTask represents a railPath task for an entity to perform. It inherits DtPathTask and has all the same parameters as that task.

This task can be used by any vehicle having a rail path planning controller. It indicates that the vehicle should plan a path to the specified object, and then move along that path to the object. The entity while on the path will switch to the rails movement system which locks the entity on to the path and optionally provide smooth turning around corners.

task-type: DtRailPathType

parameters: control point name - The string name of the control point to move toward. You can look up the DtSimObject corresponding to this name in the Object Manager.

Inheritance diagram for DtRailPathTask:

Public Member Functions
	DtRailPathTask ()
	DtRailPathTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtRailPathTask (const DtString &writeName, const DtRailPathTask &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtRailPathTask &	operator= (const DtRailPathTask &orig)
virtual	~DtRailPathTask ()
virtual const DtSimTaskMessageType &	type () const
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	stringRep () const
virtual void	setDestinationSpecified (bool specified)
virtual bool	destinationSpecified () const
virtual void	setDestination (const DtUUID &name)
virtual const DtUUID &	destination () const
virtual void	setDestinationLocation (const DtVector &destination)
virtual const DtVector &	destinationLocation () const
virtual void	setDestinationIsRoute (bool route)
virtual bool	destinationIsRoute () const
virtual void	setTraversalDirection (DtIteratorDirection traversalDirection)
virtual DtIteratorDirection	traversalDirection () const
virtual void	setStartAtClosestPoint (bool startAtClosestPoint)
virtual bool	startAtClosestPoint () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()
virtual bool	init ()
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void	setSubtask (bool flag)
virtual bool	subtask () const
virtual void	setAllowTaskVisualizations (bool flag)
virtual bool	allowTaskVisualizations () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual char *	netRep ()
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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
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	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 DtSimTask *	creator ()
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
static void	setFactory (DtSimTaskFactory *factory)
static DtSimTaskFactory *	factory ()
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
DtRwUUID	myDestination
DtRwBoolean	myDestinationSpecified
DtRwVector	myDestinationLocation
DtRwBoolean	myDestinationIsRoute
DtRwInt	myTraversalDirection
DtRwBoolean	myStartAtClosestPoint
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
DtRwBoolean	myAllowTaskVisualizations
char *	myNetRep
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 DtSimTask
	DtSimTask ()
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSimTask &	operator= (const DtSimTask &orig)
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	myFactory
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

DtRailPathTask::DtRailPathTask

(

)

default constructor

DtRailPathTask::DtRailPathTask	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a task 'put' itself, the writeName will preface the task.

DtRailPathTask::DtRailPathTask	(	const DtString &	writeName,
		const DtRailPathTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtRailPathTask::~DtRailPathTask ( )

virtual

Member Function Documentation

const DtRailPathTask& DtRailPathTask::operator=

(

const DtRailPathTask &

orig

)

assignment operator

virtual const DtSimTaskMessageType& DtRailPathTask::type ( ) const

virtual

Returns "rail-path-task".

Implements DtSimTask.

virtual DtSimTask* DtRailPathTask::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

Creates a copy of this task.

Implements DtSimTask.

virtual DtString DtRailPathTask::stringRep ( ) const

virtual

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtRailPathTask::setDestinationSpecified ( bool  specified )

virtual

Was: setDestinationNameSpecified.

virtual bool DtRailPathTask::destinationSpecified ( ) const

virtual

Was: destinationNameSpecified.

virtual void DtRailPathTask::setDestination ( const DtUUID &  name )

virtual

Was: setDestinationName.

virtual const DtUUID& DtRailPathTask::destination ( ) const

virtual

Was: setDestinatioName.

virtual void DtRailPathTask::setDestinationLocation ( const DtVector &  destination )

virtual

Was: setDestination.

virtual const DtVector& DtRailPathTask::destinationLocation ( ) const

virtual

Was: destination.

virtual void DtRailPathTask::setDestinationIsRoute ( bool  route )

virtual

virtual bool DtRailPathTask::destinationIsRoute ( ) const

virtual

virtual void DtRailPathTask::setTraversalDirection ( DtIteratorDirection  traversalDirection )

virtual

[DtIteratorDirection::DtForward, DtIteratorDirection::DtReverse] By default, traversalDirection is false.

virtual DtIteratorDirection DtRailPathTask::traversalDirection ( ) const

virtual

virtual void DtRailPathTask::setStartAtClosestPoint ( bool  startAtClosestPoint )

virtual

Flag indicating whether traversal should start at the beginning of route or at the closest point (which may be somewhere along the route). Beginning is either 1st or last vertex, depending on traversal direction. By default, startAtClosestPoint is false.

virtual bool DtRailPathTask::startAtClosestPoint ( ) const

virtual

virtual int DtRailPathTask::netRepSize ( ) const

virtual

Returns the size in bytes of the network representation of the class. This is the size in bytes of the DtNetSimTask structure. Derived classes should take into account the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimTask.

virtual bool DtRailPathTask::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask). Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimTask::netRepSize().

Reimplemented from DtSimTask.

virtual bool DtRailPathTask::setToNet ( )

virtual

Calls netRep() to create the network buffer. Casts the resulting myNetRep to type DtNetSimTask*, and then sets the mySubtask member in the DtNetSimTask from mySubtask. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimTask::netRepSize().

Reimplemented from DtSimTask.

static DtSimTask* DtRailPathTask::creator ( )

static

Member Data Documentation

DtRwUUID DtRailPathTask::myDestination

protected

DtRwBoolean DtRailPathTask::myDestinationSpecified

protected

DtRwVector DtRailPathTask::myDestinationLocation

protected

DtRwBoolean DtRailPathTask::myDestinationIsRoute

protected

DtRwInt DtRailPathTask::myTraversalDirection

protected

DtRwBoolean DtRailPathTask::myStartAtClosestPoint

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrftasks/railPathTask.h