DtTaskControllerComponent Class Reference

End User Description: DtTaskControllerComponent is the base class for all controllers that respond to tasks. More...

Inheritance diagram for DtTaskControllerComponent:

Public Member Functions
	DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtTaskControllerComponent ()
	destructor
virtual DtString	type () const =0
	Returns a string identifies the class type of component.
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	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 (DtSimBaseRadio *radio)
	Calls registerTaskMsgCallbacks.
virtual void	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 bool	taskActive (int taskId) const =0
virtual bool	clearTopLevelTasks ()=0
	If this controller has any top level tasks (not subtasks), they are cleared.
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)=0
	Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)=0
	Clears any tasks of the specified type running in this controller.
virtual void	clearTaskById (int taskId)=0
	Clears any task of the specified ID running in this controller.
virtual std::list < DtTaskMessage * >	currentTaskMessages () const =0
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const =0
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 bool	init ()
	Calls setRadio()
virtual DtSimBaseRadio *	radio ()
	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 bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
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 DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static void	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.

Protected Types
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks.
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap

Protected Attributes
DtTaskCallbackMap	myTaskCallbackMap
std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList
	This list stores any DtTaskProcessorCallbackInfo allocated locally so that they can be deleted when the component is deleted.
Protected Attributes inherited from DtControllerComponent
DtSimBaseRadio *	myRadio
	Controller components can send messages.
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
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.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptor *	myComponentDescriptor
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtTaskControllerComponent ()
	default constructor; should not be called.
	DtTaskControllerComponent (const DtTaskControllerComponent &orig)
	copy constructor
const DtTaskControllerComponent &	operator= (const DtTaskControllerComponent &orig)
	assignment operator

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

End User Description: DtTaskControllerComponent is the base class for all controllers that respond to tasks.

Developer Description: DtTaskControllerComponent provides a base class for any controller that intends to register for DtSimTask messages. It implements the basic semantics necessary for the tasking model to work, including, taskNotify(), taskComplete(), skipTask(), and clearTask(). Controllers will want to derive from one of the subclasses of DtTaskControllerComponent, most likely DtSingleTaskControllerComponent.

Examples

• Subtasking Example

Member Typedef Documentation

typedef std::pair<DtTaskMessageCallbackFcn, void*> DtTaskControllerComponent::DtTaskCallbackMapPair

protected

This map stores callbacks that have been registered to processes various tasks.

The map is indexed by task type ID.

typedef std::map<DtSimTaskMessageType, DtTaskCallbackMapPair> DtTaskControllerComponent::DtTaskCallbackMap

protected

Constructor & Destructor Documentation

DtTaskControllerComponent::DtTaskControllerComponent	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	compDesc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString& name,

Parameters

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

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

virtual DtTaskControllerComponent::~DtTaskControllerComponent ( )

virtual

destructor

DtTaskControllerComponent::DtTaskControllerComponent ( )

private

default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtTaskControllerComponent::DtTaskControllerComponent ( const DtTaskControllerComponent &  orig )

private

copy constructor

Member Function Documentation

virtual DtString DtTaskControllerComponent::type ( ) const

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

Reimplemented from DtControllerComponent.

