This class provides a base class for all controllers that are capable of executing a DtSimTask, and execute multiple DtSimTask instances at a time. This is a special case for some controllers. Typically, task controllers will be derived from DtSingleTaskControllerComponent.

Inheritance diagram for DtMultiTaskControllerComponent:

[legend]

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

virtual	~DtMultiTaskControllerComponent () override

virtual bool	init () override

virtual void	postTick () override

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

virtual void	taskComplete (int taskId, bool success)

virtual void	clearTask (int taskId)

virtual void	suspendTask (int taskId)

virtual DtTaskMessage *	currentTaskMessage (int taskId)

virtual DtSimTaskStatePtr	currentTaskState (int taskId) const

virtual int	sendSubtask (DtSimTask &task, int taskId)

virtual int	sendTask (DtSimTask &task, const DtUUID &receiver, int parentTaskId, bool actAsSubtask=true, bool useRadio=false)

virtual void	clearSubtask (int subtaskId, int parentTaskId)

virtual void	addPendingSubtaskId (int subtaskId, int taskId)

virtual bool	findPendingSubtaskId (int subtaskId, int taskId)

virtual bool	isSubtasked () const

virtual void	removePendingSubtaskId (int subtaskId, int taskId)

virtual DtSubtaskStatusEntry *	subtaskStatus (int subtaskId, int taskId)

virtual void	removeAllPendingSubtaskIds (int taskId)

virtual std::vector< int >	currentPendingSubstaskIds (int taskId) const

virtual bool	decideToGiveUpTask () const

virtual void	giveUpTask ()

virtual bool	taskActive (int taskId) const override

virtual bool	clearTopLevelTasks () override

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType) override

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType) override

virtual void	clearTaskById (int taskId) override

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId) override

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId) override

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

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const override

virtual void	setScriptTickPeriod (const DtString &scriptId, double period)

virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (int taskId, const DtString &name)

virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (int taskId, const DtString &name)

virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (int taskId, const DtString &name)

virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (int taskId, const DtString &name)

virtual void	destroyTaskVisualization (int taskId, const DtString &name)

virtual void	destroyTaskVisualizations (int taskId)

virtual void	updateImgui () override

Public Member Functions inherited from DtTaskControllerComponent
	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 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 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	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	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 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)

Protected Member Functions
virtual void	addCurrentTaskMessage (const DtTaskMessage *taskMessage)

virtual void	clearCurrentTaskMessage (int taskId)

virtual void	clearPendingSubtasks (int taskId)

virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType, int taskId)

virtual int	taskIdWhichStartedSubtask (int subtaskId)

virtual void	cleanupInactiveSubtaskStatus (int taskId)

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

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

virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const

Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()

	DtControllerComponent (const DtControllerComponent &orig)

const DtControllerComponent &	operator= (const DtControllerComponent &orig)

virtual void	onRestore () 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)

Additional Inherited Members
Public Types inherited from DtTaskControllerComponent
enum	AcceptLevel { AcceptLevel_Accept = 0, AcceptLevel_Partial = 1, AcceptLevel_Error = 2, AcceptLevel_NoAccept = 99 }

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

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

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

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

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

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

static void	setFactory (DtSimComponentFactory *factory)

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

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

static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)

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

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

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

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

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

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

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

typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap

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

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

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

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

Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap

std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList

bool	myTaskIsRunning

Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio

bool	myTaskTypesEnabled

bool	myInitialized

Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity

DtComponentSystem *	mySystem

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myLastTickSimTime

std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic

double	myDT

bool	myIsEnabled

bool	myFirstTick

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs

makVrf::DtTaskVisualizationMap	myTaskVisualizations

double	myNextTaskVisTickTime

DtSymbolString	myFullComponentName

DtSimulationServices *	mySimServices

DtPredicateCallbackManager *	myPredicateCallbackManager

boost::signals2::scoped_connection	myIsClutterChangedConnection

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

Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

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

Parameters

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

virtual DtMultiTaskControllerComponent::~DtMultiTaskControllerComponent ( )

overridevirtual

destructor

Member Function Documentation

virtual bool DtMultiTaskControllerComponent::init ( )

overridevirtual

Calls setRadio()

Reimplemented from DtControllerComponent.

Reimplemented in DtGroundMovementChooserController, DtAggregateMountedMovementRelayController, DtEmbeddedEntitiesController, DtScriptMultiTaskController, and DtCompatibilityController.

virtual void DtMultiTaskControllerComponent::postTick ( )

overridevirtual

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.

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

overridevirtual

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 from DtTaskControllerComponent.

