DtRailPathTask Class Reference

File: railPathTask.h. More...

Inheritance diagram for DtRailPathTask:

Public Member Functions
	DtRailPathTask ()
	default constructor
	DtRailPathTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtRailPathTask (const DtString &writeName, const DtRailPathTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtRailPathTask &	operator= (const DtRailPathTask &orig)
	assignment operator
virtual	~DtRailPathTask ()
virtual const DtSimTaskMessageType &	type () const
	Returns "rail-path-task".
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual void	setDestinationNameSpecified (bool specified)
virtual bool	destinationNameSpecified () const
virtual void	setDestinationName (const DtString &name)
virtual const DtString &	destinationName () const
virtual void	setDestination (const DtVector &destination)
virtual const DtVector &	destination () const
virtual void	setDestinationIsRoute (bool route)
virtual bool	destinationIsRoute () const
virtual void	setTraversalDirection (DtIteratorDirection traversalDirection)
	[DtIteratorDirection::DtForward, DtIteratorDirection::DtReverse] By default, traversalDirection is false.
virtual DtIteratorDirection	traversalDirection () const
virtual void	setStartAtClosestPoint (bool startAtClosestPoint)
	Flag indicating whether traversal should start at the beginning of route or at the closest point (which may be somewhere along the route).
virtual bool	startAtClosestPoint () const
virtual int	netRepSize () const
	Returns the size in bytes of the network representation of the class.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).
virtual bool	setToNet ()
	Calls netRep() to create the network buffer.
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void	setSubtask (bool flag)
	If true, this task is a subtask.
virtual bool	subtask () const
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual char *	netRep ()
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
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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 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 DtSimTask *	creator ()
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
	Static functions.
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
	Adds a task creator member function to the task factory.
static void	setFactory (DtSimTaskFactory *factory)
static DtSimTaskFactory *	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.

Protected Attributes
DtRwObjectName	myDestinationObjectName
DtRwBoolean	myDestinationNameSpecified
DtRwVector	myDestination
DtRwBoolean	myDestinationIsRoute
DtRwInt	myTraversalDirection
DtRwBoolean	myStartAtClosestPoint
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
char *	myNetRep
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
Protected Member Functions inherited from DtSimTask
	DtSimTask ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the write name will preface the task.
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimTask &	operator= (const DtSimTask &orig)
	assignment operator; same as copy constructor
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	myFactory

Detailed Description

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 DtVrfObject corresponding to this name in the Object Manager.

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::setDestinationNameSpecified ( bool  specified )

virtual

virtual bool DtRailPathTask::destinationNameSpecified ( ) const

virtual

virtual void DtRailPathTask::setDestinationName ( const DtString &  name )

virtual

virtual const DtString& DtRailPathTask::destinationName ( ) const

virtual

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

virtual

virtual const DtVector& DtRailPathTask::destination ( ) const

virtual

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 acount 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

DtRwObjectName DtRailPathTask::myDestinationObjectName

protected

DtRwBoolean DtRailPathTask::myDestinationNameSpecified

protected

DtRwVector DtRailPathTask::myDestination

protected

DtRwBoolean DtRailPathTask::myDestinationIsRoute

protected

DtRwInt DtRailPathTask::myTraversalDirection

protected

DtRwBoolean DtRailPathTask::myStartAtClosestPoint

protected

---

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

• include/vrftasks/railPathTask.h