DtRoadMovementController is a movement controller that models an entity's movement along a road path. More...

Inheritance diagram for DtRoadMovementController:

Public Member Functions
	DtRoadMovementController (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtRoadMovementController ()
	destructor More...

const DtRailSegmentList *	path () const

Class Administrative Functions
virtual const char *	type () const
	Returns a string identifies the class type of component. More...

virtual bool	init ()
	Create and initialize our roadUpdater, roadObstructionFinder, roadPathFunctions (using the set functions below), myFrontOffset, myRearAxleOffset, and settings manager callback. More...

virtual void	preFirstTickInit ()
	Calls initializeCurrentState from the currentTaskMessage. More...

virtual void	tick ()
	Determines how the entity moves along the given path.Checks if entity has completed it's task. More...

virtual void	clear ()

virtual bool	tickWhileDestroyed () const
	Define tickWhileDestroyed because this controller acts as an actuator in the way it updates the position of the entity directly. More...

virtual void	registerTaskMsgCallbacks ()
	Overrides this so it can register it's interest in RailMoveAlong commands. More...

Support Classes
These set functions can be used or overridden to install derivatives of the support classes.
virtual const DtRoadConstants *	roadConstants ()

virtual void	setRoadConstants (const DtRoadConstants *rc)
	A new set of road constants can be set in a class derived from DtRoadConstansts; then set the pointer here with the value MyRoadConstants::instance() More...

virtual DtRoadPathFunctions *	pathFunctions ()

virtual void	setPathFunctions (DtRoadPathFunctions *pf)

virtual DtRoadDrivingLogic *	drivingLogic ()

virtual void	setDrivingLogic (DtRoadDrivingLogic *dl)

virtual DtRoadObstructionFinder *	obstructionFinder ()

virtual void	setObstructionFinder (DtRoadObstructionFinder *of)
	After creating a new obstFinder, call init() on it. More...

virtual DtRoadMovementUpdater *	movementUpdater ()

virtual void	setMovementUpdater (DtRoadMovementUpdater *u)
	After creating a new updater, call init(), setEntityState(), and setPSR() on the new updater. More...

Accessors for Task State and Entity Data.
virtual DtRailMovementControllerPSR *	psr ()

virtual const DtMovingObjectParameters *	objectParameters ()

virtual const DtRoadMovementDescriptor *	descriptor () const

Member Accessors
virtual bool	drivingOnLeftEnabled () const

virtual void	setCurrentMovementState (DtRailMovementState state)

virtual DtRailMovementState	currentMovementState () const

virtual DtRoadSegment *	currentRoadSegment () const

virtual void	setCurrentRoadSegment (DtRoadSegment *seg)

virtual double	frontOffset () const
	Distance from vehicle center to front edge. More...

virtual void	setFrontOffset (const double o)

virtual double	rearAxleOffset () const
	Distance from vehicle center to reference position at the rear axle. More...

virtual void	setRearAxleOffset (const double o)

virtual DtRailSegmentList *	pathList ()
	Returns a pointer to our path list. More...

virtual const DtRailSegmentList *	pathList () const

virtual DtRoadSegmentPart	roadSegmentPart () const
	Accessors for myRoadSegmentPart (entry curve, straight section, exit curve). More...

virtual void	setRoadSegmentPart (const DtRoadSegmentPart s)

Visualization Support
virtual void	updateTaskVisualizations ()
	Creates visualizations for the path along the road, for areas on the being searched for cars, and for cars identified to be obstacles. More...

virtual bool	findPointOnTerrain (const DtVector &worldLocation, DtVector &worldLocationOnTerrain)
	Finds the closest point on the terrain. More...

virtual std::vector< DtVector > &	debugPoints ()
	Accessor for the individual points representing obstacle vehicles. More...

virtual std::vector < std::vector< DtVector > > &	debugBoxes ()
	Accessor for the array of 4-point arrays representing areas where the controller is looking for obstacle vehicles. More...

Not used; to be deleted.
virtual const double	followSpeedFactor () const

virtual double	getDistanceBehindConvoyTarget (const DtVrfObject *convoyTgt) const

virtual const DtVrfObject *	getObjectFromObstruction (DtRailObstructionPtr &obs)

Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSingleTaskControllerComponent ()
	destructor More...

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)). More...

virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task. More...

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. More...

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. More...

virtual void	suspendTask ()
	This method is called when the currently running task is being suspended. More...

virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself. More...

virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()). More...

virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks. More...

virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks. More...

virtual bool	isSubtasked () const
	Returns true if this controller is currently subtasked. More...

virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component. More...

virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks. More...

virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller. More...

virtual void	clearCurrentTaskMessage ()
	Returns the current subtask with the specified id. More...

virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity. More...

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. More...

virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true. More...

virtual bool	taskActive (int taskId) const

virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared. More...

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type. More...

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller. More...

virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller. More...

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId)

virtual std::list < DtTaskMessage * >	currentTaskMessages () const

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const

virtual void	disable ()
	Overridden to allow tasks controllers that can be disabled to call task complete. More...

Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtTaskControllerComponent ()
	destructor More...

virtual bool	showCurrentTaskInGui () const

virtual void	setRadio (DtSimRadio *radio)
	Calls registerTaskMsgCallbacks. More...

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type. More...

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback. More...

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback(). More...

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback. More...

virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks(). More...

virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message. More...

virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component. More...

virtual void	setTasked (bool tasked)
	The current tasked state of this controller. More...

virtual bool	tasked () const

Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtControllerComponent ()
	destructor More...

virtual DtSimRadio *	radio ()
	The radio this component is listening to. More...

Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent ()
	destructor More...

virtual void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component. More...

DtComponentSystem *	parentSystem () const

virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager. More...

virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values. More...

virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived. More...

virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as More...

virtual double	minTickPeriod () const
	access the minimum tick period More...

virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time More...

virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period More...

virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally. More...

virtual double	nextTickTime () const
	access the next tick time More...

virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...

virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at. More...

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. More...

virtual DtSimComponent *	nextComponent ()
	List management functions. More...

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)
	Used by DtComponentList. More...

virtual DtListItem *	listItem ()

virtual void	putData (std::string &fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class. More...

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored. More...

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. More...

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. More...

virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component. More...

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. More...

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. More...

virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component. More...

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. More...

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. More...

virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component. More...

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. More...

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. More...

virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component. More...

virtual int	priority () const
	Return the current connection priority for this component. More...

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. More...

double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...

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. More...

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. More...

virtual const DtComponentDescriptor *	componentDescriptor () const

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in. More...

const DtPhysicalWorld *	physicalWorld () const

DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any. More...

const DtAttachedTerrain *	terrainAttachedTo () const

DtVrfObject *	entity ()
	Gets the entity. More...

const DtVrfObject *	entity () const

const DtVrfObject *	const_entity () const
	You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...

DtSimManager *	simManager ()
	Gets the sim manager. More...

const DtSimManager *	simManager () const

const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...

DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository. More...

const DtVrfObjectStateRepository *	localStateRepository () const

const DtVrfObjectStateRepository *	const_localStateRepository () const
	You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...

virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component. More...

virtual bool	taskVisualizationsEnabled () const
	Returns true if task visualizations are enabled for this component. More...

virtual bool	isThreadSafe () const
	Returns true if this component is marked as being thread safe. More...

virtual void	addVRLinkDeferredJob (const boost::function< void()> &callback)
	Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe. More...

virtual bool	isEnabled ()

virtual void	setIsEnabled (bool yesNo)

virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const

virtual DtSimResourceManager &	resourceManager ()

virtual const DtSimResourceManager &	resourceManager () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. More...

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

virtual void	writeSelf (std::string &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. More...

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)
	Set read-only flag. More...

bool	isReadonly () const

virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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. More...

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More...

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here. More...

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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())
	Gets data from the environment value. More...

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

Message Callbacks
static void	moveAlongCallback (DtSimMessage msg, void usr)
	Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of rail-move-along tasks. More...

static void	setConvoyFollowCallback (DtSimMessage msg, void usrData)

static void	settingsObjectConsumerCallback (const DtSettingsObject settingsObject, void usr)
	Callback for changing which side of the road entity is driving on. Calls processSetting. More...

Static Public Member Functions inherited from DtTaskControllerComponent
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage msg, void usr, DtSimTaskStatePtr taskState)
	Task processor callback function that acts as an adapter for the deprecated forms of addTaskProcessorCallback and removeTaskProcessorCallback (the deprecated form is is version that. More...

Static Public Member Functions inherited from DtSimComponent
static DtSimComponent *	MarkThreadSafe (DtSimComponent *)
	Marks an instance of a component as being thread safe. More...

static DtSimComponentFactory *	factory ()
	A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...

static void	setFactory (DtSimComponentFactory *factory)

static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtVrfObject owner, DtSimManager simManager, DtComponentSystem parentSystem, DtComponentDescriptor desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More...

static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
	Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...

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 ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Static Public Member Functions inherited from DtObjectDebugger< DtSimComponent >
static DtObjectCounter::CounterType	ObjectCount ()

static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
	DtRoadMovementController ()
	default constructor - should not be called More...

	DtRoadMovementController (const DtRoadMovementController &orig)
	copy constructor More...

DtRoadMovementController &	operator= (const DtRoadMovementController &orig)
	assignment operator More...

virtual bool	initializeCurrentState (DtRailMoveAlongTask *task)
	When loading up from a scenario we need to find out where we were on the route and initialize from our process state repository. More...

virtual bool	setUpRoute (const DtRwRailSegmentList &path)
	Set up our path from the rail move along task's path. More...

virtual int	entryLanePosition (double heading, unsigned int numLanes)
	Determines which lane we should be starting in. More...

virtual void	clearTask ()
	Override to clear route name and route state data stored in myProcessState. More...

virtual void	clearPath ()
	Clears the current path. More...

virtual void	initiateLaneChange (const int newLaneNum)
	Update the controller state to initiate a lane change. More...

virtual void	checkPathEnd ()
	Check to see if the entity has reached the end of the path, and if so set the movement state to DtMovementStop. More...

Support Class Creators
These functions create objects and save them into the relevant member variables.
virtual bool	createPSR ()

virtual bool	createUpdater ()
	This also calls init, setEntityState, and setPSR. More...

virtual bool	createPathFunctions ()

virtual bool	createRoadObstructionFinder ()
	This function also calls init on the obstruction finder. More...

virtual bool	createDrivingLogic ()

Callback Processors
virtual void	processSetting (const DtBoolSetting *setting)
	Sets myDrivingOnLeftEnabled with value in setting. More...

virtual void	processSetConvoyFollowCallback (DtSimMessage *msg)

virtual void	processMoveAlongTask (DtSimMessage *msg)
	Handle messages to move along a generated path. More...

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. More...

virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type. More...

virtual void	cleanupInactiveSubtaskStatus ()
	Clears out subtask status entries that are either completed or canceled which were started by this controller. More...

Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo. More...

virtual void	suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends a single running subtasks of taskId, and puts the suspend info into the provided suspendInfo. More...

virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const
	In case this is aliased, return the actual script id. More...

Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor More...

	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor More...

const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator More...

virtual void	onRestore ()
	Override to iterate over the descriptor to see if there are any targetting control tables. More...

virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)

Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT. More...

bool	testInvariant () const

virtual bool	createPortGroups ()
	Called by init. More...

virtual bool	createPorts ()
	Called by init. More...

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager. More...

virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component. More...

virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization. More...

virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name. More...

virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name. More...

virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name. More...

virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name. More...

double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked. More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()

	DtObjectDebugger (const DtObjectDebugger &)

	~DtObjectDebugger ()

Protected Attributes
DtRailMovementControllerPSR *	myProcessState

const DtRoadMovementDescriptor *	myRoadMoveDescriptor

DtVrfMovingObjectStateRepository *	myMovingStateRep

const DtMovingObjectParameters *	myObjectParams

DtRailSegmentList	myPath
	This is the input path to the controller. More...

DtRoadSegmentList	myRoadPath
	This path is computed, and includes the lane connections and the geometry of the paths connecting the lanes. More...

DtRoadSegment *	myCurrentRoadSegment

bool	myDrivingOnLeft

bool	myNotInitialized

bool	myWarnedAboutMissingConvoyLeaderOnce

bool	myRoadAltitudesSet

double	myFrontOffset
	Distance from entity center to front. More...

double	myRearAxleOffset
	Offset in x from entity center to the center of the rear axle. More...

DtRoadSegmentPart	myRoadSegmentPart
	Keeps track of what part of the road segment the vehicle currently occupies (entry curve, straight section, exit curve). More...


const DtRoadConstants *	myRoadConstants
	The following members hold classes that define key functions of the driving controller. More...

DtRoadPathFunctions *	myRoadPathFunctions
	Class to hold functions that process lists of road segments, i.e. More...

DtRoadDrivingLogic *	myDrivingLogic
	Class to hold functions defining the driving logic. More...

DtRoadObstructionFinder *	myRoadObstructionFinder
	Class to hold functions that find obstructions (vehicles) along the entity's current lane and adjacent lanes. More...

DtRoadMovementUpdater *	myRoadUpdater
	Class to hold functions that perform the kinematic update and compute the resulting position, orientation, and lane offset along the road path. More...


std::vector< DtVector >	myTaskVisPath
	For debug visualizationThe path of the road segments. More...

std::vector< DtVector >	myCurrentTaskVisPath
	The currently displayed task vis path. More...

std::map< DtRoadSegment *, unsigned >	myRoadSegmentTaskVisMap
	Maps road segments to the index of the task vis path points that make up this segment. More...

unsigned	myCurrentTaskVisPathPtIndex
	The current starting point index of the displayed task vis path. More...

bool	myHaveCreatedDebugVis
	Several visualizations are created once and never updated. More...

std::vector< DtVector >	myOriginalPath
	Holds the start (local) locations of the original rail path segments. More...


std::vector< DtVector >	myObstacleLocations
	These visualizations are updated every tick. More...

int	myLastNumObstaclePoints
	The number of obstacles last tick. More...

std::vector< std::vector < DtVector > >	myObstacleBoxes
	A set of polygons representing bounding volumes of the lanes to search for obstacle vehicles. More...

int	myLastNumBoxes
	The number of boxes last tick. More...

Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap

std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList
	This list stores any DtTaskProcessorCallbackInfo allocated locally so that they can be deleted when the component is deleted. More...

Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
	Controller components can send messages. More...

Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity

DtVrfObjectStateRepository *	myLocalStateRepository

DtSimManager *	mySimManager

DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs. More...

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myMinTickPeriod

double	myMinTickPeriodVariance

double	myNextTickTime

double	myLastTickSimTime

double	myDT

bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not. More...

bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick. More...

bool	myIsThreadSafe
	Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs
	List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...

bool	myTickEveryFrame
	Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...

DtTaskVisualizationMap	myTaskVisualizations
	The visualization objects to be drawn for this component. More...

double	myNextTaskVisTickTime
	The next tick time for updating the task visualizations. More...

DtSymbolString	myFullComponentName

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
	Container for the aliases which represent alternative names for the object. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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 Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks. More...

typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap

Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap

typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap

typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap

typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap

Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	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

Detailed Description

DtRoadMovementController is a movement controller that models an entity's movement along a road path.

When a road move task is started, this controller takes the path created from features and passed in a rail path (list of DtRailSegment) and constructs a road path (list of DtRoadSegment). The road path is smoothed to remove segments that are impossible to traverse, and is processed to generate curved arcs to connect the straight segments.

When the task is running, driving logic controls the speed of the entity to drive realistically along the straights and curves and to interact with other traffic that conflicts with it on its path.

The position of the entity is strictly constrained to be along the roads, whether on the centerline or on a computed path between lanes. The controller makes use of an "updater" function that directly updates the state repository with the entity kinematic parameters rather than using an actuator.

Registers for interest in DtRailMoveAlongTasks.

Uses Descriptor Type: DtRoadMovementDescriptor

Constructor & Destructor Documentation

DtRoadMovementController::DtRoadMovementController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

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).

virtual DtRoadMovementController::~DtRoadMovementController ( )

virtual

destructor

DtRoadMovementController::DtRoadMovementController ( )

protected

default constructor - should not be called

DtRoadMovementController::DtRoadMovementController ( const DtRoadMovementController & orig )

protected

copy constructor

Member Function Documentation

virtual const char* DtRoadMovementController::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. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns: DtRoadMoveAlongType

Implements DtTaskControllerComponent.

virtual bool DtRoadMovementController::init ( )

virtual

Create and initialize our roadUpdater, roadObstructionFinder, roadPathFunctions (using the set functions below), myFrontOffset, myRearAxleOffset, and settings manager callback.

Reimplemented from DtControllerComponent.

virtual void DtRoadMovementController::preFirstTickInit ( )

virtual

Calls initializeCurrentState from the currentTaskMessage.

If it's unsuccessfull, calls clear() and taskComplete().

Reimplemented from DtSimComponent.