Implemented in DtTargetSelectionController, DtRailPathController, DtSurfaceEntityPilotController, DtHumanCollisionAvoidanceController, DtDisaggregatedMoveAlongController, DtGroundCollisionAvoidanceController, BHAVE::DtKynapseGroundPlatformController, DtFixedWingMoveAlongController, DtDIGuyController, DtGroundMovementChooserController, BHAVE::DtKynapseController, BHAVE::DtKynapseLifeformController, DtSurfaceEntityMoveAlongController, DtSurfaceEntityPatrolRouteController, DtBombController, DtFixedWingTakeoffController, DtFixedWingPilotController, DtGroundMoveToDestinationControllerComponent, BHAVE::DtBhaveMoveDirectionController, DtDisaggregatedMoveIntoFormationController, DtRetreatController, DtIndirectFireController, DtConvoyTaskController, DtAggregatedMoveToController, DtHumanMoveAlongController, DtOccupancyDirectorController, DtSurfaceEntityPatrolBetweenController, DtFixedWingFlyIntoController, DtLasingController, DtCruiseMissileLaunchController, DtDetonationController, DtDisaggregatedMoveToLocationController, DtFixedWingFlightCommandController, DtFixedWingLandingController, DtRotaryWingCollisionAvoidanceController, DtDisaggregatedPatrolAlongController, DtEmbarkationController, DtHumanMoveToController, DtRailMovementController, DtDisaggregatedEmbarkationController, DtFixedWingDefaultController, DtMissileControllerComponent, DtGroundMoveDirectionController, DtRotaryWingTurnToHeadingController, DtSurfaceEntityMoveToLocationController, DtAggregatedPatrolController, DtDisaggregatedPatrolBetweenController, DtHumanPatrolController, DtRotaryWingFlightCommandController, DtRotaryWingLandingController, DtDisaggregatedWaitController, DtFixedWingMoveToController, DtGroundMoveToControllerComponent, DtLimitExistenceController, DtMissileMoveToControllerComponent, DtRotaryWingPatrolBetweenController, DtTurnAndMoveController, DtGroundAutoControllerComponent, DtMissileTrackEntityController, DtSurfaceEntityFollowEntityController, DtCruiseMissileDefaultController, DtDisaggregatedMoveToController, DtFixedWingJoyFlightController, DtFixedWingPatrolRouteController, DtGroundPatrolRouteController, DtRotaryWingMoveAlongControllerComponent, DtRotaryWingPatrolRouteController, DtGroundFollowEntityController, DtGroundStopMovingControllerComponent, DtDisaggregatedTurnToHeadingController, DtGroundInterceptAndDestroyController, DtHumanFollowController, DtLasingMissileTrackController, DtReleaseBombController, DtSurfaceEntityMoveToController, DtDisaggregatedOccupancyDirectorController, DtFixedWingFollowEntityController, DtFixedWingPatrolBetweenController, DtGroundPatrolBetweenController, DtGroundTurnToControllerComponent, DtRotaryWingFollowEntityController, DtRotaryWingLoiterControllerComponent, DtRotaryWingWaitController, DtWaitController, DtRotaryWingTaskController, DtRotaryWingMoveToControllerComponent, DtCruiseMissileMoveAlongController, DtAggregatedMoveAlongController, DtHumanTurnToController, DtFixedWingEmbarkationController, DtGroundJoyMoveController, DtGroundMoveToLocationControllerComponent, DtHumanStopMovingController, DtLaunchExpendableResourceController, DtSendRadioMessageController, DtGroundMoveAlongControllerComponent, DtLaunchSmokeController, DtSimpleRadarWarningResponse, DtFixedWingMoveToLocationController, DtRotaryWingEmbarkationController, DtRotaryWingMoveToLocationControllerComponent, DtScriptMultiTaskController, and DtCompatibilityController.

virtual void DtTaskControllerComponent::postTick ( )

virtual

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

Calls decideToGiveUpTask() to determine if we should give up. If true, calls giveUpTask().

Reimplemented from DtSimComponent.

Reimplemented in DtMultiTaskControllerComponent, and DtSingleTaskControllerComponent.

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

virtual

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

Parameters

taskState

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

Returns

True if the controller can successfully start the task.

False if the controller is failing the task.

Reimplemented in DtRailPathController, DtRotaryWingFlightCommandController, DtMultiTaskControllerComponent, DtFixedWingFlightCommandController, DtSingleTaskControllerComponent, DtScriptMultiTaskController, and DtCompatibilityController.

virtual void DtTaskControllerComponent::taskNotify ( const DtSimTask &  task )

inlinevirtual

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.

Reimplemented from DtControllerComponent.

Reimplemented in DtSingleTaskControllerComponent.

virtual void DtTaskControllerComponent::setTasked ( bool  tasked )

virtual

The current tasked state of this controller.

True if this controller is currently executing a task.

virtual bool DtTaskControllerComponent::tasked ( ) const

virtual

The current tasked state of this controller.

True if this controller is currently executing a task.

virtual bool DtTaskControllerComponent::showCurrentTaskInGui ( ) const

virtual

Returns

True to show the current task as one of the "Current Tasks" in VRF GUI. The default implementation of this method is to return the value of tasked(). Some controllers may want to override this to show a task even after the task is complete.

Reimplemented in DtFixedWingFlightCommandController, and DtRotaryWingFlightCommandController.

virtual void DtTaskControllerComponent::setRadio ( DtSimBaseRadio *  radio )

virtual

Calls registerTaskMsgCallbacks.

Reimplemented from DtControllerComponent.

Reimplemented in DtLasingController, DtGroundJoyMoveController, and DtFixedWingJoyFlightController.

virtual void DtTaskControllerComponent::registerTaskMsgCallbacks ( )

virtual

Reimplemented in DtFixedWingMoveAlongController, DtFixedWingMoveToController, DtSurfaceEntityMoveAlongController, DtAggregatedMoveToController, DtDIGuyController, DtSurfaceEntityMoveToController, DtHumanMoveToController, DtDisaggregatedEmbarkationController, DtSurfaceEntityPatrolBetweenController, DtHumanCollisionAvoidanceController, DtIndirectFireController, DtLasingController, DtMissileTrackEntityController, DtMissileMoveToControllerComponent, DtTargetSelectionController, DtSurfaceEntityPatrolRouteController, DtDisaggregatedMoveAlongController, DtFixedWingDefaultController, DtFixedWingFollowEntityController, DtHumanMoveAlongController, DtRailPathController, DtRotaryWingPatrolBetweenController, DtRotaryWingPatrolRouteController, DtHumanFollowController, DtSurfaceEntityFollowEntityController, DtGroundMoveToDestinationControllerComponent, DtRotaryWingFollowEntityController, DtRailMovementController, DtDisaggregatedMoveToLocationController, BHAVE::DtKynapseController, DtGroundFollowEntityController, DtFixedWingTakeoffController, DtRotaryWingFlightCommandController, DtOccupancyDirectorController, DtRotaryWingCollisionAvoidanceController, DtGroundMoveToControllerComponent, DtGroundPatrolBetweenController, DtRotaryWingMoveToControllerComponent, DtSurfaceEntityMoveToLocationController, DtDisaggregatedMoveIntoFormationController, DtFixedWingLandingController, DtGroundInterceptAndDestroyController, DtGroundMovementChooserController, DtFixedWingPatrolBetweenController, DtGroundPatrolRouteController, DtAggregatedMoveAlongController, DtEmbarkationController, DtFixedWingPatrolRouteController, DtGroundMoveAlongControllerComponent, DtRotaryWingLandingController, DtConvoyTaskController, DtDisaggregatedPatrolAlongController, DtFixedWingFlyIntoController, DtRotaryWingTurnToHeadingController, DtRetreatController, BHAVE::DtBhaveMovementChooserController, DtGroundTurnToControllerComponent, DtRotaryWingWaitController, DtWaitController, DtGroundStopMovingControllerComponent, DtRotaryWingMoveAlongControllerComponent, DtAggregatedPatrolController, DtDisaggregatedWaitController, DtGroundMoveToLocationControllerComponent, DtHumanPatrolController, DtRotaryWingMoveToLocationControllerComponent, DtDisaggregatedPatrolBetweenController, DtTurnAndMoveController, DtHumanTurnToController, DtSendRadioMessageController, DtDisaggregatedMoveToController, DtFixedWingMoveToLocationController, DtHumanStopMovingController, DtDisaggregatedTurnToHeadingController, DtScriptMultiTaskController, DtLaunchExpendableResourceController, DtLaunchSmokeController, and DtCompatibilityController.

virtual void DtTaskControllerComponent::addTaskProcessorCallback ( const DtSimTaskMessageType &  taskType, DtTaskMessageCallbackFcn  fcn, void *  usr  )

virtual

Adds a new function for processing the specified task type.

Also causes this controller to register for this task type with the task manager.

Note

It is valid for the callback function to be NULL. This will cause the component to be set to the tasked mode by this task type, but no function will be called when the task message is received.

All these callbacks are removed when the component is destroyed, and there is no need to call removeTaskProcessorCallback from the component destructor.

DtTaskManager:addTaskProcessor will only accept one handler for each task type.

virtual void DtTaskControllerComponent::addTaskProcessorCallback ( const DtSimTaskMessageType &  taskType, DtMessageCallbackFcn  fcn, void *  usr  )

virtual

Deprecated form of addTaskProcessorCallback.

Callback signature does not include DtTaskState.

virtual void DtTaskControllerComponent::removeTaskProcessorCallback ( const DtSimTaskMessageType &  taskType, DtMessageCallbackFcn  fcn, void *  usr  )

virtual

Undoes anything done by addTaskProcessorCallback().

virtual void DtTaskControllerComponent::removeTaskProcessorCallback ( const DtSimTaskMessageType &  taskType, DtTaskMessageCallbackFcn  fcn, void *  usr  )

virtual

Deprecated form of removeTaskProcessorCallback.

Callback signature does not include DtTaskState.

static void DtTaskControllerComponent::deprecatedTaskProcessorCallbackAdapter ( DtSimMessage *  msg, void *  usr, DtSimTaskStatePtr  taskState  )

static

Task processor callback function that acts as an adapter for the deprecated forms of addTaskProcessorCallback and removeTaskProcessorCallback (the deprecated form is is version that.

virtual bool DtTaskControllerComponent::taskActive ( int  taskId ) const

pure virtual

Returns

True if a task of this ID is current active in this controller.

Implemented in DtSingleTaskControllerComponent, and DtMultiTaskControllerComponent.

virtual bool DtTaskControllerComponent::clearTopLevelTasks ( )

pure virtual

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

Returns

True if any tasks were cleared.

Implemented in DtSingleTaskControllerComponent, and DtMultiTaskControllerComponent.

virtual void DtTaskControllerComponent::clearConflictingTopLevelTasks ( const DtSimTaskMessageType &  conflictType )

pure virtual

Clears any top level tasks on this controller that conflict with the conflict task type.

The task manager is used to determine what tasks conflict.

Implemented in DtSingleTaskControllerComponent, and DtMultiTaskControllerComponent.

virtual void DtTaskControllerComponent::clearTasksByType ( const DtSimTaskMessageType &  taskType )

pure virtual

Clears any tasks of the specified type running in this controller.

Implemented in DtSingleTaskControllerComponent, and DtMultiTaskControllerComponent.

virtual void DtTaskControllerComponent::clearTaskById ( int  taskId )

pure virtual

Clears any task of the specified ID running in this controller.

Implemented in DtSingleTaskControllerComponent, and DtMultiTaskControllerComponent.

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

pure virtual

Returns

A list of pointers to task messages currently being run on this controller.

Implemented in DtSingleTaskControllerComponent, and DtMultiTaskControllerComponent.

virtual DtTaskWithTaskStateListPtr DtTaskControllerComponent::topLevelTasks ( ) const

pure virtual

Returns

A list of all top level tasks currently in this controller along with their task state, if any.

Implemented in DtSingleTaskControllerComponent, and DtMultiTaskControllerComponent.

virtual void DtTaskControllerComponent::enable ( )

virtual

Overridden to call registerTaskMsgCallbacks().

Reimplemented from DtSimComponent.

Reimplemented in DtEmbarkationController.

virtual void DtTaskControllerComponent::disable ( )

virtual

Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.

Reimplemented from DtSimComponent.

Reimplemented in DtEmbarkationController.

virtual void DtTaskControllerComponent::sendTaskCanceled ( DtTaskMessage *  taskMsg )

virtual

Sends the task canceled report for the specified message.

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

private

assignment operator

Member Data Documentation

DtTaskCallbackMap DtTaskControllerComponent::myTaskCallbackMap

protected

std::list<DtTaskProcessorCallbackInfo*> DtTaskControllerComponent::myTaskProcessorCallbackInfoList

protected

This list stores any DtTaskProcessorCallbackInfo allocated locally so that they can be deleted when the component is deleted.

---

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

• include/vrfobjcore/taskCtlrCmpnt.h