DtRailPathController Class Reference

DtRailPathController is a controller that models movement along a generated path for an entity making use of any feature data or routes of the type specified in the path metric. More...

Inheritance diagram for DtRailPathController:

Public Member Functions
	DtRailPathController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=NULL, DtReaderWriterRegistry *parentRegistry=NULL)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtRailPathController ()
virtual bool	init ()
	Initial setup of component after creation.
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
virtual bool	beginProcessingTask (const DtTaskMessage &msg, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	registerTaskMsgCallbacks ()
	Overridden to register interest in move to messages.
virtual void	processTaskCompleteReport (DtSimMessage *msg)
virtual void	processDestinationChanged (DtVrfObject *obj)
	Ensures that the destination stored in the ProcessStateRepository is consistent with the location of the destination control point.
virtual void	tick ()
	Main processing for component.
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtSingleTaskControllerComponent ()
	destructor
virtual void	postTick ()
	Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual void	taskNotify (const DtSimTask &task)
	This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual void	taskComplete (bool success=true)
	If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.
virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself.
virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks.
virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks.
virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component.
virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks.
virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller.
virtual void	clearCurrentTaskMessage ()
	Returns the current subtask with the specified id.
virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity.
virtual DtSimTaskStatePtr	currentTaskState () const
virtual bool	decideToGiveUpTask () const
	This function is used to determine if the controller should give up trying to execute the current task.
virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true.
virtual bool	taskActive (int taskId) const
virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared.
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller.
virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller.
virtual std::list < DtTaskMessage * >	currentTaskMessages () const
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtTaskControllerComponent ()
	destructor
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimBaseRadio *radio)
	Calls registerTaskMsgCallbacks.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback.
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback().
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback.
virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks().
virtual void	disable ()
	Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message.
virtual void	setTasked (bool tasked)
	The current tasked state of this controller.
virtual bool	tasked () const
	The current tasked state of this controller.
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimBaseRadio *	radio ()
	The radio this component is listening to.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
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 actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
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 void	taskCompleteReportCallback (DtSimMessage *msg, void *usr)
static void	destinationChangedCallback (DtVrfObject *obj, void *usrData)
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions
virtual void	clearCurrentPath ()
virtual bool	setupPathFromRailList (DtRailSegmentList *, bool testRange=true)
virtual bool	setupPathFromRoute (DtVrfObject *route, bool startClosestPoint, DtIteratorDirection traversalDirection)
virtual bool	isEntityCloseEnoughToRoad (DtRailSegment *railSegment, double distance, double &actualDistSq) const
	Uses the rail segment's first point as the start.
double	maxSearchRadius (const DtVector &start, const DtVector &end)
virtual void	registerDestinationChangedCallback ()
	Registers a vertices changed callback with the destination object named in the PSR.
virtual void	unregisterDestinationChangedCallback ()
	Unregisters a vertices changed callback from the destination object named in the PSR.
virtual DtVrfObject *	publishDebugPath (DtRailSegmentList *)
	Creates a new VRF Object corresponding to the path generated by the path planner.
virtual void	removeDebugPath ()
	Removes the VrfObject corresponding to the path that was published and whose name is stored in myPathName.
virtual bool	setupPathToDestination (const DtVector &start, const DtVector &end)
	uses the DtRailPathPlanner to calculate a path from start to end.
virtual void	clearTask ()
	Overridden from DtTaskControllerComponent to clean up the path calculating thread, remove any generated path objects, and stop any subtasks if the current task is aborted.
Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
	Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type.

Protected Attributes
DtAsyncJobToken *	myPathJobToken
	Token for asynchronous path plan task.
DtRailPathControllerPSR *	myProcessState
	Container for state data associated with this component.
const DtRailPathControllerDescriptor *	myPathDescriptor
bool	myDestinationChangedCallbackRegistered