virtual void DtRoadMovementController::tick ( )

virtual

Determines how the entity moves along the given path.Checks if entity has completed it's task.

The DtRoadMovementUpdater checks for upcoming intersections and determines appropriate behavior. Checks for entities in the way of the path and determines if possible to pass them. Determines the speed and lane position the entity needs and passes this to the DtRoadMovementUpdater.Checks if entity has completed it's task.

Reimplemented from DtSimComponent.

virtual void DtRoadMovementController::clear ( )

virtual

virtual bool DtRoadMovementController::tickWhileDestroyed ( ) const

virtual

Define tickWhileDestroyed because this controller acts as an actuator in the way it updates the position of the entity directly.

Reimplemented from DtSimComponent.

virtual void DtRoadMovementController::registerTaskMsgCallbacks ( )

virtual

Overrides this so it can register it's interest in RailMoveAlong commands.

Reimplemented from DtTaskControllerComponent.

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

static

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).

Returns: New instance of this class.

static void DtRoadMovementController::moveAlongCallback	(	DtSimMessage *	msg,
		void *	usr
	)

static

Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of rail-move-along tasks.

static void DtRoadMovementController::setConvoyFollowCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

static

static void DtRoadMovementController::settingsObjectConsumerCallback	(	const DtSettingsObject *	settingsObject,
		void *	usr
	)

static

Callback for changing which side of the road entity is driving on. Calls processSetting.

virtual const DtRoadConstants* DtRoadMovementController::roadConstants ( )

inlinevirtual

virtual void DtRoadMovementController::setRoadConstants ( const DtRoadConstants * rc )

inlinevirtual

A new set of road constants can be set in a class derived from DtRoadConstansts; then set the pointer here with the value MyRoadConstants::instance()

virtual DtRoadPathFunctions* DtRoadMovementController::pathFunctions ( )

inlinevirtual

virtual void DtRoadMovementController::setPathFunctions ( DtRoadPathFunctions * pf )

inlinevirtual

virtual DtRoadDrivingLogic* DtRoadMovementController::drivingLogic ( )

inlinevirtual

virtual void DtRoadMovementController::setDrivingLogic ( DtRoadDrivingLogic * dl )

inlinevirtual

virtual DtRoadObstructionFinder* DtRoadMovementController::obstructionFinder ( )

inlinevirtual

virtual void DtRoadMovementController::setObstructionFinder ( DtRoadObstructionFinder * of )

inlinevirtual

After creating a new obstFinder, call init() on it.

virtual DtRoadMovementUpdater* DtRoadMovementController::movementUpdater ( )

inlinevirtual

virtual void DtRoadMovementController::setMovementUpdater ( DtRoadMovementUpdater * u )

inlinevirtual

After creating a new updater, call init(), setEntityState(), and setPSR() on the new updater.

virtual DtRailMovementControllerPSR* DtRoadMovementController::psr ( )

inlinevirtual

virtual const DtMovingObjectParameters* DtRoadMovementController::objectParameters ( )

inlinevirtual

virtual const DtRoadMovementDescriptor* DtRoadMovementController::descriptor ( ) const

virtual

virtual bool DtRoadMovementController::drivingOnLeftEnabled ( ) const

virtual

virtual void DtRoadMovementController::setCurrentMovementState ( DtRailMovementState state )

virtual

virtual DtRailMovementState DtRoadMovementController::currentMovementState ( ) const

virtual

virtual DtRoadSegment* DtRoadMovementController::currentRoadSegment ( ) const

virtual

virtual void DtRoadMovementController::setCurrentRoadSegment ( DtRoadSegment * seg )

virtual

virtual double DtRoadMovementController::frontOffset ( ) const

virtual

Distance from vehicle center to front edge.

virtual void DtRoadMovementController::setFrontOffset ( const double o )

virtual

virtual double DtRoadMovementController::rearAxleOffset ( ) const

virtual

Distance from vehicle center to reference position at the rear axle.

In body coordinates, so negative if the rear axle is behind the entity origin.

virtual void DtRoadMovementController::setRearAxleOffset ( const double o )

virtual

virtual DtRailSegmentList* DtRoadMovementController::pathList ( )

virtual

Returns a pointer to our path list.

virtual const DtRailSegmentList* DtRoadMovementController::pathList ( ) const

virtual

virtual DtRoadSegmentPart DtRoadMovementController::roadSegmentPart ( ) const

