VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtGroundMovementChooserController Class Reference

This class controls the movement tasks for entities. More...

Inheritance diagram for DtGroundMovementChooserController:
Inheritance graph
[legend]

Public Member Functions

 DtGroundMovementChooserController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=NULL, DtReaderWriterRegistry *parentRegistry=NULL)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtGroundMovementChooserController ()
virtual bool init ()
 Calls setRadio()
virtual bool createPSR ()
virtual DtString type () const
 Returns a string identifies the class type of component.
virtual void registerTaskMsgCallbacks ()
 Overridden to register interest in user-task and task-completed radio messages.
virtual bool postAddComponentsInit ()
 Override to find the current active system being used for movement.
virtual void processMovementTask (DtSimMessage *msg, DtSimTaskStatePtr taskStatePtr)
 Starts the received task.
virtual void processTaskCompleteReport (DtSimMessage *msg)
 Listens for task completed reports from the subtasks that are started by this task, and issues the next subtask, or completes the task as necessary when the reports arrive.
virtual void suspendTask (int taskId)
 This method is called when the specified running task is being suspended.
virtual DtSimTaskStatePtr currentTaskState (int taskId) const
- Public Member Functions inherited from DtMultiTaskControllerComponent
 DtMultiTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtMultiTaskControllerComponent ()
 destructor
virtual void postTick ()
 Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
 Called by the task manager when this controller should start executing the specified task.
virtual void taskComplete (int taskId, bool success)
 This indicates that the specified task is complete.
virtual void clearTask (int taskId)
 Clears the specified task out, includes any related subtasks.
virtual DtTaskMessagecurrentTaskMessage (int taskId)
virtual int sendSubtask (DtSimTask &task, int taskId)
 Sends subtask to ourself.
virtual int sendTask (DtSimTask &task, const DtString &receiver, int taskId, bool actAsSubtask=true, bool useRadio=false)
 Sends a task to another entity, and adds the task to the local subtask status list for tracking its completion.
virtual void clearSubtask (int subtaskId, int taskId)
 Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void addPendingSubtaskId (int subtaskId, int taskId)
 Adds given subtask Id to list of pending subtasks.
virtual bool findPendingSubtaskId (int subtaskId, int taskId)
 Checks to see if given subtaskId exists in our list of pending subtasks.
virtual void removePendingSubtaskId (int subtaskId, int taskId)
 Removes pending subtask from list of subtasks for this component.
virtual DtSubtaskStatusEntrysubtaskStatus (int subtaskId, int taskId)
virtual void removeAllPendingSubtaskIds (int taskId)
 Clear all pending subtasks from our list of subtasks for taskId.
virtual std::vector< intcurrentPendingSubstaskIds (int taskId) const
 Returns the list of all currently pending subtask ids for this controller.
virtual bool decideToGiveUpTask () const
 The DtMultiTaskControllerComponent does not current support decideToGiveUp.
virtual void giveUpTask ()
 Called when controller is tasked and decideToGiveUp() returns true.
virtual bool taskActive (int taskId) const
 
virtual bool clearTopLevelTasks ()
 If this controller has any top level tasks (not subtasks), they are cleared.
virtual void clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
 Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void clearTasksByType (const DtSimTaskMessageType &taskType)
 Clears any tasks of the specified type running in this controller.
virtual void clearTaskById (int taskId)
 Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfosuspendTaskById (int taskId)
virtual std::list
< DtTaskMessage * > 
currentTaskMessages () const
 
virtual DtTaskWithTaskStateListPtr topLevelTasks () const
 
virtual void setScriptTickPeriod (const DtString &scriptId, double period)
 If supported, and this is a scripted task controller, set the period to tick the script.
- Public Member Functions inherited from DtTaskControllerComponent
 DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtTaskControllerComponent ()
 destructor
virtual void taskNotify (const DtSimTask &task)
 This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual bool showCurrentTaskInGui () const
virtual void setRadio (DtSimRadio *radio)
 Calls registerTaskMsgCallbacks.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Adds a new function for processing the specified task type.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Deprecated form of addTaskProcessorCallback.
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Undoes anything done by addTaskProcessorCallback().
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Deprecated form of removeTaskProcessorCallback.
virtual void enable ()
 Overridden to call registerTaskMsgCallbacks().
virtual void disable ()
 Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void sendTaskCanceled (DtTaskMessage *taskMsg)
 Sends the task canceled report for the specified message.
virtual void setTasked (bool tasked)
 The current tasked state of this controller.
virtual bool tasked () const
 The current tasked state of this controller.
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtControllerComponent ()
 destructor
virtual DtSimRadioradio ()
 The radio this component is listening to.
virtual void clearTask ()
 Called when you want to clear out this component's task state.
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void preprocess ()
 Perform parallel preprocessing prior to tick and similar computations.
virtual void parallelTick ()
 called in parallel
virtual void preFirstTickInit ()
 called from preprocess if appropriate
virtual void tick ()
 This gives the thread of control to the component.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
virtual void setEntity (DtVrfObject *entity)
 The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
virtual void setListItem (DtListItem *item)
 Used by DtComponentList.