Reimplemented in DtScriptMultiTaskController.

virtual void DtMultiTaskControllerComponent::taskComplete	(	int	taskId,
		bool	success
	)

virtual

This indicates that the specified task is complete. This will kick off a series of events in the task manager to clean up this task and notify anyone relevant of the state change. To indicate that the task has failed (and is being abandoned) call this method with success set to false.

Reimplemented in DtScriptMultiTaskController.

virtual void DtMultiTaskControllerComponent::clearTask ( int taskId )

virtual

Clears the specified task out, includes any related subtasks.

Reimplemented in DtEmbeddedEntitiesController, and DtScriptMultiTaskController.

virtual void DtMultiTaskControllerComponent::suspendTask ( int taskId )

virtual

This method is called when the specified running task is being suspended. The default implementation clears all subtasks that were started by the specified taskId.

Reimplemented in DtGroundMovementChooserController, and DtScriptMultiTaskController.

virtual DtTaskMessage* DtMultiTaskControllerComponent::currentTaskMessage ( int taskId )

virtual

Returns: Pointer to the current task message with the specified id.

virtual DtSimTaskStatePtr DtMultiTaskControllerComponent::currentTaskState ( int taskId ) const

virtual

Returns: Current execution state of the task of the specified task ID. This is called when a task is being suspended. The returned state object will be passed into beginProcessingTask() when the task is resumed. At the base class level, returns a null pointer. Derived classes that have tasks with DtTaskState (data associated with execution of the task) may return a new DtTaskState instance, filled out with the appropriate information about the current task execution state. Task controllers that do not need to return task state do not need to override this function.

Reimplemented in DtGroundMovementChooserController, and DtScriptMultiTaskController.

virtual int DtMultiTaskControllerComponent::sendSubtask	(	DtSimTask &	task,
		int	taskId
	)

virtual

Sends subtask to ourself. Creates task message and sends task to ourself through radio. Adds subtask Id to list of pending subtasks. Returns subtask Id.

virtual int DtMultiTaskControllerComponent::sendTask	(	DtSimTask &	task,
		const DtUUID &	receiver,
		int	parentTaskId,
		bool	actAsSubtask = `true`,
		bool	useRadio = `false`
	)

virtual

Sends a task to another entity, and adds the task to the local subtask status list for tracking its completion. If actAsSubtask is false then the task will not be added as a subtask and the returned id will be -1.

Returns: A task ID value that can be used to check the status of this task on the local entity. This value is passed as the task tracking number to the other entity, and will not necessarily be used as the actual task ID on that entity.

virtual void DtMultiTaskControllerComponent::clearSubtask	(	int	subtaskId,
		int	parentTaskId
	)

virtual

Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()). Also removed the subtask ID from the pending subtask ID list.

Parameters

taskId Is the task ID of the task which owns this subtask.

virtual void DtMultiTaskControllerComponent::addPendingSubtaskId	(	int	subtaskId,
		int	taskId
	)

virtual

Adds given subtask Id to list of pending subtasks. This is done automatically by sendSubtask (user should not typically have to call this directly).

virtual bool DtMultiTaskControllerComponent::findPendingSubtaskId	(	int	subtaskId,
		int	taskId
	)

virtual

Checks to see if given subtaskId exists in our list of pending subtasks. Typically checked from within a task complete callback, to determine if given report corresponds to the specific subtask we issued.

virtual bool DtMultiTaskControllerComponent::isSubtasked ( ) const

virtual

Returns true if this controller is currently subtasked.

virtual void DtMultiTaskControllerComponent::removePendingSubtaskId	(	int	subtaskId,
		int	taskId
	)

virtual

Removes pending subtask from list of subtasks for this component. Users will typically call this from within a task complete callback, upon receipt of the specific subtasking task complete report they were waiting for.

virtual DtSubtaskStatusEntry* DtMultiTaskControllerComponent::subtaskStatus	(	int	subtaskId,
		int	taskId
	)

virtual

Returns: A pointer to the DtSubtaskStatusEntry item for the specified subtask of the task given by taskId.

virtual void DtMultiTaskControllerComponent::removeAllPendingSubtaskIds ( int taskId )

virtual

Clear all pending subtasks from our list of subtasks for taskId. Users should not typically have to call this. This also clears any tasks that were started on other entities using sendTask().

virtual std::vector<int> DtMultiTaskControllerComponent::currentPendingSubstaskIds ( int taskId ) const

virtual

Returns the list of all currently pending subtask ids for this controller.

virtual bool DtMultiTaskControllerComponent::decideToGiveUpTask ( ) const

virtual

The DtMultiTaskControllerComponent does not current support decideToGiveUp. This function always returns false.