virtual

Accessors for myRoadSegmentPart (entry curve, straight section, exit curve).

virtual void DtRoadMovementController::setRoadSegmentPart ( const DtRoadSegmentPart s )

virtual

virtual void DtRoadMovementController::updateTaskVisualizations ( )

virtual

Creates visualizations for the path along the road, for areas on the being searched for cars, and for cars identified to be obstacles.

If the notify level of the entity is set to Debug, point visualizations are also shown at the vertices of the original rail path (red) and for the final road path (blue).

Reimplemented from DtSimComponent.

virtual bool DtRoadMovementController::findPointOnTerrain	(	const DtVector &	worldLocation,
		DtVector &	worldLocationOnTerrain
	)

virtual

Finds the closest point on the terrain.

Returns true if data was available. Used in updatTaskVisualizations.

virtual std::vector<DtVector>& DtRoadMovementController::debugPoints ( )

inlinevirtual

Accessor for the individual points representing obstacle vehicles.

virtual std::vector<std::vector<DtVector> >& DtRoadMovementController::debugBoxes ( )

inlinevirtual

Accessor for the array of 4-point arrays representing areas where the controller is looking for obstacle vehicles.

virtual const double DtRoadMovementController::followSpeedFactor ( ) const

virtual

virtual double DtRoadMovementController::getDistanceBehindConvoyTarget ( const DtVrfObject * convoyTgt ) const

virtual

virtual const DtVrfObject* DtRoadMovementController::getObjectFromObstruction ( DtRailObstructionPtr & obs )

virtual

const DtRailSegmentList* DtRoadMovementController::path ( ) const

inline

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

protected

assignment operator

virtual bool DtRoadMovementController::createPSR ( )

protectedvirtual

virtual bool DtRoadMovementController::createUpdater ( )

protectedvirtual

This also calls init, setEntityState, and setPSR.

virtual bool DtRoadMovementController::createPathFunctions ( )

protectedvirtual

virtual bool DtRoadMovementController::createRoadObstructionFinder ( )

protectedvirtual

This function also calls init on the obstruction finder.

virtual bool DtRoadMovementController::createDrivingLogic ( )

protectedvirtual

virtual void DtRoadMovementController::processSetting ( const DtBoolSetting * setting )

protectedvirtual

Sets myDrivingOnLeftEnabled with value in setting.

virtual void DtRoadMovementController::processSetConvoyFollowCallback ( DtSimMessage * msg )

protectedvirtual

virtual void DtRoadMovementController::processMoveAlongTask ( DtSimMessage * msg )

protectedvirtual

Handle messages to move along a generated path.

These paths are generated by the DtRailPathPlanner in the DtMovementSelectorController.

virtual bool DtRoadMovementController::initializeCurrentState ( DtRailMoveAlongTask * task )

protectedvirtual

When loading up from a scenario we need to find out where we were on the route and initialize from our process state repository.

This is called in pre-first-tick-init.

virtual bool DtRoadMovementController::setUpRoute ( const DtRwRailSegmentList & path )

protectedvirtual

Set up our path from the rail move along task's path.

virtual int DtRoadMovementController::entryLanePosition	(	double	heading,
		unsigned int	numLanes
	)

protectedvirtual

Determines which lane we should be starting in.

Returns the default lane from descriptor->drivingLane. Ignores the parameters. Returns a 1-based lane number.

virtual void DtRoadMovementController::clearTask ( )

protectedvirtual

Override to clear route name and route state data stored in myProcessState.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtRoadMovementController::clearPath ( )

protectedvirtual

Clears the current path.

virtual void DtRoadMovementController::initiateLaneChange ( const int newLaneNum )

protectedvirtual

Update the controller state to initiate a lane change.

Sets currentLaneNumber, offsetFromLaneCenterline, laneChangeWidth, and postionAlongLane in the PSR.

virtual void DtRoadMovementController::checkPathEnd ( )

protectedvirtual

Check to see if the entity has reached the end of the path, and if so set the movement state to DtMovementStop.

Member Data Documentation

DtRailMovementControllerPSR* DtRoadMovementController::myProcessState

protected

const DtRoadMovementDescriptor* DtRoadMovementController::myRoadMoveDescriptor

protected

DtVrfMovingObjectStateRepository* DtRoadMovementController::myMovingStateRep

protected

