VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes
DtScriptMultiTaskController Class Reference
Inheritance diagram for DtScriptMultiTaskController:
Inheritance graph
[legend]

Public Member Functions

 DtScriptMultiTaskController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *parentRegistry)
 
virtual ~DtScriptMultiTaskController ()
 
virtual const chartype () const
 Returns a string identifies the class type of component. More...
 
virtual bool init ()
 Calls setRadio() More...
 
virtual void preFirstTickInit ()
 This function can be overridden to initialize a component before it is ticked for the first time. More...
 
virtual void tick ()
 This gives the thread of control to the component. More...
 
virtual bool tickWhileDestroyed () const
 Overridden to tick after being destroyed. More...
 
virtual bool beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
 Called by the task manager when this controller should start executing the specified task. More...
 
virtual void clearTask (int taskId)
 Clears the specified task out, includes any related subtasks. More...
 
virtual void taskComplete (int taskId, bool success)
 This indicates that the specified task is complete. More...
 
virtual void setComplete (DtSetMessageType setId)
 
virtual void suspendTask (int taskId)
 This method is called when the specified running task is being suspended. More...
 
virtual DtSimTaskStatePtr currentTaskState (int taskId) const
 Overridden to return a task state based on the script data that is currently running. More...
 
virtual bool createPSR ()
 
virtual void registerScriptTaskCallbacks ()
 
virtual void unregisterScriptTaskCallbacks ()
 
virtual void registerTaskMsgCallbacks ()
 
virtual void unregisterTaskMsgCallbacks ()
 
virtual void registerScriptSetCallbacks ()
 
virtual void unregisterScriptSetCallbacks ()
 
virtual bool isTypeTaskable (const DtSimTaskMessageType &taskType, bool remap=true) const
 Adds/removes/checks a specific task message callback. More...
 
virtual void addTypeTaskable (const DtSimTaskMessageType &taskType, const DtString &system="")
 
virtual void removeTypeTaskable (const DtSimTaskMessageType &taskType)
 
virtual bool isTypeSetable (const DtSetMessageType &taskType, bool remap=true) const
 Adds/removes/checks a specific set message callback. More...
 
virtual void addTypeSetable (const DtSetMessageType &taskType, const DtString &system="")
 
virtual void removeTypeSetable (const DtSetMessageType &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. More...
 
virtual void removeRunnableTaskType (const DtSimTaskMessageType &taskType)
 
virtual void addRunnableSetType (const DtSetMessageType &taskType, const DtString &system)
 Adds/removes a setType that is runnable by this script controller instance, even if the set type is not configured for this entity type. More...
 
virtual void removeRunnableSetType (const DtSetMessageType &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. More...
 
virtual void setScriptTickPeriod (int taskId, const DtString &scriptId, double period)
 Schedule to tick the particular script at the current tick rate. More...
 
virtual void addAdditionalReactiveTask (const DtSimTaskMessageType &)
 Since all reactive tasks are enabled through here, add additional tasks via the script enable controller. More...
 
virtual int nextBackgroundProcessId () const
 Returns an id for the next background processing task. More...
 
virtual void startScriptedSet (DtScriptedTaskSet *)
 
virtual void scriptSetTickPeriod (int taskId, const DtString &scriptId, double period)
 
virtual void scriptSetTickWhilePaused (int taskId, const DtString &scriptId, bool enable)
 
virtual void scriptSetRespondToNewSensorContacts (int taskId, const DtString &scriptId, bool respond)
 
virtual void scriptTaskComplete (int taskId, bool success)
 
virtual void scriptSetComplete (const DtString &scriptId)
 
virtual int scriptSendSubtask (DtSimTask &task, int parentTaskId)
 
virtual std::vector< intscriptPendingSubstaskIds (int taskId)
 
virtual DtSubtaskStatusEntryscriptSubtaskStatus (int subtaskId, int parentTaskId)
 
virtual void cleanupInactiveSubtaskStatus (int parentTaskId)
 Clears out subtask status entries that are either completed or canceled which were started by the specified taskId. More...
 
virtual void scriptClearSubtask (int subtaskId, int parentTaskId)
 
virtual void setCheckpointModeUseCheckpointState (int taskId, const DtString &scriptId, bool)
 
virtual bool checkpointModeUseCheckpointState (int taskId, const DtString &scriptId) const
 
virtual int askUserQuestion (const DtString &scriptId, const DtTranslatableStream &title, const DtTranslatableStream &message, const std::vector< DtTranslatableStream > &options, int displayFlag)
 
virtual int statusOfUserQuestion (int questionId)
 
virtual void cancelUserQuestion (int questionId)
 
virtual int scriptSendTask (DtSimTask &task, const DtUUID &entityName, int parentTaskId, bool actAsSubtask=true, bool useRadio=false)
 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. More...
 
virtual void notifyScriptTaskError (const DtString &scriptId, int taskId)
 
virtual DtPointTaskVisualizationPtr pointTaskVisualization (int taskId, const DtString &visName)
 Finds an existing or creates a new point task visualization with the given name. More...
 
virtual DtLineTaskVisualizationPtr lineTaskVisualization (int taskId, const DtString &visName)
 Finds an existing or creates a new line task visualization with the given name. More...
 
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (int taskId, const DtString &visName)
 Finds an existing or creates a new area task visualization with the given name. More...
 
virtual DtTextTaskVisualizationPtr textTaskVisualization (int taskId, const DtString &visName)
 Finds an existing or creates a new text task visualization with the given name. More...
 
virtual void deleteTaskVisualization (int taskId, const DtString &visName)
 
- Public Member Functions inherited from DtMultiTaskControllerComponent
 DtMultiTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtMultiTaskControllerComponent ()
 destructor More...
 
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)). More...
 
virtual DtTaskMessagecurrentTaskMessage (int taskId)
 
virtual int sendSubtask (DtSimTask &task, int taskId)
 Sends subtask to ourself. More...
 
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. More...
 
virtual void clearSubtask (int subtaskId, int taskId)
 Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()). More...
 
virtual void addPendingSubtaskId (int subtaskId, int taskId)
 Adds given subtask Id to list of pending subtasks. More...
 
virtual bool findPendingSubtaskId (int subtaskId, int taskId)
 Checks to see if given subtaskId exists in our list of pending subtasks. More...
 
virtual bool isSubtasked () const
 Returns true if this controller is currently subtasked. More...
 
virtual void removePendingSubtaskId (int subtaskId, int taskId)
 Removes pending subtask from list of subtasks for this component. More...
 
virtual DtSubtaskStatusEntrysubtaskStatus (int subtaskId, int taskId)
 
virtual void removeAllPendingSubtaskIds (int taskId)
 Clear all pending subtasks from our list of subtasks for taskId. More...
 
virtual std::vector< intcurrentPendingSubstaskIds (int taskId) const
 Returns the list of all currently pending subtask ids for this controller. More...
 
virtual bool decideToGiveUpTask () const
 The DtMultiTaskControllerComponent does not current support decideToGiveUp. More...
 
virtual void giveUpTask ()
 Called when controller is tasked and decideToGiveUp() returns true. More...
 
virtual bool taskActive (int taskId) const
 
virtual bool clearTopLevelTasks ()
 If this controller has any top level tasks (not subtasks), they are cleared. More...
 
virtual void clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
 Clears any top level tasks on this controller that conflict with the conflict task type. More...
 
virtual void clearTasksByType (const DtSimTaskMessageType &taskType)
 Clears any tasks of the specified type running in this controller. More...
 
virtual void clearTaskById (int taskId)
 Clears any task of the specified ID running in this controller. More...
 
virtual DtSuspendedTaskInfosuspendTaskById (int taskId)
 
virtual DtSuspendedTaskInfosuspendSubtaskById (int taskId, int subtaskId)
 
virtual std::list
< DtTaskMessage * > 
currentTaskMessages () const
 
virtual DtTaskWithTaskStateListPtr topLevelTasks () const
 
virtual void setScriptTickPeriod (const DtString &scriptId, double period)
 If supported, and this is a scripted task controller, set the period to tick the script. More...
 
virtual void destroyTaskVisualization (int taskId, const DtString &name)
 Destroys an existing task visualization. More...
 
virtual void destroyTaskVisualizations (int taskId)
 Destroys all existing task visualizations for the specified task. More...
 
- Public Member Functions inherited from DtTaskControllerComponent
 DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtTaskControllerComponent ()
 destructor More...
 
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. More...
 
virtual bool showCurrentTaskInGui () const
 
virtual void setRadio (DtSimRadio *radio)
 Calls registerTaskMsgCallbacks. More...
 
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Adds a new function for processing the specified task type. More...
 
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Deprecated form of addTaskProcessorCallback. More...
 
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Undoes anything done by addTaskProcessorCallback(). More...
 
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Deprecated form of removeTaskProcessorCallback. More...
 
virtual void enable ()
 Overridden to call registerTaskMsgCallbacks(). More...
 
virtual void disable ()
 Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task. More...
 
virtual void sendTaskCanceled (DtTaskMessage *taskMsg)
 Sends the task canceled report for the specified message. More...
 
virtual bool taskVisualizationsActive () const
 Returns true if task visualizations are currently active for this component. More...
 
virtual void setTasked (bool tasked)
 The current tasked state of this controller. More...
 
virtual bool tasked () const
 
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtControllerComponent ()
 destructor More...
 
virtual DtSimRadioradio ()
 The radio this component is listening to. More...
 
virtual void clearTask ()
 Called when you want to clear out this component's task state. More...
 
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtSimComponent ()
 destructor More...
 
virtual void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component. More...
 
DtComponentSystemparentSystem () const
 
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager. More...
 
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values. More...
 
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived. More...
 
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as More...
 
virtual double minTickPeriod () const
 access the minimum tick period More...
 
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time More...
 
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period More...
 
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally. More...
 
virtual double nextTickTime () const
 access the next tick time More...
 
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...
 
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at. More...
 
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. More...
 
virtual DtSimComponentnextComponent ()
 List management functions. More...
 
virtual DtSimComponentprevComponent ()
 
virtual void setListItem (DtListItem *item)
 Used by DtComponentList. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void removeInputPort (DtInputPort *port)
 
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name. More...
 
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component. More...
 
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. More...
 
virtual void removeOutputPort (DtOutputPort *port)
 
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name. More...
 
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component. More...
 
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. More...
 
virtual void removeInputPortGroup (DtInputPortGroup *group)
 
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name. More...
 
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component. More...
 
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. More...
 
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
 
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name. More...
 
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component. More...
 
virtual int priority () const
 Return the current connection priority for this component. More...
 
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. More...
 
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...
 
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. More...
 
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. More...
 
virtual const
DtComponentDescriptor
componentDescriptor () const
 
DtVrfProcessStateRepositoryManagerpsrManager ()
 
virtual const DtSymbolStringcomponentFullName () const
 
DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in. More...
 
const DtPhysicalWorldphysicalWorld () const
 
DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any. More...
 
const DtAttachedTerrainterrainAttachedTo () const
 
DtVrfObjectentity ()
 Gets the entity. More...
 
const DtVrfObjectentity () const
 
const DtVrfObjectconst_entity () const
 You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...
 
DtSimManagersimManager ()
 Gets the sim manager. More...
 
const DtSimManagersimManager () const
 
const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...
 
DtVrfObjectStateRepositorylocalStateRepository ()
 Gets the local state repository. More...
 
const DtVrfObjectStateRepositorylocalStateRepository () const
 
const DtVrfObjectStateRepositoryconst_localStateRepository () const
 You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...
 
virtual DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component. More...
 
virtual bool taskVisualizationsEnabled () const
 Returns true if task visualizations are enabled for this component. More...
 
virtual bool isThreadSafe () const
 Returns true if this component is marked as being thread safe. More...
 
virtual void addVRLinkDeferredJob (const boost::function< void()> &callback)
 Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe. More...
 
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 DtSimResourceManagerresourceManager ()
 
virtual const
DtSimResourceManager
resourceManager () const
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor More...
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor More...
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator More...
 
bool operator== (const DtReaderWriter &) const
 Equivalence operator. More...
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 destructor More...
 
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. More...
 
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op. More...
 
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op. More...
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream. More...
 
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op. More...
 
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op. More...
 
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. More...
 
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object. More...
 
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object. More...
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 Set read-only flag. More...
 
bool isReadonly () const
 
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
 
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment. More...
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false. More...
 
virtual void setName (const DtString &)
 Set the name of the object. More...
 
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable. More...
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children. More...
 
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. More...
 
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference. More...
 
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. More...
 
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated. More...
 
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time. More...
 
virtual bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called. More...
 
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values. More...
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively. More...
 
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference. More...
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
 
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. More...
 
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () const
 Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
 
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename. More...
 
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid. More...
 
virtual bool fromXmlFile (const DtFilename &)
 Restores object from given xml file. More...
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data. More...
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference. More...
 
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. More...
 
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. More...
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference. More...
 
- 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 DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *parentRegistry)
 
- Static Public Member Functions inherited from DtTaskControllerComponent
static void deprecatedTaskProcessorCallbackAdapter (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskState)
 Task processor callback function that acts as an adapter for the deprecated forms of addTaskProcessorCallback and removeTaskProcessorCallback (the deprecated form is is version that. More...
 
- Static Public Member Functions inherited from DtSimComponent
static DtSimComponentMarkThreadSafe (DtSimComponent *)
 Marks an instance of a component as being thread safe. More...
 
static DtSimComponentFactoryfactory ()
 A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...
 
static void setFactory (DtSimComponentFactory *factory)
 
static DtSimComponentcreateComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More...
 
static void addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
 Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...
 
- 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 chartheXmlType ()
 The type that is used when archiving to an XML stream. More...
 
static const DtFilename & appPath ()
 Gets the current working directory. More...
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory. More...
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within. More...
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP. More...
 
- Static Public Member Functions inherited from DtObjectDebugger< DtSimComponent >
static DtObjectCounter::CounterType ObjectCount ()
 
static const DtObjectContainer * ObjectContainer ()
 

Protected Types

typedef std::pair< int, DtStringTaskAndScriptIds
 
- Protected Types inherited from DtTaskControllerComponent
typedef std::pair
< DtTaskMessageCallbackFcn,
void * > 
DtTaskCallbackMapPair
 This map stores callbacks that have been registered to processes various tasks. More...
 
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

 DtScriptMultiTaskController (const DtScriptMultiTaskController &other)
 
DtScriptMultiTaskControlleroperator= (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 restartScriptInterfaceByType (const DtSetMessageType &taskType)
 
virtual void clearAndRestoreTasks (bool forceStop=false)
 Clears out all tasks and re-registers for tasks for this entity. More...
 
virtual void clearAndRestoreSets ()
 Clears out all sets and re-registers for set for this entity. More...
 
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. More...
 
virtual void processScriptedSet (DtSimMessage *msg)
 
virtual bool checkRemoveTaskId (int taskId, bool clearFromPsr=true)
 
virtual bool markedForDeletion (int taskId) const
 
- 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. More...
 
virtual void clearCurrentTaskMessage (int taskId)
 Removes task with the specified task ID from the list of current tasks for this controller. More...
 
virtual void clearPendingSubtasks (int taskId)
 Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type. More...
 
virtual void clearSubtasksByType (const DtSimTaskMessageType &taskType, int taskId)
 Clear all subtasks of a given type. More...
 
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. More...
 
virtual void suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)
 Suspends a single running subtasks of taskId, and puts the suspend info into the provided suspendInfo. More...
 
virtual DtSimTaskMessageType remapScriptId (const DtSimTaskMessageType &) const
 In case this is aliased, return the actual script id. More...
 
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor More...
 
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor More...
 
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator More...
 
virtual void onRestore ()
 Override to iterate over the descriptor to see if there are any targetting control tables. More...
 
virtual void initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)
 
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT. More...
 
bool testInvariant () const
 
virtual bool createPortGroups ()
 Called by init. More...
 
virtual bool createPorts ()
 Called by init. More...
 
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 Creates a PSR for this component and registers it with the PSR manager. More...
 
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick. More...
 
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations for this component. More...
 
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization. More...
 
virtual DtPointTaskVisualizationPtr pointTaskVisualization (const DtString &name)
 Finds an existing or creates a new point task visualization with the given name. More...
 
virtual DtLineTaskVisualizationPtr lineTaskVisualization (const DtString &name)
 Finds an existing or creates a new line task visualization with the given name. More...
 
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (const DtString &name)
 Finds an existing or creates a new area task visualization with the given name. More...
 
virtual DtTextTaskVisualizationPtr textTaskVisualization (const DtString &name)
 Finds an existing or creates a new text task visualization with the given name. More...
 
double calculateNextTaskVisTickTime () const
 Determines the next time the task visualizations should be ticked. More...
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 
- Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 
 DtObjectDebugger (const DtObjectDebugger &)
 
 ~DtObjectDebugger ()
 
- Protected Member Functions inherited from DtScriptTaskControllerInterface
 DtScriptTaskControllerInterface ()
 
 DtScriptTaskControllerInterface (const DtScriptTaskControllerInterface &other)
 
DtScriptTaskControllerInterfaceoperator= (const DtScriptTaskControllerInterface &other)
 

Static Protected Member Functions

static void userQuestionOperationCallback (DtSimMessage *msg, void *usrData)
 
static void processScriptedSetCallback (DtSimMessage *msg, void *usrData)
 

Protected Attributes

std::map< DtSimTaskMessageType,
int
myAvailableTaskScripts
 
std::map< DtSetMessageType, intmyAvailableSetScripts
 
std::map< DtSimTaskMessageType,
int
myBackgroundProcesses
 
std::map< int,
boost::shared_ptr
< DtScriptInterface > > 
myCurrentScriptInterfaceMap
 Negative task ids are background processes. More...
 
std::list< intmyMarkedForDeletionList
 
std::list< TaskAndScriptIdsmyRespondToNewSensorContactList
 List of task and script IDs for scripts that will respond to new sensor contacts. More...
 
DtScriptMultiTaskControllerPSRmyProcessState
 
bool myAreTaskCallbacksRegistered
 
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. More...
 
std::map< DtSetMessageType,
DtString
myAdditionalRunnableSetTypes
 
DtForceType myCurrentForceType
 
bool myIsDestroyed
 
bool myQueueTasksToBeAdded
 Prior to preFirstTickInit, any tasks added should be queued for later addition. More...
 
bool myQueueSetsToBeAdded
 
std::map< DtSimTaskMessageType,
DtString
myTasksToBeAdded
 
std::map< DtSetMessageType,
DtString
mySetsToBeAdded
 
std::set< DtSimTaskMessageTypemyAdditionalReactiveTasks
 
- Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap myTaskCallbackMap
 
std::list
< DtTaskProcessorCallbackInfo * > 
myTaskProcessorCallbackInfoList
 This list stores any DtTaskProcessorCallbackInfo allocated locally so that they can be deleted when the component is deleted. More...
 
- Protected Attributes inherited from DtControllerComponent
DtSimRadiomyRadio
 Controller components can send messages. More...
 
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
 
DtVrfObjectStateRepositorymyLocalStateRepository
 
DtSimManagermySimManager
 
DtComponentSystemmySystem
 Pointer to the DtComponentSystem that this component belongs. More...
 
DtListItem * myListItem
 
DtInputPortMap myInputPortList
 
DtOutputPortMap myOutputPortList
 
DtInputPortGroupMap myInputPortGroupList
 
DtOutputPortGroupMap myOutputPortGroupList
 
int myPriority
 
double myMinTickPeriod
 
double myMinTickPeriodVariance
 
double myNextTickTime
 
double myLastTickSimTime
 
double myDT
 
bool myIsEnabled
 Indicates whether this component should be enabled for ticking or not. More...
 
bool myFirstTick
 Initialized to true in the constructor, set to false by the first call to postTick. More...
 
bool myIsThreadSafe
 Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...
 
const DtComponentDescriptormyComponentDescriptor
 
std::list
< DtVrfProcessStateRepository * > 
myComponentPsrs
 List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...
 
bool myTickEveryFrame
 Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...
 
DtTaskVisualizationMap myTaskVisualizations
 The visualization objects to be drawn for this component. More...
 
double myNextTaskVisTickTime
 The next tick time for updating the task visualizations. More...
 
DtSymbolString myFullComponentName
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 
virtual void processNewSensorContact (const DtVrfObject *object)
 
static void newSensorContactCallback (const DtVrfObject *object, void *usr)
 Callback for new sensor contacts. More...
 

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString
aliasContainer
 
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
 
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
 
typedef std::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Member Typedef Documentation

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
taskStateUsed 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::setComplete ( DtSetMessageType  setId)
virtual
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 void DtScriptMultiTaskController::registerScriptSetCallbacks ( )
virtual
virtual void DtScriptMultiTaskController::unregisterScriptSetCallbacks ( )
virtual
virtual bool DtScriptMultiTaskController::isTypeTaskable ( const DtSimTaskMessageType taskType,
bool  remap = true 
) 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 bool DtScriptMultiTaskController::isTypeSetable ( const DtSetMessageType taskType,
bool  remap = true 
) const
virtual

Adds/removes/checks a specific set message callback.

Not to be used if you are iterating over the myAvailableScripts member variable.

virtual void DtScriptMultiTaskController::addTypeSetable ( const DtSetMessageType taskType,
const DtString system = "" 
)
virtual
virtual void DtScriptMultiTaskController::removeTypeSetable ( const DtSetMessageType 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::addRunnableSetType ( const DtSetMessageType taskType,
const DtString system 
)
virtual

Adds/removes a setType that is runnable by this script controller instance, even if the set 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::removeRunnableSetType ( const DtSetMessageType 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 ( int  taskId,
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.

static void DtScriptMultiTaskController::scriptUpdatedCallback ( const DtScriptedTaskManagerCallbackInfo info,
void *  usr 
)
static
static void DtScriptMultiTaskController::scenarioSaveCallback ( void *  usr)
static
virtual void DtScriptMultiTaskController::scriptSetTickPeriod ( int  taskId,
const DtString scriptId,
double  period 
)
virtual
virtual void DtScriptMultiTaskController::scriptSetTickWhilePaused ( int  taskId,
const DtString scriptId,
bool  enable 
)
virtual
virtual void DtScriptMultiTaskController::scriptSetRespondToNewSensorContacts ( int  taskId,
const DtString scriptId,
bool  respond 
)
virtual
virtual void DtScriptMultiTaskController::scriptTaskComplete ( int  taskId,
bool  success 
)
virtual
virtual void DtScriptMultiTaskController::scriptSetComplete ( const DtString scriptId)
virtual
virtual int DtScriptMultiTaskController::scriptSendSubtask ( DtSimTask task,
int  parentTaskId 
)
virtual
virtual std::vector<int> DtScriptMultiTaskController::scriptPendingSubstaskIds ( int  taskId)
virtual
virtual DtSubtaskStatusEntry* DtScriptMultiTaskController::scriptSubtaskStatus ( int  subtaskId,
int  parentTaskId 
)
virtual
virtual void DtScriptMultiTaskController::cleanupInactiveSubtaskStatus ( int  taskId)
virtual

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

virtual void DtScriptMultiTaskController::scriptClearSubtask ( int  subtaskId,
int  parentTaskId 
)
virtual
virtual void DtScriptMultiTaskController::setCheckpointModeUseCheckpointState ( int  taskId,
const DtString scriptId,
bool   
)
virtual
virtual bool DtScriptMultiTaskController::checkpointModeUseCheckpointState ( int  taskId,
const DtString scriptId 
) const
virtual
virtual int DtScriptMultiTaskController::askUserQuestion ( const DtString scriptId,
const DtTranslatableStream title,
const DtTranslatableStream message,
const std::vector< DtTranslatableStream > &  options,
int  displayFlag 
)
virtual
virtual int DtScriptMultiTaskController::statusOfUserQuestion ( int  questionId)
virtual
virtual void DtScriptMultiTaskController::cancelUserQuestion ( int  questionId)
virtual
virtual int DtScriptMultiTaskController::scriptSendTask ( DtSimTask task,
const DtUUID entityName,
int  parentTaskId,
bool  actAsSubtask = true,
bool  useRadio = false 
)
virtual

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.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptMultiTaskController::notifyScriptTaskError ( const DtString scriptId,
int  taskId 
)
virtual
virtual DtPointTaskVisualizationPtr DtScriptMultiTaskController::pointTaskVisualization ( int  taskId,
const DtString name 
)
virtual

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

Reimplemented from DtMultiTaskControllerComponent.

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

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

Reimplemented from DtMultiTaskControllerComponent.

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

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

Reimplemented from DtMultiTaskControllerComponent.

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

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

Reimplemented from DtMultiTaskControllerComponent.

virtual void DtScriptMultiTaskController::deleteTaskVisualization ( int  taskId,
const DtString visName 
)
virtual
virtual void DtScriptMultiTaskController::addAdditionalReactiveTask ( const DtSimTaskMessageType )
virtual

Since all reactive tasks are enabled through here, add additional tasks via the script enable controller.

static void DtScriptMultiTaskController::newSensorContactCallback ( const DtVrfObject object,
void *  usr 
)
static

Callback for new sensor contacts.

Whenever there is a new sensor contact, or a sensor contact has new information, each script that has called vrf:setRespondToNewSensorContacts(true) will have its tick time set to current sim time, and therefore tick again as soon as possible.

virtual void DtScriptMultiTaskController::processNewSensorContact ( const DtVrfObject object)
virtual
static DtSimComponent* DtScriptMultiTaskController::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc,
DtReaderWriterRegistry parentRegistry 
)
static
virtual int DtScriptMultiTaskController::nextBackgroundProcessId ( ) const
virtual

Returns an id for the next background processing task.

One less than the least background processing task

virtual void DtScriptMultiTaskController::startScriptedSet ( DtScriptedTaskSet )
virtual
DtScriptMultiTaskController& DtScriptMultiTaskController::operator= ( const DtScriptMultiTaskController other)
protected
virtual void DtScriptMultiTaskController::processScriptUpdatedCallback ( const DtScriptedTaskManagerCallbackInfo info)
protectedvirtual
virtual void DtScriptMultiTaskController::processScenarioSaveCallback ( )
protectedvirtual
virtual void DtScriptMultiTaskController::propagateScriptIdChange ( const DtString oldId,
const DtString newId 
)
protectedvirtual
virtual bool DtScriptMultiTaskController::isForMyEntityType ( const DtScriptedTaskMetaData metaData)
protectedvirtual
virtual void DtScriptMultiTaskController::processMetaDataChange ( const DtScriptedTaskManagerCallbackInfo info)
protectedvirtual
virtual void DtScriptMultiTaskController::restartScriptInterfaceByType ( const DtSimTaskMessageType taskType)
protectedvirtual
virtual void DtScriptMultiTaskController::restartScriptInterfaceByType ( const DtSetMessageType taskType)
protectedvirtual
virtual void DtScriptMultiTaskController::clearAndRestoreTasks ( bool  forceStop = false)
protectedvirtual

Clears out all tasks and re-registers for tasks for this entity.

If forceStop is true will stop all current tasks as part of the clear

virtual void DtScriptMultiTaskController::clearAndRestoreSets ( )
protectedvirtual

Clears out all sets and re-registers for set for this entity.

static void DtScriptMultiTaskController::userQuestionOperationCallback ( DtSimMessage msg,
void *  usrData 
)
staticprotected
virtual void DtScriptMultiTaskController::processUserQuestionOperation ( DtSimMessage )
protectedvirtual
virtual void DtScriptMultiTaskController::sendOffOutstandingQuestionFor ( const DtString scriptId)
protectedvirtual
virtual bool DtScriptMultiTaskController::backgroundProcessAvailable ( ) const
protectedvirtual

Returns true unless this is a global plan, in which case background processes are not available.

static void DtScriptMultiTaskController::processScriptedSetCallback ( DtSimMessage msg,
void *  usrData 
)
staticprotected
virtual void DtScriptMultiTaskController::processScriptedSet ( DtSimMessage msg)
protectedvirtual
virtual bool DtScriptMultiTaskController::checkRemoveTaskId ( int  taskId,
bool  clearFromPsr = true 
)
protectedvirtual
virtual bool DtScriptMultiTaskController::markedForDeletion ( int  taskId) const
protectedvirtual

Member Data Documentation

std::map<DtSimTaskMessageType, int> DtScriptMultiTaskController::myAvailableTaskScripts
protected
std::map<DtSetMessageType, int> DtScriptMultiTaskController::myAvailableSetScripts
protected
std::map<DtSimTaskMessageType, int> DtScriptMultiTaskController::myBackgroundProcesses
protected
std::map<int, boost::shared_ptr<DtScriptInterface> > DtScriptMultiTaskController::myCurrentScriptInterfaceMap
protected

Negative task ids are background processes.

std::list<int> DtScriptMultiTaskController::myMarkedForDeletionList
protected
std::list<TaskAndScriptIds> DtScriptMultiTaskController::myRespondToNewSensorContactList
protected

List of task and script IDs for scripts that will respond to new sensor contacts.

DtScriptMultiTaskControllerPSR* DtScriptMultiTaskController::myProcessState
protected
bool DtScriptMultiTaskController::myAreTaskCallbacksRegistered
protected
std::map<DtSimTaskMessageType, DtString> DtScriptMultiTaskController::myAdditionalRunnableTaskTypes
protected

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.

std::map<DtSetMessageType, DtString> DtScriptMultiTaskController::myAdditionalRunnableSetTypes
protected
DtForceType DtScriptMultiTaskController::myCurrentForceType
protected
bool DtScriptMultiTaskController::myIsDestroyed
protected
bool DtScriptMultiTaskController::myQueueTasksToBeAdded
protected

Prior to preFirstTickInit, any tasks added should be queued for later addition.

bool DtScriptMultiTaskController::myQueueSetsToBeAdded
protected
std::map<DtSimTaskMessageType, DtString> DtScriptMultiTaskController::myTasksToBeAdded
protected
std::map<DtSetMessageType, DtString> DtScriptMultiTaskController::mySetsToBeAdded
protected
std::set<DtSimTaskMessageType> DtScriptMultiTaskController::myAdditionalReactiveTasks
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)