Private Member Functions
	DtRailPathController ()
	Not Implemented.
	DtRailPathController (const DtRailPathController &orig)
	Not Implemented.
DtRailPathController &	operator= (const DtRailPathController &orig)
	Not Implemented.
virtual void	processObjectAboutToBeRemoved (DtVrfObject *obj)
	If the object being removed is the current destination, then the task is abandoned.
static void	objectAboutToBeRemovedCallback (DtVrfObject *obj, void *usr)
	If the object being removed is the current destination, then the task is abandoned.
virtual void	processSetLocationComplete ()
	Aborts any running path planning, or stops any move along subtask that has been started.
static void	setLocationCompleteCallback (DtVrfObject *, void *usr)
	Aborts any running path planning, or stops any move along subtask that has been started.

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 Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks.
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtRailPathController is a controller that models movement along a generated path for an entity making use of any feature data or routes of the type specified in the path metric.

End User Description: This task controller component responds to path movement tasks by calculating the best path from the current position to the destination using it's rail path planner. It first determines if using feature data or routes is worth the effort or if the entity should just take the direct route. If the former, it finds the entry point and exit point onto and off of the network of feature data/routes and the calculates the most efficent route on the network between the entry point and exit point.

Once the path is calculated, a move location task is issued to the entity to move it using it's normal movement system to the entry point onto the network. Once on the network this controller will deactivate the entity's normal movment system and activate it's rail movement system. Then a rail move along subtask is issued to the DtRailMovementController to allow the entity to efficently move along the generated rail path without the weaving motion symtopmatic of the default move controllers. Once the subtask completes, this controller deactivates the rail system and reactivates the default movement system. If a task was planned to a named object, and that object changes location during the run of this task, the original path will be removed, and a new path will be planned.

Note

The entity will remain in place while it is planning a path. If the terrain is complex, the distance to the destination is large, or there is not much available processor this may be a lengthy process.

This component can be configured though its descriptor, the DtRailPathControllerDescriptor. See this class for information on altering the path planning parameters in the OPE file.

This component maintains its internal state in a DtRailPathControllerPSR.

Uses Descriptor Type: DtRailPathControllerDescriptor

Constructor & Destructor Documentation

DtRailPathController::DtRailPathController ( )

private

Not Implemented.

DtRailPathController::DtRailPathController ( const DtRailPathController &  orig )

private

Not Implemented.

DtRailPathController::DtRailPathController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = NULL,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtRailPathController::~DtRailPathController ( )

virtual

Member Function Documentation

DtRailPathController& DtRailPathController::operator= ( const DtRailPathController &  orig )

private

Not Implemented.

virtual bool DtRailPathController::init ( )

virtual

Initial setup of component after creation.

Reimplemented from DtControllerComponent.

virtual bool DtRailPathController::createPSR ( )

virtual

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

virtual void DtRailPathController::preFirstTickInit ( )

virtual

This function can be overridden to initialize a component before it is ticked for the first time.

The implementation for this function is empty. It is called by timedTick if myFirstTick is true.

Reimplemented from DtSimComponent.

virtual bool DtRailPathController::beginProcessingTask ( const DtTaskMessage &  task, DtSimTaskStatePtr  taskState  )

virtual

Called by the task manager when this controller should start executing the specified task.

Parameters

taskState

Used to convey at what point the task should begin execution. If taskState exists, execution of task may begin at some point other than the logical start of the task. If taskState is 0, begin processing at the logical start of the task.

Returns

True if the controller can successfully start the task.

False if the controller is failing the task.

Reimplemented from DtSingleTaskControllerComponent.

virtual DtString DtRailPathController::type ( ) const

virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns

DtRailPathControllerType

Implements DtTaskControllerComponent.

virtual void DtRailPathController::registerTaskMsgCallbacks ( )

virtual

Overridden to register interest in move to messages.

Reimplemented from DtTaskControllerComponent.

static void DtRailPathController::taskCompleteReportCallback ( DtSimMessage *  msg, void *  usr  )

static

virtual void DtRailPathController::processTaskCompleteReport ( DtSimMessage *  msg )

virtual

static void DtRailPathController::destinationChangedCallback ( DtVrfObject *  obj, void *  usrData  )

static

virtual void DtRailPathController::processDestinationChanged ( DtVrfObject *  obj )

virtual

Ensures that the destination stored in the ProcessStateRepository is consistent with the location of the destination control point.

Intended to be called only when the position of the control point has changed.

Note

Also invalidates the destination vector as the world position has changed.

static void DtRailPathController::objectAboutToBeRemovedCallback ( DtVrfObject *  obj, void *  usr  )

static

If the object being removed is the current destination, then the task is abandoned.

virtual void DtRailPathController::processObjectAboutToBeRemoved ( DtVrfObject *  obj )

virtual

If the object being removed is the current destination, then the task is abandoned.

static void DtRailPathController::setLocationCompleteCallback ( DtVrfObject *  , void *  usr  )

static

Aborts any running path planning, or stops any move along subtask that has been started.

Restarts path planning using entity's new position.

virtual void DtRailPathController::processSetLocationComplete ( )

virtual

Aborts any running path planning, or stops any move along subtask that has been started.

Restarts path planning using entity's new position.

virtual void DtRailPathController::tick ( )

virtual

Main processing for component.

Reimplemented from DtSimComponent.

virtual void DtRailPathController::clearCurrentPath ( )

protectedvirtual

virtual bool DtRailPathController::setupPathFromRailList ( DtRailSegmentList *  , bool  testRange = true  )

protectedvirtual

virtual bool DtRailPathController::setupPathFromRoute ( DtVrfObject *  route, bool  startClosestPoint, DtIteratorDirection  traversalDirection  )

protectedvirtual

virtual bool DtRailPathController::isEntityCloseEnoughToRoad ( DtRailSegment *  railSegment, double  distance, double &  actualDistSq  ) const

protectedvirtual

Uses the rail segment's first point as the start.

double DtRailPathController::maxSearchRadius ( const DtVector &  start, const DtVector &  end  )

protected

virtual void DtRailPathController::registerDestinationChangedCallback ( )

protectedvirtual

Registers a vertices changed callback with the destination object named in the PSR.

Registers for a setLocation message.

virtual void DtRailPathController::unregisterDestinationChangedCallback ( )

protectedvirtual

Unregisters a vertices changed callback from the destination object named in the PSR.

virtual DtVrfObject* DtRailPathController::publishDebugPath ( DtRailSegmentList *  )

protectedvirtual

Creates a new VRF Object corresponding to the path generated by the path planner.

Returns the VrfObject pointer to the new route object. Used to visualize the generated path.

virtual void DtRailPathController::removeDebugPath ( )

protectedvirtual

Removes the VrfObject corresponding to the path that was published and whose name is stored in myPathName.

virtual bool DtRailPathController::setupPathToDestination ( const DtVector &  start, const DtVector &  end  )

protectedvirtual

uses the DtRailPathPlanner to calculate a path from start to end.

virtual void DtRailPathController::clearTask ( )

protectedvirtual

Overridden from DtTaskControllerComponent to clean up the path calculating thread, remove any generated path objects, and stop any subtasks if the current task is aborted.

Reimplemented from DtSingleTaskControllerComponent.

static DtSimComponent* DtRailPathController::creator ( const DtString &  name, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns

New instance of this class.

Member Data Documentation

DtAsyncJobToken* DtRailPathController::myPathJobToken

protected

Token for asynchronous path plan task.

DtRailPathControllerPSR* DtRailPathController::myProcessState

protected

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).

const DtRailPathControllerDescriptor* DtRailPathController::myPathDescriptor

protected

bool DtRailPathController::myDestinationChangedCallbackRegistered

protected

---

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

• include/vrfmodel/railPathController.h