const DtMovingObjectParameters* DtRoadMovementController::myObjectParams

protected

const DtRoadConstants* DtRoadMovementController::myRoadConstants

protected

The following members hold classes that define key functions of the driving controller.

By setting them to derived classes, these functions can be modified.Class to hold constants having to do with the assumed standard design of the road, e.g. a design vehicle length, width, and turn radius, and a design driver's typical accelerations.

DtRoadPathFunctions* DtRoadMovementController::myRoadPathFunctions

protected

Class to hold functions that process lists of road segments, i.e.

a road path. These functions create the path from a rail path, connect segments, remove short segments, compute the path curves between segments, etc.

DtRoadDrivingLogic* DtRoadMovementController::myDrivingLogic

protected

Class to hold functions defining the driving logic.

DtRoadObstructionFinder* DtRoadMovementController::myRoadObstructionFinder

protected

Class to hold functions that find obstructions (vehicles) along the entity's current lane and adjacent lanes.

DtRoadMovementUpdater* DtRoadMovementController::myRoadUpdater

protected

Class to hold functions that perform the kinematic update and compute the resulting position, orientation, and lane offset along the road path.

This class writes to the ports that connect to the Update Repository actuator, thus making this controller act as an actuator too.

DtRailSegmentList DtRoadMovementController::myPath

protected

This is the input path to the controller.

DtRoadSegmentList DtRoadMovementController::myRoadPath

protected

This path is computed, and includes the lane connections and the geometry of the paths connecting the lanes.

DtRoadSegment* DtRoadMovementController::myCurrentRoadSegment

protected

bool DtRoadMovementController::myDrivingOnLeft

protected

bool DtRoadMovementController::myNotInitialized

protected

bool DtRoadMovementController::myWarnedAboutMissingConvoyLeaderOnce

protected

bool DtRoadMovementController::myRoadAltitudesSet

protected

double DtRoadMovementController::myFrontOffset

protected

Distance from entity center to front.

This is computed as boundingVolume->halfLength + boundingVolume->latticeOffset.x

double DtRoadMovementController::myRearAxleOffset

protected

Offset in x from entity center to the center of the rear axle.

When turning, the turn circle center is on a line through the rear axle, and thus the tangent direction of circular motion points directly forward at the rear axle; thus this position of the vehicle is used as a reference position (vs. the entity origin) for determining entity orientation. The "other support" point is assumed to be on the rear axle, so this offset is computed as movingObjectParameters->otherSupport.x

DtRoadSegmentPart DtRoadMovementController::myRoadSegmentPart

protected

Keeps track of what part of the road segment the vehicle currently occupies (entry curve, straight section, exit curve).

std::vector<DtVector> DtRoadMovementController::myTaskVisPath

protected

For debug visualizationThe path of the road segments.

Holds world (geoc) coordinates. Computed once.

std::vector<DtVector> DtRoadMovementController::myCurrentTaskVisPath

protected

The currently displayed task vis path.

Only a portion of myTaskVisPath is shown at any given time to prevent very large task visualizations that can slow down the system.

std::map<DtRoadSegment*, unsigned> DtRoadMovementController::myRoadSegmentTaskVisMap

protected

Maps road segments to the index of the task vis path points that make up this segment.

unsigned DtRoadMovementController::myCurrentTaskVisPathPtIndex

protected

The current starting point index of the displayed task vis path.

bool DtRoadMovementController::myHaveCreatedDebugVis

protected

Several visualizations are created once and never updated.

They are created only if the entity notify level is set to Debug. Includes location of start of each original rail segment, the location of the path end, and the location of the start of each road segment.Indicates the debug visualizations have been created

std::vector<DtVector> DtRoadMovementController::myOriginalPath

protected

Holds the start (local) locations of the original rail path segments.

std::vector<DtVector> DtRoadMovementController::myObstacleLocations

protected

These visualizations are updated every tick.

Location of obstacle vehicles that constrain movement. In local coordinates; converted to world when updateTaskVis is called.

int DtRoadMovementController::myLastNumObstaclePoints

protected

The number of obstacles last tick.

std::vector<std::vector<DtVector> > DtRoadMovementController::myObstacleBoxes

protected

A set of polygons representing bounding volumes of the lanes to search for obstacle vehicles.

Holds world coordinates.

int DtRoadMovementController::myLastNumBoxes

protected

The number of boxes last tick.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfmodel/roadMovementController.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation