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 const char *	type () const =0
	Returns a string identifies the class type of component.
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 (DtSimRadio *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 DtSuspendedTaskInfo *	suspendTaskById (int taskId)=0
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 bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component.
virtual void	setTasked (bool tasked)
	The current tasked state of this controller.
virtual bool	tasked () const
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 DtSimRadio *	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	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
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	postTick ()
	This function is called immediately after tick() is called.
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 (std::string &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 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 DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () 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 DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component.
virtual bool	isEnabled ()
virtual void	setIsEnabled (bool yesNo)
virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	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 DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
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 char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () 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)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () 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	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 Member Functions
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 DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT.
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
virtual bool	createPorts ()
	Called by init.
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager.
virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick.
virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component.
virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name.
double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked.
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
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
DtSimRadio *	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.
bool	myIsThreadSafe
	Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false.
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
	List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed.
bool	myTickEveryFrame
	Flag indicating that tickPeriod is set to 0, and the component will tick every frame.
DtTaskVisualizationMap	myTaskVisualizations
	The visualization objects to be drawn for this component.
double	myNextTaskVisTickTime
	The next tick time for updating the task visualizations.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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.

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

Implements DtControllerComponent.

Implemented in DtTargetSelectionController, DtSurfaceEntityPilotController, DtRailPathController, DtRoadMovementController, DtDisaggregatedMoveAlongController, DtGroundCollisionAvoidanceController, DtHumanCollisionAvoidanceController, DtFixedWingMoveAlongController, DtDiGuyController, DtDynamicTerrainController, DtConvoyTaskController, DtFixedWingPilotController, DtSurfaceEntityPatrolRouteController, DtBombController, DtFixedWingTakeoffController, DtGroundMoveToDestinationControllerComponent, DtGroundMovementChooserController, DtMunitionLaunchController, DtSurfaceEntityFollowEntityController, DtRetreatController, DtDisaggregatedMoveIntoFormationController, DtCruiseMissileDefaultController, DtAggregatedMoveToController, DtOccupancyDirectorController, DtSurfaceEntityPatrolBetweenController, DtFixedWingFlyIntoController, DtHumanMoveToController, DtLasingController, DtDetonationController, DtDisaggregatedMoveToLocationController, DtFixedWingFlightCommandController, DtFixedWingLandingController, DtHumanMoveAlongController, DtRotaryWingCollisionAvoidanceController, DtSurfaceEntityMoveAlongController, DtDisaggregatedPatrolAlongController, DtEmbarkationController, DtIndirectFireController, DtRailMovementController, DtDisaggregatedEmbarkationController, DtFixedWingDefaultController, DtMissileControllerComponent, DtSurfaceEntityMoveToLocationController, DtCruiseMissileLaunchController, DtGroundMoveDirectionController, DtRotaryWingTurnToHeadingController, DtSubSurfaceDepthController, DtSurfaceEntityTurnMoveController, DtDisaggregatedPatrolBetweenController, DtHumanCoverPointController, DtHumanPatrolController, DtMissileMoveToControllerComponent, DtRotaryWingFlightCommandController, DtRotaryWingLandingController, DtRotaryWingMoveAlongControllerComponent, DtSurfaceEntityStopController, DtFixedWingMoveToController, DtGroundMoveToControllerComponent, DtHumanFollowController, DtLimitExistenceController, DtRotaryWingPatrolBetweenController, DtTurnAndMoveController, DtDisaggregatedWaitController, DtDynamicTerrainMunitionDamageController, DtGroundAutoControllerComponent, DtHumanCrosswalkController, DtHumanFleeController, DtMissileTrackEntityController, DtDisaggregatedMoveToController, DtFixedWingPatrolRouteController, DtGroundFollowEntityController, DtRotaryWingPatrolRouteController, DtAggregatedPatrolController, DtGroundStopMovingControllerComponent, DtLasingMissileTrackController, DtRotaryWingFollowEntityController, DtDisaggregatedTurnToHeadingController, DtDisaggregatedOccupancyDirectorController, DtFixedWingFollowEntityController, DtFixedWingPatrolBetweenController, DtGroundPatrolBetweenController, DtGroundPatrolRouteController, DtGroundTurnToControllerComponent, DtRotaryWingLoiterControllerComponent, DtRotaryWingWaitController, DtScriptedMovementController, DtWaitController, DtAggregatedMoveAlongController, DtMissileTargetController, DtReleaseBombController, DtRotaryWingMoveToControllerComponent, DtRotaryWingTaskController, DtAffectEngineeringObjectController, DtCruiseMissileMoveAlongController, DtHumanTurnToController, DtSurfaceEntityMoveToController, DtGroundMoveAlongControllerComponent, DtCreateEngineeringObjectController, DtSendRadioMessageController, DtDestroyEngineeringObjectController, DtFixedWingEmbarkationController, DtGroundMoveToLocationControllerComponent, DtLaunchExpendableResourceController, DtLaunchSmokeController, DtBreachObstacleController, DtHumanStopMovingController, DtFixedWingJoyFlightController, DtFixedWingMoveToLocationController, DtGroundJoyMoveController, DtSimTerrainVisualizationController, DtFascamController, DtRotaryWingEmbarkationController, DtRotaryWingMoveToLocationControllerComponent, DtSimpleRadarWarningResponse, DtEmbeddedEntitiesController, DtResupplyController, DtScenarioEventController, DtScriptMultiTaskController, and DtCompatibilityController.

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 DtMultiTaskControllerComponent, DtRotaryWingFlightCommandController, DtFixedWingFlightCommandController, DtSingleTaskControllerComponent, DtSimTerrainVisualizationController, and DtScriptMultiTaskController.

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

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 ( DtSimRadio *  radio )

virtual

Calls registerTaskMsgCallbacks.

Reimplemented from DtControllerComponent.

Reimplemented in DtLasingController.

virtual void DtTaskControllerComponent::registerTaskMsgCallbacks ( )

virtual

Reimplemented in DtSurfaceEntityMoveAlongController, DtFixedWingMoveAlongController, DtFixedWingMoveToController, DtDiGuyController, DtAggregatedMoveToController, DtHumanMoveToController, DtSurfaceEntityPatrolBetweenController, DtDisaggregatedEmbarkationController, DtHumanCollisionAvoidanceController, DtRoadMovementController, DtLasingController, DtMissileMoveToControllerComponent, DtMissileTrackEntityController, DtTargetSelectionController, DtRailPathController, DtSurfaceEntityPatrolRouteController, DtHumanFollowController, DtDisaggregatedMoveAlongController, DtFixedWingDefaultController, DtFixedWingFollowEntityController, DtRotaryWingFollowEntityController, DtGroundMoveToDestinationControllerComponent, DtRotaryWingPatrolBetweenController, DtSurfaceEntityFollowEntityController, DtSurfaceEntityTurnMoveController, DtRailMovementController, DtIndirectFireController, DtDisaggregatedMoveToLocationController, DtHumanMoveAlongController, DtRotaryWingPatrolRouteController, DtGroundFollowEntityController, DtCreateEngineeringObjectController, DtFixedWingTakeoffController, DtOccupancyDirectorController, DtRotaryWingFlightCommandController, DtSurfaceEntityMoveToLocationController, DtConvoyTaskController, DtHumanFleeController, DtRotaryWingCollisionAvoidanceController, DtScriptedMovementController, DtGroundMoveToControllerComponent, DtRotaryWingMoveToControllerComponent, DtFixedWingLandingController, DtDisaggregatedMoveIntoFormationController, DtHumanCoverPointController, DtSurfaceEntityStopController, DtCruiseMissileLaunchController, DtEmbarkationController, DtGroundPatrolBetweenController, DtFixedWingPatrolBetweenController, DtGroundMovementChooserController, DtRotaryWingLandingController, DtDisaggregatedPatrolAlongController, DtFixedWingFlyIntoController, DtRotaryWingTurnToHeadingController, DtRetreatController, DtDestroyEngineeringObjectController, DtGroundMoveAlongControllerComponent, DtGroundTurnToControllerComponent, DtSubSurfaceDepthController, DtWaitController, DtAggregatedMoveAlongController, DtGroundPatrolRouteController, DtRotaryWingWaitController, DtFixedWingPatrolRouteController, DtGroundStopMovingControllerComponent, DtGroundMoveToLocationControllerComponent, DtHumanPatrolController, DtRotaryWingMoveAlongControllerComponent, DtRotaryWingMoveToLocationControllerComponent, DtScriptMultiTaskController, DtDisaggregatedPatrolBetweenController, DtHumanTurnToController, DtAggregatedPatrolController, DtSendRadioMessageController, DtTurnAndMoveController, DtDisaggregatedMoveToController, DtFixedWingMoveToLocationController, DtHumanStopMovingController, DtDisaggregatedTurnToHeadingController, DtSurfaceEntityMoveToController, DtAffectEngineeringObjectController, DtEmbeddedEntitiesController, 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 DtMultiTaskControllerComponent, and DtSingleTaskControllerComponent.

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 DtMultiTaskControllerComponent, and DtSingleTaskControllerComponent.

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 DtMultiTaskControllerComponent, and DtSingleTaskControllerComponent.

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

pure virtual

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

Implemented in DtMultiTaskControllerComponent, and DtSingleTaskControllerComponent.

virtual void DtTaskControllerComponent::clearTaskById ( int  taskId )

pure virtual

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

Implemented in DtMultiTaskControllerComponent, and DtSingleTaskControllerComponent.

virtual DtSuspendedTaskInfo* DtTaskControllerComponent::suspendTaskById ( int  taskId )

pure virtual

Implemented in DtMultiTaskControllerComponent, and DtSingleTaskControllerComponent.

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 DtMultiTaskControllerComponent, and DtSingleTaskControllerComponent.

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 DtMultiTaskControllerComponent, and DtSingleTaskControllerComponent.

virtual void DtTaskControllerComponent::enable ( )

virtual

Overridden to call registerTaskMsgCallbacks().

Reimplemented from DtSimComponent.

Reimplemented in DtEmbarkationController, and DtWaitController.

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, and DtWaitController.

virtual void DtTaskControllerComponent::sendTaskCanceled ( DtTaskMessage *  taskMsg )

virtual

Sends the task canceled report for the specified message.

virtual bool DtTaskControllerComponent::taskVisualizationsActive ( ) const

virtual

Returns true if task visualizations are currently active for this component.

Default behavior for task controllers is to return true if the controller is currently tasked.

Reimplemented from DtSimComponent.

virtual void DtTaskControllerComponent::suspendSubtasksOfTask ( int  taskId, DtSuspendedTaskInfo *  suspendInfo  )

protectedvirtual

Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo.

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/taskControllerComponent.h