virtual DtListItem * listItem ()
virtual void putData (FILE *fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr getData (DtlObjPtr args, const 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.
virtual void addInputPort (DtInputPort *port)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPort (DtInputPort *port)
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name.
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component.
virtual void addOutputPort (DtOutputPort *port)
 Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void removeOutputPort (DtOutputPort *port)
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name.
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component.
virtual void addInputPortGroup (DtInputPortGroup *group)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name.
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component.
virtual void addOutputPortGroup (DtOutputPortGroup *group)
 Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name.
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component.
virtual int priority () const
 Return the current connection priority for this component.
virtual void setPriority (int priority)
 Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void setDT (double deltaT)
 Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
 The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const
DtComponentDescriptor
componentDescriptor () const
virtual bool tickWhileDestroyed () const
 If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManagerpsrManager ()
virtual DtString componentFullName () const
virtual DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorldphysicalWorld () const
virtual DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrainterrainAttachedTo () const
virtual DtVrfObjectentity ()
 Gets the entity.
virtual const DtVrfObjectentity () const
virtual DtSimManagersimManager ()
 Gets the sim manager.
virtual const DtSimManagersimManager () const
virtual const Coordinate_System * coordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System * coordinateSystem ()
virtual
DtVrfObjectStateRepository
localStateRepository ()
 Gets the local state repository.
virtual const
DtVrfObjectStateRepository
localStateRepository () const
virtual bool isEnabled ()
 Is this component enabled or not.
virtual void setIsEnabled (bool yesNo)
 Is this component enabled or not.
virtual DtOutputStreamobjectConsoleDebug () const
virtual DtOutputStreamobjectConsoleVerbose () const
virtual DtOutputStreamobjectConsoleInfo () const
virtual DtOutputStreamobjectConsoleWarn () const
virtual DtOutputStreamobjectConsoleError () const
virtual DtSimResourceManagerresourceManager ()
virtual const
DtSimResourceManager
resourceManager () const
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op.
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op.
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op.
virtual void writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () const
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
std::string debugText () const
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated.
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename.
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid.
virtual bool fromXmlFile (const DtFilename &)
 Restires object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
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.
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.
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference.

Static Public Member Functions

static void movementTaskCallback (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskStatePtr)
 Callback for the various movement tasks this controller registers.
static void taskCompleteReportCallback (DtSimMessage *msg, void *usr)
 Callback for DtTaskCompletedReport.
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions

virtual void processMovementTask (DtFollowEntityTask *taskMsg, int taskId)
virtual void processMovementTask (DtMoveAlongTask *taskMsg, int taskId)
virtual void processMovementTask (DtRailRouteTask *taskMsg, int taskId)
 Checks if we have rails enabled and if so tasks the route information and sends it via a rail path task to the rail path controller which will handle moving the entity via move to location task to the start of the route using the regular default movement system then upon reaching the route start the entity will transistion onto rails and use a rail move along task to move along the route.
virtual void processMovementTask (DtRailMoveAlongTask *taskMsg, int taskId)
 Checks if the current active movement system is the rail system if not sends out a switch set.
virtual void processMovementTask (DtTaskMessage *taskMsg)
virtual void processMovementTask (DtMoveToTask *taskMsg, int taskId)
virtual void processMovementTask (DtMoveToLocationTask *taskMsg, int taskId)
virtual void processMovementTask (DtTurnToHeadingTask *taskMsg, int taskId)
virtual void processMovementTask (DtScriptedTaskTask *taskMsg, int taskId)
virtual void processMovementTask (DtPatrolRouteTask *taskMsg, int taskId)
virtual void processMovementTask (DtPatrolTwoPointsTask *taskMsg, int taskId)
- Protected Member Functions inherited from DtMultiTaskControllerComponent
virtual void addCurrentTaskMessage (const DtTaskMessage *taskMessage)
 Adds a new task message to the list of current tasks for this controller.
virtual void clearCurrentTaskMessage (int taskId)
 Removes task with the specified task ID from the list of current tasks for this controller.
virtual void clearPendingSubtasks (int taskId)
 Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void clearSubtasksByType (const DtSimTaskMessageType &taskType, int taskId)
 Clear all subtasks of a given type.
virtual int taskIdWhichStartedSubtask (int subtaskId)
- 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.
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT, common between preprocess and timedTick.
bool testInvariant () const
virtual bool createPortGroups ()
 Called by init.
virtual bool createPorts ()
 Called by init.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()
- Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Protected Attributes

DtGroundMovementChooserPSRmyProcessState

Private Member Functions

 DtGroundMovementChooserController ()
 Not Implemented.
 DtGroundMovementChooserController (const DtGroundMovementChooserController &orig)
 Not Implemented.
DtGroundMovementChooserControlleroperator= (const DtGroundMovementChooserController &orig)
 Not Implemented.

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.
typedef std::map
< DtSimTaskMessageType,
DtTaskCallbackMapPair
DtTaskCallbackMap
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

This class controls the movement tasks for entities.

It contains a heuristic to determine how the movement task should be executed.

This class is implemented as part of the effort to support the ability to execute a movement task by VRF or BHAVE. The tasks sent from the GUI are now registered by this controller. Once it analyzes certain conditions, it sends a subtask with the actual task to execute: a VRF task. Uses Descriptor Type: DtComponentDescriptor

Constructor & Destructor Documentation

DtGroundMovementChooserController::DtGroundMovementChooserController ( )
private

Not Implemented.

DtGroundMovementChooserController::DtGroundMovementChooserController ( const DtGroundMovementChooserController orig)
private

Not Implemented.

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

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtGroundMovementChooserController::~DtGroundMovementChooserController ( )
virtual

Member Function Documentation

DtGroundMovementChooserController& DtGroundMovementChooserController::operator= ( const DtGroundMovementChooserController orig)
private

Not Implemented.

virtual bool DtGroundMovementChooserController::init ( )
virtual
virtual bool DtGroundMovementChooserController::createPSR ( )
virtual
virtual DtString DtGroundMovementChooserController::type ( ) const
virtual

Returns a string identifies the class type of component.

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

Returns
DtGroundMovementChooserControllerType.

Implements DtTaskControllerComponent.

virtual void DtGroundMovementChooserController::registerTaskMsgCallbacks ( )
virtual

Overridden to register interest in user-task and task-completed radio messages.

Reimplemented from DtTaskControllerComponent.

Reimplemented in BHAVE::DtBhaveMovementChooserController.

virtual bool DtGroundMovementChooserController::postAddComponentsInit ( )
virtual

Override to find the current active system being used for movement.

Reimplemented from DtSimComponent.

static void DtGroundMovementChooserController::movementTaskCallback ( DtSimMessage msg,
void *  usr,
DtSimTaskStatePtr  taskStatePtr 
)
static

Callback for the various movement tasks this controller registers.

Calls the virtual processMovementTask().

virtual void DtGroundMovementChooserController::processMovementTask ( DtSimMessage msg,
DtSimTaskStatePtr  taskStatePtr 
)
virtual

Starts the received task.

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

Callback for DtTaskCompletedReport.

Calls the virtual processTaskCompleteReport().

virtual void DtGroundMovementChooserController::processTaskCompleteReport ( DtSimMessage msg)
virtual

Listens for task completed reports from the subtasks that are started by this task, and issues the next subtask, or completes the task as necessary when the reports arrive.

Reimplemented in BHAVE::DtBhaveMovementChooserController.

virtual void DtGroundMovementChooserController::suspendTask ( int  taskId)
virtual

This method is called when the specified running task is being suspended.

The default implementation clears all subtasks that were started by the specified taskId.

Reimplemented from DtMultiTaskControllerComponent.

virtual DtSimTaskStatePtr DtGroundMovementChooserController::currentTaskState ( int  taskId) 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 DtMultiTaskControllerComponent.

virtual void DtGroundMovementChooserController::processMovementTask ( DtFollowEntityTask taskMsg,
int  taskId 
)
protectedvirtual
virtual void DtGroundMovementChooserController::processMovementTask ( DtMoveAlongTask taskMsg,
int  taskId 
)
protectedvirtual
virtual void DtGroundMovementChooserController::processMovementTask ( DtRailRouteTask taskMsg,
int  taskId 
)
protectedvirtual

Checks if we have rails enabled and if so tasks the route information and sends it via a rail path task to the rail path controller which will handle moving the entity via move to location task to the start of the route using the regular default movement system then upon reaching the route start the entity will transistion onto rails and use a rail move along task to move along the route.

virtual void DtGroundMovementChooserController::processMovementTask ( DtRailMoveAlongTask taskMsg,
int  taskId 
)
protectedvirtual

Checks if the current active movement system is the rail system if not sends out a switch set.

If it is just sends a DtVrfRailMoveAlongTask

virtual void DtGroundMovementChooserController::processMovementTask ( DtTaskMessage taskMsg)
protectedvirtual
virtual void DtGroundMovementChooserController::processMovementTask ( DtMoveToTask taskMsg,
int  taskId 
)
protectedvirtual
virtual void DtGroundMovementChooserController::processMovementTask ( DtMoveToLocationTask taskMsg,
int  taskId 
)
protectedvirtual
virtual void DtGroundMovementChooserController::processMovementTask ( DtTurnToHeadingTask taskMsg,
int  taskId 
)
protectedvirtual
virtual void DtGroundMovementChooserController::processMovementTask ( DtScriptedTaskTask taskMsg,
int  taskId 
)
protectedvirtual
virtual void DtGroundMovementChooserController::processMovementTask ( DtPatrolRouteTask taskMsg,
int  taskId 
)
protectedvirtual
virtual void DtGroundMovementChooserController::processMovementTask ( DtPatrolTwoPointsTask taskMsg,
int  taskId 
)
protectedvirtual
static DtSimComponent* DtGroundMovementChooserController::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns
New instance of this class.

Reimplemented in BHAVE::DtBhaveMovementChooserController.

Member Data Documentation

DtGroundMovementChooserPSR* DtGroundMovementChooserController::myProcessState
protected

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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)