Inheritance diagram for DtScriptMultiTaskController:

Public Member Functions
	DtScriptMultiTaskController (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc, DtReaderWriterRegistry parentRegistry)
virtual	~DtScriptMultiTaskController ()
virtual const char *	type () const
	Returns a string identifies the class type of component.
virtual bool	init ()
	Calls setRadio()
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 bool	tickWhileDestroyed () const
	Overridden to tick after being destroyed.
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task.
virtual void	clearTask (int taskId)
	Clears the specified task out, includes any related subtasks.
virtual void	taskComplete (int taskId, bool success)
	This indicates that the specified task is complete.
virtual void	suspendTask (int taskId)
	This method is called when the specified running task is being suspended.
virtual DtSimTaskStatePtr	currentTaskState (int taskId) const
	Overridden to return a task state based on the script data that is currently running.
virtual bool	createPSR ()
virtual void	registerScriptTaskCallbacks ()
virtual void	unregisterScriptTaskCallbacks ()
virtual void	registerTaskMsgCallbacks ()
virtual void	unregisterTaskMsgCallbacks ()
virtual bool	isTypeTaskable (const DtSimTaskMessageType &taskType) const
	Adds/removes/checks a specific task message callback.
virtual void	addTypeTaskable (const DtSimTaskMessageType &taskType, const DtString &system="")
virtual void	removeTypeTaskable (const DtSimTaskMessageType &taskType)
virtual void	addRunnableTaskType (const DtSimTaskMessageType &taskType, const DtString &system)
	Adds/removes a taskType that is runnable by this script controller instance, even if the task type is not configured for this entity type.
virtual void	removeRunnableTaskType (const DtSimTaskMessageType &taskType)
virtual void	sweepMarkedForDeletion (bool clearFromPsr=true)
	Clears the myMarkedForDeletionList and also removes their entry from the PSR if the flag is set to true, otherwise it leaves it in the PSR.
virtual void	setScriptTickPeriod (const DtString &scriptId, double period)
	Schedule to tick the particular script at the current tick rate.
virtual void	addAdditionalReactiveTask (const DtSimTaskMessageType &)
	Since all reactive tasks are enabled through here, add additional tasks via the script enable controller.
virtual int	nextBackgroundProcessId () const
	Returns an id for the next background processing task.

virtual void	scriptSetTickPeriod (const DtString &scriptId, double period)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual void	scriptSetTickWhilePaused (const DtString &scriptId, bool enable)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual void	scriptSetRespondToNewSensorContacts (const DtString &scriptId, bool respond)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual void	scriptTaskComplete (int taskId, bool success)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual int	scriptSendSubtask (DtSimTask &task, int parentTaskId)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual std::vector< int >	scriptPendingSubstaskIds (int taskId)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual DtSubtaskStatusEntry *	scriptSubtaskStatus (int subtaskId, int parentTaskId)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual void	scriptClearSubtask (int subtaskId, int parentTaskId)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual void	setCheckpointModeUseCheckpointState (const DtString &scriptId, bool)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual bool	checkpointModeUseCheckpointState (const DtString &scriptId) const
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual int	askUserQuestion (const DtString &scriptId, const DtTranslatableStream &title, const DtTranslatableStream &message, const std::vector< DtTranslatableStream > &options, int displayFlag)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual int	statusOfUserQuestion (int questionId)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual void	cancelUserQuestion (int questionId)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual int	scriptSendTask (DtSimTask &task, const DtString &entityName, int parentTaskId, bool actAsSubtask=true)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual void	notifyScriptTaskError (const DtString &scriptId, int taskId)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual DtPointTaskVisualizationPtr	pointTaskVisualization (int taskId, const DtString &visName)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual DtLineTaskVisualizationPtr	lineTaskVisualization (int taskId, const DtString &visName)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (int taskId, const DtString &visName)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual DtTextTaskVisualizationPtr	textTaskVisualization (int taskId, const DtString &visName)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
virtual void	deleteTaskVisualization (int taskId, const DtString &visName)
	If actAsSubtask is false the task will not be added to the subtask list such that when the parent task ends, the sended task will continue.
Public Member Functions inherited from DtMultiTaskControllerComponent
	DtMultiTaskControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString& name,
virtual	~DtMultiTaskControllerComponent ()
	destructor
virtual void	postTick ()
	Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual DtTaskMessage *	currentTaskMessage (int taskId)
virtual int	sendSubtask (DtSimTask &task, int taskId)
	Sends subtask to ourself.
virtual int	sendTask (DtSimTask &task, const DtUUID &receiver, int taskId, bool actAsSubtask=true, bool useRadio=false)
	Sends a task to another entity, and adds the task to the local subtask status list for tracking its completion.
