 |
VR-Forces 4.3.1 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Forces 4.3.1 Class Documentation
|
DtSimEngineeringTaskManager. More...
Public Member Functions | |
| DtSimEngineeringTaskManager (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtSimEngineeringTaskManager (const DtSimEngineeringTaskManager &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtSimEngineeringTaskManager & | operator= (const DtSimEngineeringTaskManager &orig) |
| assignment operator | |
| virtual | ~DtSimEngineeringTaskManager () |
| destructor | |
 Public Member Functions inherited from DtSimTaskManager | |
| DtSimTaskManager (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtSimTaskManager (const DtSimTaskManager &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtSimTaskManager & | operator= (const DtSimTaskManager &orig) |
| assignment operator | |
| virtual | ~DtSimTaskManager () |
| destructor | |
| virtual bool | init () |
| Calls base class init(), and registerRadioMessageCallbacks(). | |
| virtual void | tick () |
| Sends awaitingTask message to plan engine if needed. | |
| virtual void | addTaskProcessor (const DtSimTaskMessageType &taskType, DtTaskControllerComponent *taskController) |
| Registers a task controller as a processor for a specific task type. | |
| virtual void | removeTaskProcessor (const DtSimTaskMessageType &taskType, DtTaskControllerComponent *taskController) |
| Removes a task controller that has previously registered for as a task processor for a specific task type. | |
| virtual void | removeAllReferencesToController (DtTaskControllerComponent *taskController) |
| Removes all task processors that are registered by this controller. | |
| virtual std::vector < DtSimTaskMessageType > | capableTaskIds () const |
| virtual AvailableSupportingTasks | supportingTasks () const |
| virtual SupportingTasks | supportingTasks (int) const |
| virtual bool | transitionTask (DtTaskMessage &taskMsg, DtSimTaskStatePtr taskState) |
| Transitions the task from controller state to another. | |
| virtual int | suspendTasks (std::set< DtString > actionCategories) |
| Function to suspend. | |
| virtual int | suspendAllTopLevelTasks () |
| Suspends all top level tasks. | |
| virtual DtSuspendedTaskInfo * | suspendTask (int taskId) |
| Suspends a specific task, and returns the suspend info. | |
| virtual bool | resumeTasks (int suspendId) |
| Takes a suspend ID generated from a call to suspend, and resumes any tasks that were suspended with this ID. | |
| virtual bool | taskActive (int taskId) const |
| virtual void | registerInterfaceMessageCallbacks () |
| Registers a callback for Skip Task messages. | |
| virtual void | registerRadioMessageCallbacks () |
| Register for TaskedBySuperior and DtClearTask radio messages. | |
| virtual void | taskNotify (const DtSimTask &task, const DtSimComponent ¬ifier) |
| Called by controller component when task is received. | |
| virtual void | skipTask (bool fromSuperior=false) |
| Called by controller component when task is received. | |
| virtual void | taskComplete (const DtVrfObjectMessage &radioMsg, bool success) |
| Called by controller component when task is complete. | |
| virtual void | sendTaskCompleted (const DtTaskMessage &taskMsg, bool success) |
| send a task complete report message to the originator of a task (as indicated by the sender field of the task message sent) | |
| void | awaitingTask (int taskIdJustCompleted=-1) |
| Calls awaitingTask on the DtPlan via the DtVrfObjectPlanManager Specify the task ID of the task that just completed, if available. | |
| virtual void | setTaskedBySuperior () |
| Equivalent to localState()->setIndependentlyTasked(false) for local entities, but deriving pseudo aggregates do more... | |
| virtual bool | requestTaskNeeded () const |
| Will we ask the plan manager for a task this tick. | |
| virtual void | setRequestTaskNeeded (bool requestTaskNeeded) |
| Used within the task manager. | |
| virtual bool | independentlyTasked () const |
| Are we tasked independently (plan or user) or by a superior (pseudo-aggregate) entity? | |
| virtual void | setIndependentlyTasked (bool independentlyTasked) |
| Sets independentlyTasked flag. | |
| virtual bool | currentTasksMatchEchelonId () |
| Returns true only if all current tasks are addressed to the current echelon ID of myVrfObjecet, or if the current echelon ID is blank. | |
| virtual bool | isPseudoAggregate () const |
| Indicates whether or not the type of task manager created supports pseudo-aggregates. | |
| virtual DtString | type () const |
| Returns the type of task manager object. | |
| virtual DtVrfObject * | vrfObject () const |
| Returns a pointer to the simObject this task manager is attached to. | |
| virtual void | setVrfObject (DtVrfObject *vrfObject) |
| Sets myVrfObject. | |
| virtual void | addSupportingTask (int, const DtSimTaskMessageType &) |
| Adds/remove supporting tasks. | |
| virtual void | addSupportingTasks (int, const SupportingTasks &) |
| Adds/remove supporting tasks. | |
| virtual void | removeSupportingTask (int, const DtSimTaskMessageType &) |
| Adds/remove supporting tasks. | |
| virtual void | removeSupportingTasks (int) |
| Adds/remove supporting tasks. | |
| virtual bool | executeTask (DtTaskMessage &taskMsg) |
| Starts the execution of this task. | |
| virtual bool | executeTask (DtTaskMessage &taskMsg, DtSimTaskStatePtr taskState) |
| Starts the execution of this task. | |
| virtual void | addTaskCompleteCallback (DtTaskCompleteCallbackList::DtCallbackFunctionType fcn, void *usr) |
| Callbacks that are invoked any time a task is complete. | |
| virtual void | removeTaskCompleteCallback (DtTaskCompleteCallbackList::DtCallbackFunctionType fcn, void *usr) |
| Callbacks that are invoked any time a task is complete. | |
| virtual void | setSendSkipTaskMessages (bool sendSkipTaskMessages) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual bool | sendSkipTaskMessages () |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual void | addOnTaskNotifyCallback (DtOnTaskNotifyCallbackFcn fcn, void *userData) |
| Registers callback to invoked after taskNotify() is called (at the point when an entity starts executing a new task). | |
| virtual void | removeOnTaskNotifyCallback (DtOnTaskNotifyCallbackFcn fcn, void *userData) |
| Removes callback to invoked after taskNotify() is called (at the point when an entity starts executing a new task). | |
| virtual void | clearSubtask (int subtaskId) |
| Locates DtTaskControllerComponent currently executing a task with the given subtaskId, and calls clearTask() on that component. | |
| virtual DtTaskWithTaskStateListPtr | topLevelTasks () const |
| virtual bool | hasTopLevelTask () const |
| virtual bool | taskTypesAreExclusive (const DtSimTaskMessageType &taskType1, const DtSimTaskMessageType &taskType2) const |
| virtual bool | canExecuteTask (const DtSimTaskMessageType &) const |
| True if this object will support the given task | |
| virtual void | clearTaskByType (const DtSimTaskMessageType &taskType) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual void | updateTaskInfo () |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual DtScriptReactiveTaskController * | reactiveTaskController () |
| virtual void | setReactiveTaskController (DtScriptReactiveTaskController *reactiveTaskController) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| 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 (FILE *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 (FILE *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 bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| virtual 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 void | putData (FILE *fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. | |
| 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. | |
Static Public Member Functions | |
| static DtSimTaskManager * | creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| Static Public Member Functions inherited from DtSimTaskManager | |
| static void | taskedBySuperiorRequestCallback (DtSimMessage *msg, void *usrData) |
| The manager will register a callback with the radio's msg executive requesting notification of Tasked By Superior Set Data Requests. | |
| static void | skipTaskCallback (DtSimMessage *msg, void *usr) |
| The manager will register a callback with its simManager's msg executive requesting notification of Skip Task Interface Requests. | |
| static void | clearTaskCallback (DtSimMessage *msg, void *usr) |
| Callback function for handling DtClearTask messages. | |
| static void | objectAboutToBeRemovedCallback (DtVrfObject *object, void *usr) |
| Callback function for cleaning up task manager just before the host object is removed from the simulation. | |
| static void | subordinateRemoved (DtEntityIdentifier childEid, void *usr) |
| Callback for handling subordinate (child) removed events. | |
| static DtSimTaskManagerFactory * | factory () |
| A DtSimEntityFactory is allocated by the DtSimCreator, and this pointer is set. | |
| static void | setFactory (DtSimTaskManagerFactory *factory) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| static void | addSimTaskManagerCreatorFcn (const DtString &type, DtSimTaskManagerCreatorFcn fcn) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| static DtSimTaskManager * | createTaskManager (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0) |
| Creates a new task manager, using the factory. | |
Protected Member Functions | |
| virtual void | registerSetDataMessageCallbacks () |
| Protected Member Functions inherited from DtSimTaskManager | |
| virtual void | processClearTask (DtSimMessage *msg) |
| Finds task controller currently tasked with task of type specified in clear task message and calls its clearTask() method. | |
| virtual void | processObjectAboutToBeRemoved (DtVrfObject *object) |
| If the object is our host entity, calls clearTopLevelTask() to clean up any active tasks before the object is removed. | |
| virtual void | resumeTaskTree (DtSuspendedTaskInfo *suspendedTaskInfo) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual bool | clearAllTopLevelTasks () |
| Cancels all top level tasks currently executing on the entity. | |
| virtual void | clearConflictingTopLevelTasks (const DtSimTaskMessageType &taskType) |
| Cancels any top level tasks that are running on the entity if they conflict with the specified task type. | |
| virtual void | onTaskNotify (const DtSimTask &task, const DtSimComponent ¬ifier) |
| Hook function called at the end of taskNotify(). | |
| void | processSubordinateRemoved (DtEntityIdentifier childEid) |
| If we are currently tasked and former subordinate is not independently tasked, sends a skip task message to this former subordinate. | |
| virtual void | processTaskMessage (DtSimMessage *msg) |
| Calls executeTask(). | |
| virtual bool | startTaskExecution (DtTaskMessage &taskMsg, DtSimTaskStatePtr taskState, bool taskNotify) |
| Used by executeTask() and other similar methods to start the execution of a task. | |
| virtual std::vector < DtSimTaskMessageType > | conflictingTaskTypes (const DtSimTaskMessageType &testTaskType) const |
| virtual std::list< DtString > | taskGroupsForTask (const DtSimTaskMessageType &taskType) const |
| virtual void | processRequestCurrentTasks (const DtVrfObjectMessage *msg) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual void | processUnsubscribeCurrentTasks (const DtVrfObjectMessage *msg) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual void | sendCurrentTasks () |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual void | addSubtasksToCurrentTaskMessage (const DtSuspendedTaskInfoList &subtaskList, int parentTaskId, DtCurrentTasksAdminContent &adminContent) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual void | processClearTaskByTrackingNumber (const DtVrfObjectMessage *msg) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual void | unregisterSetDataMessageCallbacks () |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual void | registerTaskMessageCallbacks () |
| Accessor/mutator for mySendSkipTaskMessages. | |
| virtual void | unregisterTaskMessageCallbacks () |
| Accessor/mutator for mySendSkipTaskMessages. | |
Private Member Functions | |
| DtSimEngineeringTaskManager () | |
| Not implemented. | |
Additional Inherited Members | |
| Public Types inherited from DtSimTaskManager | |
| typedef DtCallbackList< const DtTaskMessage & > | DtTaskCompleteCallbackList |
| typedef std::set < DtSimTaskMessageType > | SupportingTasks |
| typedef std::map< int, SupportingTasks > | AvailableSupportingTasks |
| Protected Types inherited from DtSimTaskManager | |
| typedef std::map < DtSimTaskMessageType, DtTaskControllerComponent * > | DtTaskProcessorMap |
| Static Protected Member Functions inherited from DtSimTaskManager | |
| static void | taskMessageCallback (DtSimMessage *msg, void *usr) |
| Callback resisted with the local radio for all task messages. | |
| static void | requestCurrentTasksCallback (const DtVrfObjectMessage *msg, void *usr) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| static void | unsubscribeCurrentTasksCallback (const DtVrfObjectMessage *msg, void *usr) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| static void | clearTaskByTrackingNumberCallback (const DtVrfObjectMessage *msg, void *usr) |
| Accessor/mutator for mySendSkipTaskMessages. | |
| Protected Attributes inherited from DtSimTaskManager | |
| DtVrfObject * | myVrfObject |
| std::vector < DtOnTaskNotifyCallbackInfo > | myOnTaskNotifyCallbacks |
| bool | myHaveRegisteredOrgMgrCallback |
| DtTaskProcessorMap | myTaskProcessorMap |
| Stores all the registered task processor interfaces, indexed by task type they process. | |
| bool | mySendSkipTaskMessages |
| Determines whether processSubordinateRemoved will send a skip task message. | |
| int | myNumberOfTaskSubscriptions |
| Counter which holds the number of times the current task status has been subscribed to minus the number of times it has been unsubscribed. | |
| bool | mySendTasksNextTick |
| Set to true if the task manager should send the list of current tasks next tick. | |
| DtTaskCompleteCallbackList | myTaskCompleteCallbackList |
| DtScriptReactiveTaskController * | myReactiveTaskController |
| bool | myResumingTasks |
| AvailableSupportingTasks | myAvailableSupportingTasks |
| Static Protected Attributes inherited from DtSimTaskManager | |
| static DtSimTaskManagerFactory * | theFactory |
Specialized task manager for engineering objects
|
private |
Not implemented.
| DtSimEngineeringTaskManager::DtSimEngineeringTaskManager | ( | const DtString & | name, |
| DtVrfObject * | vrfObject, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
| DtSimEngineeringTaskManager::DtSimEngineeringTaskManager | ( | const DtSimEngineeringTaskManager & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
destructor
| const DtSimEngineeringTaskManager& DtSimEngineeringTaskManager::operator= | ( | const DtSimEngineeringTaskManager & | orig | ) |
assignment operator
|
static |
Accessor/mutator for mySendSkipTaskMessages.
This should only be called by DtCgf::rewind.
Reimplemented from DtSimTaskManager.
|
protectedvirtual |
Handles registration/deregistration of callbacks
Reimplemented from DtSimTaskManager.