virtual void DtMultiTaskControllerComponent::giveUpTask ( )

virtual

Called when controller is tasked and decideToGiveUp() returns true. Base class implementation calls clearTask(). Derived classes may override this function to perform some specific handling.

virtual bool DtMultiTaskControllerComponent::taskActive ( int taskId ) const

overridevirtual

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

Implements DtTaskControllerComponent.

virtual bool DtMultiTaskControllerComponent::clearTopLevelTasks ( )

overridevirtual

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

Returns: True if any tasks were cleared.

Implements DtTaskControllerComponent.

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

overridevirtual

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.

Implements DtTaskControllerComponent.

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

overridevirtual

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

Implements DtTaskControllerComponent.

virtual void DtMultiTaskControllerComponent::clearTaskById ( int taskId )

overridevirtual

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

Implements DtTaskControllerComponent.

virtual DtSuspendedTaskInfo* DtMultiTaskControllerComponent::suspendTaskById ( int taskId )

overridevirtual

Implements DtTaskControllerComponent.

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

overridevirtual

Implements DtTaskControllerComponent.

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

overridevirtual

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

Implements DtTaskControllerComponent.

virtual DtTaskWithTaskStateListPtr DtMultiTaskControllerComponent::topLevelTasks ( ) const

overridevirtual

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

Implements DtTaskControllerComponent.

virtual void DtMultiTaskControllerComponent::setScriptTickPeriod	(	const DtString &	scriptId,
		double	period
	)

virtual

If supported, and this is a scripted task controller, set the period to tick the script. Default is no-op.

virtual makVrf::DtPointTaskVisualizationPtr DtMultiTaskControllerComponent::pointTaskVisualization	(	int	taskId,
		const DtString &	name
	)

virtual

Finds an existing or creates a new point task visualization with the given name.

Reimplemented in DtScriptMultiTaskController.

virtual makVrf::DtLineTaskVisualizationPtr DtMultiTaskControllerComponent::lineTaskVisualization	(	int	taskId,
		const DtString &	name
	)

virtual

Finds an existing or creates a new line task visualization with the given name.

Reimplemented in DtScriptMultiTaskController.

virtual makVrf::DtAreaTaskVisualizationPtr DtMultiTaskControllerComponent::areaTaskVisualization	(	int	taskId,
		const DtString &	name
	)

virtual

Finds an existing or creates a new area task visualization with the given name.

Reimplemented in DtScriptMultiTaskController.

virtual makVrf::DtTextTaskVisualizationPtr DtMultiTaskControllerComponent::textTaskVisualization	(	int	taskId,
		const DtString &	name
	)

virtual

Finds an existing or creates a new text task visualization with the given name.

Reimplemented in DtScriptMultiTaskController.

virtual void DtMultiTaskControllerComponent::destroyTaskVisualization	(	int	taskId,
		const DtString &	name
	)

virtual

Destroys an existing task visualization.

virtual void DtMultiTaskControllerComponent::destroyTaskVisualizations ( int taskId )

virtual

Destroys all existing task visualizations for the specified task.

virtual void DtMultiTaskControllerComponent::updateImgui ( )

overridevirtual

For subclasses to implement Currently just prints the current type.

Reimplemented from DtSimComponent.

virtual void DtMultiTaskControllerComponent::addCurrentTaskMessage ( const DtTaskMessage * taskMessage )

protectedvirtual

Adds a new task message to the list of current tasks for this controller.

virtual void DtMultiTaskControllerComponent::clearCurrentTaskMessage ( int taskId )

protectedvirtual

Removes task with the specified task ID from the list of current tasks for this controller.

virtual void DtMultiTaskControllerComponent::clearPendingSubtasks ( int taskId )

protectedvirtual

Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.

virtual void DtMultiTaskControllerComponent::clearSubtasksByType	(	const DtSimTaskMessageType &	taskType,
		int	taskId
	)

protectedvirtual

Clear all subtasks of a given type. Should not normally be called (call clearSubtask(int subtaskId) to clear a given subtask instead). Provided as a utility function as an aid to backwards compatibility.

virtual int DtMultiTaskControllerComponent::taskIdWhichStartedSubtask ( int subtaskId )

protectedvirtual

Returns: The task Id of the task which started the subtask with the specified id.

virtual void DtMultiTaskControllerComponent::cleanupInactiveSubtaskStatus ( int taskId )

protectedvirtual

Clears out subtask status entries that are either completed or canceled which were started by the specified taskId. This typically is not necessary to call. Cleanup happens automatically when the parent task ends.

Reimplemented in DtScriptMultiTaskController.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation