DtHumanMoveAlongController Class Reference

DtHumanMoveAlongController is a controller that models movement along a route for an individual human entity.

Developer Description: DtHumanMoveAlongController is a task controller that responds to DtVrfMoveAlongRouteTaskType tasks. It generates the necessary speed, facing direction, and movement direction control inputs to keep the entity moving along a route while executing a move-along <route> task. The controller will primarily work by issuing move to subtasks to the next point along the route in order to centralize moving functionality in the move to controller

Uses Descriptor Type: DtHumanMoveAlongControllerDescriptor

Inheritance diagram for DtHumanMoveAlongController:

Public Member Functions
	DtHumanMoveAlongController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtHumanMoveAlongController ()
virtual bool	init ()
virtual const char *	type () const
virtual void	preFirstTickInit ()
virtual void	tick ()
virtual DtSimTaskStatePtr	currentTaskState () const
virtual void	processRouteChanged (const DtSimObject *obj)
virtual void	registerTaskMsgCallbacks ()
virtual bool	setupRoute (bool routeHasChanged, bool resetVertex)
virtual bool	setupDestination ()
virtual void	stop ()
virtual bool	createPSR ()
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtSingleTaskControllerComponent ()
virtual void	postTick () override
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState) override
virtual void	taskNotify (const DtSimTask &task) override
virtual void	taskComplete (bool success=true)
virtual void	suspendTask ()
virtual int	sendSubtask (DtSimTask &task)
virtual void	clearSubtask (int subtaskId)
virtual void	addPendingSubtaskId (int subtaskId)
virtual bool	findPendingSubtaskId (int subtaskId)
virtual bool	isSubtasked () const
virtual void	removePendingSubtaskId (int subtaskId)
virtual void	removeAllPendingSubtaskIds ()
virtual std::vector< int >	currentPendingSubstaskIds () const
virtual DtSubtaskStatusEntry *	subtaskStatus (int subtaskId)
virtual void	clearCurrentTaskMessage ()
virtual DtTaskMessage *	currentTaskMessage () const
virtual bool	decideToGiveUpTask () const
virtual void	giveUpTask ()
virtual bool	taskActive (int taskId) const override
virtual bool	clearTopLevelTasks () override
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType) override
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType) override
virtual void	clearTaskById (int taskId) override
virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId) override
virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId) override
virtual std::list < DtTaskMessage * >	currentTaskMessages () const
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const override
virtual void	disable () override
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtTaskControllerComponent ()
virtual AcceptLevel	acceptTask (const DtTaskMessage &task)
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimRadio *radio) override
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
virtual void	enable () override
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
virtual bool	taskVisualizationsActive () const override
virtual void	setTasked (bool tasked)
virtual bool	tasked () const
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtControllerComponent ()
virtual bool	postAddComponentsInit () override
virtual DtSimRadio *	radio ()
virtual void	enableTaskTypes ()
virtual void	enableScritedTask (const DtString &scriptId)
virtual void	disableTaskTypes ()
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
virtual void	setParentSystem (DtComponentSystem *system)
DtComponentSystem *	parentSystem () const
virtual void	registerAttributeFunctions ()
virtual void	timedTick ()
virtual void	setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance)
virtual void	setupFirstTickTime ()
virtual void	setEntity (DtLocalObject *entity)
virtual DtSimComponent *	nextComponent ()
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	addInputPort (DtInputPort *port)
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
virtual DtList	inputPortList () const
virtual void	addOutputPort (DtOutputPort *port)
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
virtual DtList	outputPortList () const
virtual void	addInputPortGroup (DtInputPortGroup *group)
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
virtual DtList	inputPortGroupList () const
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
virtual DtList	outputPortGroupList () const
virtual int	priority () const
virtual void	setPriority (int priority)
double	dT () const
virtual void	setDT (double deltaT)
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual const DtSymbolString &	componentFullName () const
DtPhysicalWorld *	physicalWorld ()
const DtPhysicalWorld *	physicalWorld () const
const DtAttachedTerrain *	terrainAttachedTo () const
DtLocalObject *	entity ()
const DtLocalObject *	entity () const
DtSimulationServices *	simulationServices ()
const DtSimulationServices *	simulationServices () const
const Coordinate_System *	coordinateSystem () const
virtual void	isClutterChanged ()
virtual bool	taskVisualizationsEnabled () const
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
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 int	notifyLevel () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
VRF4API_METHOD const DtSimulationServices *	simManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static void	moveAlongCallback (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskStatePtr)
static DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
Static Public Member Functions inherited from DtTaskControllerComponent
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskState)
Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual void	processMoveAlong (const DtTaskMessage &msg, DtSimTaskStatePtr taskStatePtr)
virtual DtHumanMoveAlongPSR *	getPSR ()
virtual void	setDestination (const DtVector &localLocation)
virtual void	createMoveToPoint (const DtVector &localLocation)
virtual void	sendMoveToSubtask ()
virtual void	clearTask ()
virtual bool	getCurrentRouteSegment (DtVector &routeSegmentStart, DtVector &routeSegmentEnd) const
virtual void	cleanupMoveToPoint ()
virtual void	processTaskCompleteReport (DtSimMessage *msg)
virtual bool	passedDestination ()
virtual void	setupDestinationVector ()
virtual bool	atDestination () const
virtual double	distanceToDestination () const
virtual double	atDistance () const
virtual bool	createPorts ()
virtual void	processEstimatedTotCalculation ()
Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
virtual void	cleanupInactiveSubtaskStatus ()
Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
virtual void	suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)
virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	DtControllerComponent (const DtControllerComponent &orig)
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
virtual void	onRestore ()
virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)
virtual void	sendCapableSetsAndTasks ()
Protected Member Functions inherited from DtSimComponent
virtual void	setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)
virtual double	computeCurrentTime ()
bool	testInvariant () const
virtual bool	createPortGroups ()
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
virtual void	updateTaskVisualizations ()
virtual void	destroyTaskVisualizations ()
virtual void	destroyTaskVisualization (const DtString &name)
virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
double	calculateNextTaskVisTickTime () const
DtVrfObjectStateRepository *	localStateRepository ()
const DtVrfObjectStateRepository *	localStateRepository () const
DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)
template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)
const DtPropertyInterface *	cachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const
template<typename ValType >
bool	getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) const
void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	removeSimObjectPredicateCallback (const DtSimObject *, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	invokeSimObjectPredicateCallbacks ()
virtual void	clearPredicateCallbacks ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Member Functions
static DtReaderWriter *	provideNextRoutePointIndex (void *c)
static void	taskCompleteReportCallback (DtSimMessage *msg, void *usr)

Protected Attributes
DtHumanStateRepository *	myHumanStateRepository
DtHumanMoveAlongPSR *	myProcessState
DtHumanMoveAlongControllerDescriptor *	myHumanMoveAlongControllerDescriptor
DtVector	myWorldDestination
DtVector	myLocalDestination
DtVector	myDestinationVector
bool	myOverrideSpeed
double	myOverrideSpeedValue
DtVectorOutputPort *	myLastVertexLocationOutputPort
DtAnalogOutputPort *	myEtaForLastVertexOutputPort
DtVectorOutputPort *	myCurrentVertexLocationOutputPort
const double	DtEstimatedTotCalcInterval = 5.0
bool	myEstimatedTotCalcEnabled
double	myEstimatedTotValue
double	myEstimatedTotLastCalcTime
bool	myWarnedOnce
bool	myWaitingRoute
double	myMissingTimeStart
double	myRouteWaitTimeout
DtPlatformLocalObjectFacade	myPlatformLocalObjectFacade
Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap
std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList
bool	myTaskIsRunning
Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
bool	myTaskTypesEnabled
bool	myInitialized
Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity
DtComponentSystem *	mySystem
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myLastTickSimTime
std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager *	myPredicateCallbackManager
boost::signals2::scoped_connection	myIsClutterChangedConnection
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Private Member Functions
	DtHumanMoveAlongController ()
	DtHumanMoveAlongController (const DtHumanMoveAlongController &orig)
DtHumanMoveAlongController &	operator= (const DtHumanMoveAlongController &orig)

Additional Inherited Members
Public Types inherited from DtTaskControllerComponent
enum	AcceptLevel { AcceptLevel_Accept = 0, AcceptLevel_Partial = 1, AcceptLevel_Error = 2, AcceptLevel_NoAccept = 99 }
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
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

Constructor & Destructor Documentation

DtHumanMoveAlongController::DtHumanMoveAlongController ( )

private

Not Implemented.

DtHumanMoveAlongController::DtHumanMoveAlongController ( const DtHumanMoveAlongController &  orig )

private

Not Implemented.

DtHumanMoveAlongController::DtHumanMoveAlongController	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject 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 DtHumanMoveAlongController::~DtHumanMoveAlongController ( )

virtual

Destructor.

Member Function Documentation

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

private

Not Implemented.

virtual bool DtHumanMoveAlongController::init ( )

virtual

Init. Call immediately after construction.

Reimplemented from DtControllerComponent.

virtual const char* DtHumanMoveAlongController::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

DtHumanMoveAlongControllerType

Implements DtTaskControllerComponent.

virtual void DtHumanMoveAlongController::preFirstTickInit ( )

virtual

If tasked, looks up the route and if it already exists, registers routeChangeCalledback as a vertices changed callback and calls setupDestination. Otherwise, it adds objectAddedCb as an object added callback.

Reimplemented from DtSimComponent.

virtual void DtHumanMoveAlongController::tick ( )

virtual

If tasked, calls enableAllPorts on myCollisionAvoidancePortGroup, otherwise calls disableAllPorts. Ticks the parent class, DtSingleTaskControllerComponent. If tasked and dT > 0, it will activate myHumanMovementControlOutputPortGroup and myDestinationOutputPort. If setupDestination() returns true, it calls moveToDestination() and otherwise it prints warning, deactivates all the ports and calls taskComplete().

Reimplemented from DtSimComponent.

static void DtHumanMoveAlongController::moveAlongCallback ( DtSimMessage *  msg, void *  usr, DtSimTaskStatePtr  taskStatePtr  )

static

virtual DtSimTaskStatePtr DtHumanMoveAlongController::currentTaskState ( ) const

virtual

Returns

Current execution state of the task. At the base class level, returns 0. Derived classes that have tasks with DtTaskState (data associated with execution of the task) may return a new DtTaskState instance, filled out with the appropriate information about the current task execution state. Task controllers that do not need to return task state do not need to override this function.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtHumanMoveAlongController::processRouteChanged ( const DtSimObject *  obj )

virtual

Intended to be called only when the route has changed.

Note

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

virtual void DtHumanMoveAlongController::registerTaskMsgCallbacks ( )

virtual

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

Reimplemented from DtTaskControllerComponent.

virtual bool DtHumanMoveAlongController::setupRoute ( bool  routeHasChanged, bool  resetVertex  )

virtual

Look up the route by name, and set myRoute if found. Looks up the route in the Control Manager. If it does not find the route, it returns false. Otherwise, it sets the myRoute member to point to the object found. setupRoute() then checks the myRouteChanged flag. If myRouteChanged is true, it calls the route object’s resyncRouteState() member function to update the current DtRouteState. setupRoute() then returns true.

virtual bool DtHumanMoveAlongController::setupDestination ( )

virtual

Sets myControlPoint to the position of the route's current vertex. If setupRoute() returns false, setupControlPoint() calls taskComplete() and returns false. Otherwise, it sets the position of the myControlPoint member variable to the position of myRoute’s current vertex. If myRouteHasChanged is true, setupGoalVector() is called, and myRouteHasChanged is set to false. true is then returned.

virtual void DtHumanMoveAlongController::stop ( )

virtual

Overrides to advance to the next vertex rather then actually stop when a vertex is reached. Checks to see if the entity is currently moving to the last vertex in the route. If so, DtGroundMoveToControllerComponent::stop() is called. Otherwise, myProcessState->routeState()->next() is called, followed by setupControlPoint() and setupGoalVector().

static DtSimComponent* DtHumanMoveAlongController::creator ( const DtString &  name, DtLocalObject *  owner, DtSimulationServices *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

Static creator function for factory registration.

virtual bool DtHumanMoveAlongController::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 DtHumanMoveAlongController::processMoveAlong ( const DtTaskMessage &  msg, DtSimTaskStatePtr  taskStatePtr  )

protectedvirtual

static DtReaderWriter* DtHumanMoveAlongController::provideNextRoutePointIndex ( void *  c )

staticprotected

A callback to provide a controller attribute ("next-route-point-index")

virtual DtHumanMoveAlongPSR* DtHumanMoveAlongController::getPSR ( )

inlineprotectedvirtual

Gets the process state repository for purposes of providing attributes.

virtual void DtHumanMoveAlongController::setDestination ( const DtVector &  localLocation )

protectedvirtual

Sets the destination to move to, and, if need be, creates the temp move to point.

virtual void DtHumanMoveAlongController::createMoveToPoint ( const DtVector &  localLocation )

protectedvirtual

virtual void DtHumanMoveAlongController::sendMoveToSubtask ( )

protectedvirtual

Sends a move to subtask. When task complete report is received will move to the next point.

virtual void DtHumanMoveAlongController::clearTask ( )

protectedvirtual

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

Reimplemented from DtSingleTaskControllerComponent.

virtual bool DtHumanMoveAlongController::getCurrentRouteSegment ( DtVector &  routeSegmentStart, DtVector &  routeSegmentEnd  ) const

protectedvirtual

Returns

True if we are currently moving along a route segment, false otherwise.

Parameters

routeSegmentStart	Starting point of route segment in local coordinates.
routeSegmentEnd	End point of route segment in local coordinates.

virtual void DtHumanMoveAlongController::cleanupMoveToPoint ( )

protectedvirtual

Cleans up the temp move to waypoint.

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

staticprotected

virtual void DtHumanMoveAlongController::processTaskCompleteReport ( DtSimMessage *  msg )

protectedvirtual

virtual bool DtHumanMoveAlongController::passedDestination ( )

protectedvirtual

virtual void DtHumanMoveAlongController::setupDestinationVector ( )

protectedvirtual

virtual bool DtHumanMoveAlongController::atDestination ( ) const

protectedvirtual

virtual double DtHumanMoveAlongController::distanceToDestination ( ) const

protectedvirtual

virtual double DtHumanMoveAlongController::atDistance ( ) const

protectedvirtual

virtual bool DtHumanMoveAlongController::createPorts ( )

protectedvirtual

Called by init. Derived classes should override this method to create all their input/output ports and port groups.

Reimplemented from DtSimComponent.

virtual void DtHumanMoveAlongController::processEstimatedTotCalculation ( )

protectedvirtual

Member Data Documentation

DtHumanStateRepository* DtHumanMoveAlongController::myHumanStateRepository

protected

DtHumanMoveAlongPSR* DtHumanMoveAlongController::myProcessState

protected

Container for state data associated with this component. This state is saved and restored as part of a scenario (or checkpoint).

DtHumanMoveAlongControllerDescriptor* DtHumanMoveAlongController::myHumanMoveAlongControllerDescriptor

protected

DtVector DtHumanMoveAlongController::myWorldDestination

protected

DtVector DtHumanMoveAlongController::myLocalDestination

protected

DtVector DtHumanMoveAlongController::myDestinationVector

protected

bool DtHumanMoveAlongController::myOverrideSpeed

protected

double DtHumanMoveAlongController::myOverrideSpeedValue

protected

DtVectorOutputPort* DtHumanMoveAlongController::myLastVertexLocationOutputPort

protected

Output Port Name: last-vertex-location
Output Port Description: Specifies the last vertex location of the entity's route in geocentric coordinates. Output Port Range:
Output Group Parent:
.

DtAnalogOutputPort* DtHumanMoveAlongController::myEtaForLastVertexOutputPort

protected

Output Port Name: eta-for-last-vertex
Output Port Description: Specifies the eta for the last vertex of the entity's route in geocentric coordinates. Output Port Range:
Output Group Parent:
.

DtVectorOutputPort* DtHumanMoveAlongController::myCurrentVertexLocationOutputPort

protected

Output Port Name: current-vertex-location
Output Port Description: Specifies the current vertex location of the entity's route in local coordinates. Output Port Range:
Output Group Parent:
.

const double DtHumanMoveAlongController::DtEstimatedTotCalcInterval = 5.0

protected

Interval for estimated tot calculations.

bool DtHumanMoveAlongController::myEstimatedTotCalcEnabled

protected

enabled flag for the tot calculations

double DtHumanMoveAlongController::myEstimatedTotValue

protected

the tot value

double DtHumanMoveAlongController::myEstimatedTotLastCalcTime

protected

used for tot calculation intervals

bool DtHumanMoveAlongController::myWarnedOnce

protected

bool DtHumanMoveAlongController::myWaitingRoute

protected

double DtHumanMoveAlongController::myMissingTimeStart

protected

double DtHumanMoveAlongController::myRouteWaitTimeout

protected

DtPlatformLocalObjectFacade DtHumanMoveAlongController::myPlatformLocalObjectFacade

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfmodel/humanMoveAlongController.h