virtual void	clearSubtask (int subtaskId, int taskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void	addPendingSubtaskId (int subtaskId, int taskId)
	Adds given subtask Id to list of pending subtasks.
virtual bool	findPendingSubtaskId (int subtaskId, int taskId)
	Checks to see if given subtaskId exists in our list of pending subtasks.
virtual bool	isSubtasked () const
	Returns true if this controller is currently subtasked.
virtual void	removePendingSubtaskId (int subtaskId, int taskId)
	Removes pending subtask from list of subtasks for this component.
virtual DtSubtaskStatusEntry *	subtaskStatus (int subtaskId, int taskId)
virtual void	removeAllPendingSubtaskIds (int taskId)
	Clear all pending subtasks from our list of subtasks for taskId.
virtual std::vector< int >	currentPendingSubstaskIds (int taskId) const
	Returns the list of all currently pending subtask ids for this controller.
virtual bool	decideToGiveUpTask () const
	The DtMultiTaskControllerComponent does not current support decideToGiveUp.
virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true.
virtual bool	taskActive (int taskId) const

virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared.
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller.
virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)
virtual std::list < DtTaskMessage * >	currentTaskMessages () const

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const

virtual void	destroyTaskVisualization (int taskId, const DtString &name)
	Destroys an existing task visualization.
virtual void	destroyTaskVisualizations (int taskId)
	Destroys all existing task visualizations for the specified task.
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString& name,
virtual	~DtTaskControllerComponent ()
	destructor
virtual void	taskNotify (const DtSimTask &task)
	This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimRadio *radio)
	Calls registerTaskMsgCallbacks.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback.
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback().
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback.
virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks().
virtual void	disable ()
	Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message.
DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this controller.
virtual void	setTasked (bool tasked)
	The current tasked state of this controller.
virtual bool	tasked () const
	The current tasked state of this controller.
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual 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	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
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 bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
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)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const 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 ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
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.
Public Member Functions inherited from DtScriptTaskControllerInterface
virtual	~DtScriptTaskControllerInterface ()

Static Public Member Functions
static void	scriptUpdatedCallback (const DtScriptedTaskManagerCallbackInfo &info, void *usr)
static void	scenarioSaveCallback (void *usr)
static DtSimComponent *	creator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc, DtReaderWriterRegistry parentRegistry)

Protected Member Functions
	DtScriptMultiTaskController (const DtScriptMultiTaskController &other)
DtScriptMultiTaskController &	operator= (const DtScriptMultiTaskController &other)
virtual void	processScriptUpdatedCallback (const DtScriptedTaskManagerCallbackInfo &info)
virtual void	processScenarioSaveCallback ()
virtual void	propagateScriptIdChange (const DtString &oldId, const DtString &newId)
virtual bool	isForMyEntityType (const DtScriptedTaskMetaData &metaData)
virtual void	processMetaDataChange (const DtScriptedTaskManagerCallbackInfo &info)
virtual void	restartScriptInterfaceByType (const DtSimTaskMessageType &taskType)
virtual void	clearAndRestoreTasks ()
	Clears out all tasks and re-registers for tasks for this entity.
virtual void	processUserQuestionOperation (DtSimMessage *)
virtual void	sendOffOutstandingQuestionFor (const DtString &scriptId)
virtual bool	backgroundProcessAvailable () const
	Returns true unless this is a global plan, in which case background processes are not available.
Protected Member Functions inherited from DtMultiTaskControllerComponent
virtual void	addCurrentTaskMessage (const DtTaskMessage *taskMessage)
	Adds a new task message to the list of current tasks for this controller.
virtual void	clearCurrentTaskMessage (int taskId)
	Removes task with the specified task ID from the list of current tasks for this controller.
virtual void	clearPendingSubtasks (int taskId)
	Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType, int taskId)
	Clear all subtasks of a given type.
virtual int	taskIdWhichStartedSubtask (int subtaskId)
Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo.
virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick.
virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations.
double	calculateNextTaskVisTickTime () const
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.
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 Member Functions inherited from DtScriptTaskControllerInterface
	DtScriptTaskControllerInterface ()
	DtScriptTaskControllerInterface (const DtScriptTaskControllerInterface &other)
DtScriptTaskControllerInterface &	operator= (const DtScriptTaskControllerInterface &other)

Static Protected Member Functions
static void	userQuestionOperationCallback (DtSimMessage msg, void usrData)

Protected Attributes
std::map< DtSimTaskMessageType, int >	myAvailableScripts
std::map< DtSimTaskMessageType, int >	myBackgroundProcesses
std::map< int, boost::shared_ptr < DtScriptInterface > >	myCurrentTaskMap
	Negative task ids are background processes.
std::list< int >	myMarkedForDeletionList
std::list< DtString >	myRespondToNewSensorContactList
	List of scripts that will respond to new sensor contacts by scriptId.
DtScriptMultiTaskControllerPSR *	myProcessState
bool	myAreCallbacksRegistered
std::map< DtSimTaskMessageType, DtString >	myAdditionalRunnableTaskTypes
	This is a list of script IDs that will be run by this component, even if they script is not marked as available for this entity type.
DtForceType	myCurrentForceType
bool	myIsDestroyed
bool	myQueueTasksToBeAdded
	Prior to preFirstTickInit, any tasks added should be queued for later addition.
std::map< DtSimTaskMessageType, DtString >	myTasksToBeAdded
std::set< DtSimTaskMessageType >	myAdditionalReactiveTasks
virtual void	processNewSensorContact (DtVrfObject *object)
	Callback for new sensor contacts.
static void	newSensorContactCallback (DtVrfObject object, void usr)
	Callback for new sensor contacts.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks.
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Constructor & Destructor Documentation

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

virtual DtScriptMultiTaskController::~DtScriptMultiTaskController ( )

virtual

DtScriptMultiTaskController::DtScriptMultiTaskController ( const DtScriptMultiTaskController & other )

protected

Member Function Documentation

virtual const char* DtScriptMultiTaskController::type ( ) const

virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Implements DtTaskControllerComponent.

virtual bool DtScriptMultiTaskController::init ( )

virtual

Calls setRadio()

Reimplemented from DtMultiTaskControllerComponent.

virtual void DtScriptMultiTaskController::preFirstTickInit ( )

virtual

This function can be overridden to initialize a component before it is ticked for the first time.

The implementation for this function is empty. It is called by timedTick if myFirstTick is true.

Reimplemented from DtSimComponent.

virtual void DtScriptMultiTaskController::tick ( )

virtual

This gives the thread of control to the component.

The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

virtual bool DtScriptMultiTaskController::tickWhileDestroyed ( ) const

virtual

Overridden to tick after being destroyed.

Reimplemented from DtSimComponent.

virtual bool DtScriptMultiTaskController::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 from DtMultiTaskControllerComponent.

virtual void DtScriptMultiTaskController::clearTask ( int taskId )

virtual

Clears the specified task out, includes any related subtasks.

Reimplemented from DtMultiTaskControllerComponent.

virtual void DtScriptMultiTaskController::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 from DtMultiTaskControllerComponent.

virtual void DtScriptMultiTaskController::suspendTask ( int taskId )

virtual

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

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

Reimplemented from DtMultiTaskControllerComponent.

virtual DtSimTaskStatePtr DtScriptMultiTaskController::currentTaskState ( int taskId ) const

virtual

Overridden to return a task state based on the script data that is currently running.

Reimplemented from DtMultiTaskControllerComponent.

virtual bool DtScriptMultiTaskController::createPSR ( )

virtual

virtual void DtScriptMultiTaskController::registerScriptTaskCallbacks ( )

virtual

virtual void DtScriptMultiTaskController::unregisterScriptTaskCallbacks ( )

virtual

virtual void DtScriptMultiTaskController::registerTaskMsgCallbacks ( )

virtual

Reimplemented from DtTaskControllerComponent.

virtual void DtScriptMultiTaskController::unregisterTaskMsgCallbacks ( )

virtual

virtual bool DtScriptMultiTaskController::isTypeTaskable ( const DtSimTaskMessageType & taskType ) const

virtual

Adds/removes/checks a specific task message callback.

Not to be used if you are iterating over the myAvailableScripts member variable. If the task is a background task, the add function creates and interface and sets the interface setTaskStarting flag to true; unless it already has saved state in the PSR (i.e., during scenario load), in which case the state is loaded and the Starting flag is set false.

virtual void DtScriptMultiTaskController::addTypeTaskable	(	const DtSimTaskMessageType &	taskType,
		const DtString &	system = `""`
	)

virtual

virtual void DtScriptMultiTaskController::removeTypeTaskable ( const DtSimTaskMessageType & taskType )

virtual

virtual void DtScriptMultiTaskController::addRunnableTaskType	(	const DtSimTaskMessageType &	taskType,
		const DtString &	system
	)

virtual

Adds/removes a taskType that is runnable by this script controller instance, even if the task type is not configured for this entity type.

The system is the system that is used for the controller that could hold additional script variables. This is important in the case of multiple script-enable-controller.

virtual void DtScriptMultiTaskController::removeRunnableTaskType ( const DtSimTaskMessageType & taskType )

virtual

virtual void DtScriptMultiTaskController::sweepMarkedForDeletion ( bool clearFromPsr = true )

virtual

Clears the myMarkedForDeletionList and also removes their entry from the PSR if the flag is set to true, otherwise it leaves it in the PSR.

Generally you will want to clear it from the PSR, but there is an internal case where we do leave it in there.

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

virtual

Schedule to tick the particular script at the current tick rate.

The next tick period will be the tick period given plus a variance of the amount of time given capped at 1 second. This will prevent all scripts from being ticked at once.

Reimplemented from DtMultiTaskControllerComponent.

static void DtScriptMultiTaskController::scriptUpdatedCallback	(	const DtScriptedTaskManagerCallbackInfo &	info,
		void *	usr
	)

static

static void DtScriptMultiTaskController::scenarioSaveCallback ( void * usr )

static

virtual void DtScriptMultiTaskController::scriptSetTickPeriod	(	const DtString &	scriptId,
		double	period
	)

virtual