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

Inheritance diagram for DtTaskControllerComponent:

[legend]

Public Types
enum	AcceptLevel { AcceptLevel_Accept = 0, AcceptLevel_Partial = 1, AcceptLevel_Error = 2, AcceptLevel_NoAccept = 99 }

Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Public Member Functions
	DtTaskControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor compDesc=nullptr, DtReaderWriterRegistry parentRegistry=nullptr)

virtual	~DtTaskControllerComponent () override

virtual const char *	type () const override=0

virtual AcceptLevel	acceptTask (const DtTaskMessage &task)

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

virtual void	taskNotify (const DtSimTask &task) override

virtual bool	showCurrentTaskInGui () const

virtual void	setRadio (DtSimRadio *radio) override

virtual void	registerTaskMsgCallbacks ()

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

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

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

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

virtual bool	taskActive (int taskId) const =0

virtual bool	clearTopLevelTasks ()=0

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)=0

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)=0

virtual void	clearTaskById (int taskId)=0

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)=0

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId)=0

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

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const =0

virtual void	enable () override

virtual void	disable () override

virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)

virtual bool	taskVisualizationsActive () const override


virtual void	setTasked (bool tasked)

virtual bool	tasked () const

Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtControllerComponent () override

virtual bool	init () override

virtual bool	postAddComponentsInit () override

virtual DtSimRadio *	radio ()

virtual void	clearTask ()

virtual void	enableTaskTypes ()

virtual void	enableScriptedTask (const DtString &scriptId)

virtual void	disableTaskTypes ()

Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent () override

virtual void	setParentSystem (DtComponentSystem *system)

DtComponentSystem *	parentSystem () const

virtual void	registerAttributeFunctions ()

virtual void	preFirstTickInit ()

virtual void	tick ()

virtual void	postTick ()

virtual void	timedTick ()

virtual void	setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance)

virtual void	setupFirstTickTime ()

virtual void	setEntity (DtLocalObject *entity)

virtual DtSimComponent *	nextComponent ()

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)

virtual DtListItem *	listItem ()

virtual void	putData (std::string &fp, int indentLevel=0) override

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

virtual void	addInputPort (DtInputPort *port)

virtual void	removeInputPort (DtInputPort *port)

virtual DtInputPort *	lookupInputPort (const DtString &portName)

virtual DtList	inputPortList () const

virtual void	addOutputPort (DtOutputPort *port)

virtual void	removeOutputPort (DtOutputPort *port)

virtual DtOutputPort *	lookupOutputPort (const DtString &portName)

virtual DtList	outputPortList () const

virtual void	addInputPortGroup (DtInputPortGroup *group)

virtual void	removeInputPortGroup (DtInputPortGroup *group)

virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)

virtual DtList	inputPortGroupList () const

virtual void	addOutputPortGroup (DtOutputPortGroup *group)

virtual void	removeOutputPortGroup (DtOutputPortGroup *group)

virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)

virtual DtList	outputPortGroupList () const

virtual int	priority () const

virtual void	setPriority (int priority)

double	dT () const

virtual void	setDT (double deltaT)

virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)

virtual const DtComponentDescriptor *	componentDescriptor () const

virtual bool	tickWhileDestroyed () const

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()

const DtPhysicalWorld *	physicalWorld () const

const DtAttachedTerrain *	terrainAttachedTo () const

DtLocalObject *	entity ()

const DtLocalObject *	entity () const

DtSimulationServices *	simulationServices ()

const DtSimulationServices *	simulationServices () const

const Coordinate_System *	coordinateSystem () const

virtual void	isClutterChanged ()

virtual bool	taskVisualizationsEnabled () const

makVrf::DtTaskVisualizationMap &	taskVisualizations ()

virtual void	updateImgui ()

virtual bool	debugActive () const

virtual bool	isEnabled ()

virtual void	setIsEnabled (bool yesNo)

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

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

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

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

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

virtual int	notifyLevel () const

virtual DtSimResourceManager &	resourceManager ()

virtual const DtSimResourceManager &	resourceManager () const

VRF4API_METHOD const DtSimulationServices *	simManager () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

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

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

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

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage msg, void usr, DtSimTaskStatePtr taskState)

Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()

static void	setFactory (DtSimComponentFactory *factory)

static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject owner, DtSimulationServices simManager, DtComponentSystem parentSystem, DtComponentDescriptor desc=0, DtReaderWriterRegistry *parentRegistry=0)

static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)

static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Types
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair

typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap

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

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

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

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

Protected Member Functions
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)

virtual void	suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)

virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const

Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()

	DtControllerComponent (const DtControllerComponent &orig)

const DtControllerComponent &	operator= (const DtControllerComponent &orig)

virtual void	onRestore () override

virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)

virtual void	sendCapableSetsAndTasks ()

Protected Member Functions inherited from DtSimComponent
virtual void	setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)

virtual double	computeCurrentTime ()

bool	testInvariant () const

virtual bool	createPortGroups ()

virtual bool	createPorts ()

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)

virtual void	updateTaskVisualizations ()

virtual void	destroyTaskVisualizations ()

virtual void	destroyTaskVisualization (const DtString &name)

virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)

virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)

virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)

virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)

double	calculateNextTaskVisTickTime () const

DtVrfObjectStateRepository *	localStateRepository ()

const DtVrfObjectStateRepository *	localStateRepository () const

DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)

template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)

const DtPropertyInterface *	cachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const

template<typename ValType >
bool	getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) const

void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)

void	removeSimObjectPredicateCallback (const DtSimObject , DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void userData=0)

void	invokeSimObjectPredicateCallbacks ()

virtual void	clearPredicateCallbacks ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtTaskCallbackMap	myTaskCallbackMap

std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList

bool	myTaskIsRunning

Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio

bool	myTaskTypesEnabled

bool	myInitialized

Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity

DtComponentSystem *	mySystem

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myLastTickSimTime

std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic

double	myDT

bool	myIsEnabled

bool	myFirstTick

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs

makVrf::DtTaskVisualizationMap	myTaskVisualizations

double	myNextTaskVisTickTime

DtSymbolString	myFullComponentName

DtSimulationServices *	mySimServices

DtPredicateCallbackManager *	myPredicateCallbackManager

boost::signals2::scoped_connection	myIsClutterChangedConnection

bool	myLocalDebug

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Private Member Functions
	DtTaskControllerComponent ()

	DtTaskControllerComponent (const DtTaskControllerComponent &orig)

const DtTaskControllerComponent &	operator= (const DtTaskControllerComponent &orig)

Additional Inherited Members
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

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

Member Enumeration Documentation

enum DtTaskControllerComponent::AcceptLevel

Levels that a task controller can accept a task it has registered for.

See Also: DtTaskControllerComponent::acceptTask()

Enumerator
AcceptLevel_Accept
AcceptLevel_Partial	Indicates controller is fully able to execute task.
AcceptLevel_Error	Indicates controller is able to partially execute task. (e.g. release fewer than total desired resources)
AcceptLevel_NoAccept	Indicates controller cannot execute task, but can provide a useful error on why it cannot. (e.g. out of resources)

Constructor & Destructor Documentation

DtTaskControllerComponent::DtTaskControllerComponent	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simServices,
		DtComponentDescriptor *	compDesc = `nullptr`,
		DtReaderWriterRegistry *	parentRegistry = `nullptr`
	)

Parameters

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

virtual DtTaskControllerComponent::~DtTaskControllerComponent ( )

overridevirtual

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

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

virtual AcceptLevel DtTaskControllerComponent::acceptTask ( const DtTaskMessage & task )

virtual

Called by the task manager when this controller is being considered to execute a task. Only tasks which already match types that this controller has registered for will be passed. This is used for the case where multiple task controllers have registered for the same task type. This gives the controller a chance to look at the parameters of the task and to reject the execution of the task based on parameters. Controllers can return any of the AcceptLevel levels. The task manager will choose a controller with the lowest AcceptLevel to execute, but will not choose any controller that returns AcceptLevel_NoAccept. Default implementation returns AcceptLevel_Accept. Override this to check parameters and conditionally return a different AccpetLevel.

Reimplemented in DtIndirectFireWeaponController, DtCruiseMissileLaunchController, DtLauncherController, DtLaserGuidedLauncherController, DtBallisticGunController, and DtLaunchExpendableResourceController.

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

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

inlineoverridevirtual

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

overridevirtual

Calls registerTaskMsgCallbacks.

Reimplemented from DtControllerComponent.

Reimplemented in DtLasingController.

virtual void DtTaskControllerComponent::registerTaskMsgCallbacks ( )

virtual

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.

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 DtSuspendedTaskInfo* DtTaskControllerComponent::suspendTaskById ( int taskId )

pure virtual

Implemented in DtSingleTaskControllerComponent, and DtMultiTaskControllerComponent.

virtual DtSuspendedTaskInfo* DtTaskControllerComponent::suspendSubtaskById	(	int	taskId,
		int	subtaskId
	)

pure virtual

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

overridevirtual

Overridden to call registerTaskMsgCallbacks().

Reimplemented from DtControllerComponent.

Reimplemented in DtEmbarkationController, DtIndirectFireWeaponController, DtWeaponController, DtBallisticGunController, DtWaitController, DtProvideIndirectFireController, and DtHoldController.

virtual void DtTaskControllerComponent::disable ( )

overridevirtual

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

Reimplemented from DtSimComponent.

Reimplemented in DtEmbarkationController, DtIndirectFireWeaponController, DtSingleTaskControllerComponent, DtWeaponController, DtBallisticGunController, DtLasingController, DtWaitController, DtProvideIndirectFireController, DtHoldController, DtWeaponManagementController, and DtAggregateMountedMovementRelayController.

virtual void DtTaskControllerComponent::sendTaskCanceled ( DtTaskMessage * taskMsg )

virtual

Sends the task canceled report for the specified message.

virtual bool DtTaskControllerComponent::taskVisualizationsActive ( ) const

overridevirtual

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.

Reimplemented in DtParachuteController, DtDynamicTerrainVehicleTrackController, DtHumanUseDoorController, DtAircraftClutterAreaController, and DtShipClutterAreaController.

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.

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

protectedvirtual

Suspends a single running subtasks of taskId, and puts the suspend info into the provided suspendInfo.

virtual DtSimTaskMessageType DtTaskControllerComponent::remapScriptId ( const DtSimTaskMessageType & ) const

protectedvirtual

In case this is aliased, return the actual script id.

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.

bool DtTaskControllerComponent::myTaskIsRunning

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjcore/taskControllerComponent.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation