|
| | DtScriptReactiveTaskController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *parentRegistry) |
| |
| virtual | ~DtScriptReactiveTaskController () |
| |
| virtual const char * | type () const |
| | This returns a string from compTypes.h, and identifies the 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 std::list
< DtScriptedTaskTask > | reactiveTaskStatus () const |
| |
| virtual bool | isReactiveTaskEnabled (const DtSimTaskMessageType &scriptId) const |
| |
| virtual void | notifySuspend (const DtSimTaskMessageType &scriptId, int taskId) |
| |
| virtual void | notifyResume (const DtSimTaskMessageType &scriptId, int taskId) |
| |
| virtual void | processReturnScriptInterface (const DtSimTaskMessageType &scriptId, int taskId, boost::shared_ptr< DtScriptInterface > iFace) |
| |
| virtual bool | enableReactiveTask (const DtSimTaskMessageType &scriptId, DtRwVariableBindings ¶ms, const DtString &systemName, bool resetIfEnabled=false) |
| |
| virtual bool | createPSR () |
| |
virtual std::vector
< DtSimTaskMessageType > | availableReactiveTasks () const |
| |
| virtual DtString | systemFor (const DtSimTaskMessageType &scriptId) const |
| |
|
| 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 tick) |
| | No-op. This is not relevant for reactive tasks. More...
|
| |
| virtual void | scriptTaskComplete (int taskId, bool success) |
| |
| virtual void | scriptSetComplete (const DtString &) |
| |
| virtual int | scriptSendSubtask (DtSimTask &task, int parentTaskId) |
| |
| virtual std::vector< int > | scriptPendingSubstaskIds (int taskId) |
| |
| virtual DtSubtaskStatusEntry * | scriptSubtaskStatus (int subtaskId, int parentTaskId) |
| |
| virtual void | cleanupInactiveSubtaskStatus (int parentTaskId) |
| |
| virtual void | scriptClearSubtask (int subtaskId, int parentTaskId) |
| |
| virtual int | scriptSendTask (DtSimTask &task, const DtUUID &entityName, int parentTaskId, bool actAsSubtask=true, bool useRadio=false) |
| |
| 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 void | addReactiveTaskType (const DtSimTaskMessageType &, const DtString &system="") |
| | Adds this task to be considered a reactive task of this entity. More...
|
| |
| virtual void | notifyScriptTaskError (const DtString &scriptId, int taskId) |
| |
| virtual DtPointTaskVisualizationPtr | pointTaskVisualization (int taskId, const DtString &visName) |
| | Returns null pointer. This is not relevant for reactive tasks. More...
|
| |
| virtual DtLineTaskVisualizationPtr | lineTaskVisualization (int taskId, const DtString &visName) |
| | Returns null pointer. This is not relevant for reactive tasks. More...
|
| |
| virtual DtAreaTaskVisualizationPtr | areaTaskVisualization (int taskId, const DtString &visName) |
| | Returns null pointer. This is not relevant for reactive tasks. More...
|
| |
| virtual DtTextTaskVisualizationPtr | textTaskVisualization (int taskId, const DtString &visName) |
| | Returns null pointer. This is not relevant for reactive tasks. More...
|
| |
| virtual void | deleteTaskVisualization (int taskId, const DtString &visName) |
| | No-op. This is not relevant for reactive tasks. More...
|
| |
| | DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| |
| virtual | ~DtControllerComponent () |
| | destructor More...
|
| |
| virtual DtSimRadio * | radio () |
| | The radio this component is listening to. More...
|
| |
| virtual void | taskNotify (const DtSimTask &task) |
| | This is used by the entity to notify all controllers that a new task has been received. More...
|
| |
| virtual void | clearTask () |
| | Called when you want to clear out this component's task state. More...
|
| |
| | 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...
|
| |
| DtComponentSystem * | parentSystem () 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 | postTick () |
| | This function is called immediately after tick() is called. 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 DtSimComponent * | nextComponent () |
| | List management functions. More...
|
| |
| virtual DtSimComponent * | prevComponent () |
| |
| 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 DtInputPort * | lookupInputPort (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 DtOutputPort * | lookupOutputPort (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 DtInputPortGroup * | lookupInputPortGroup (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 DtOutputPortGroup * | lookupOutputPortGroup (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 |
| |
| virtual bool | tickWhileDestroyed () const |
| | If the component returns true here, it will be ticked regardless of the destroyed state of the host entity. More...
|
| |
| DtVrfProcessStateRepositoryManager * | psrManager () |
| |
| virtual const DtSymbolString & | componentFullName () const |
| |
| DtPhysicalWorld * | physicalWorld () |
| | Gets the physical world that this component's entity exists in. More...
|
| |
| const DtPhysicalWorld * | physicalWorld () const |
| |
| DtAttachedTerrain * | terrainAttachedTo () |
| | Gets the terrain that this component's entity is attached to, if any. More...
|
| |
| const DtAttachedTerrain * | terrainAttachedTo () const |
| |
| DtVrfObject * | entity () |
| | Gets the entity. More...
|
| |
| const DtVrfObject * | entity () const |
| |
| const DtVrfObject * | const_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...
|
| |
| DtSimManager * | simManager () |
| | Gets the sim manager. More...
|
| |
| const DtSimManager * | simManager () const |
| |
| const Coordinate_System * | coordinateSystem () const |
| | Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...
|
| |
| DtVrfObjectStateRepository * | localStateRepository () |
| | Gets the local state repository. More...
|
| |
| const DtVrfObjectStateRepository * | localStateRepository () const |
| |
| const DtVrfObjectStateRepository * | const_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 DtTaskVisualizationMap & | taskVisualizations () |
| | Returns the list of task visualizations for this component. More...
|
| |
| virtual bool | taskVisualizationsActive () const |
| | Returns true if task visualizations are currently active 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 void | enable () |
| | Is this component enabled or not. More...
|
| |
| virtual void | disable () |
| |
| 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 DtSimResourceManager & | resourceManager () |
| |
virtual const
DtSimResourceManager & | resourceManager () const |
| |
| | 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 DtReaderWriter & | operator= (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 aliasContainer & | aliases () 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 char * | readerWriterType () const |
| | Used to supply a string type that this reader writer type is. More...
|
| |
| virtual const char * | xmlType () 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 DtReaderWriter * | defaultRWValue () const |
| | The default value to use if the reader/writer object is a variable and that variable is not specified. More...
|
| |
| virtual DtReaderWriter * | defaultRWValue () |
| |
| 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 DtReaderWriterRegistry & | registry () const |
| | Collection of child DtReaderWriter nodes owned by this object. More...
|
| |
| DtReaderWriterRegistry & | registry () |
| |
| virtual DtPropertyInterface * | property () |
| |
| virtual const DtPropertyInterface * | property () const |
| |
| virtual DtString | toXml () const |
| |
| virtual DtRwVariableBindings * | generateVariableBindings () 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...
|
| |
| virtual | ~DtScriptTaskControllerInterface () |
| |
READ ME!
Reactive task entries in the controller represent the state of reactive tasks for an entity. This is to say that it also represents whether it is disabled for a specific entity, enabled for a specific entity, or any other state it may be in (such as currently active). This is important to note when modifying the code in this class as doing things such as clearing out the reactive task list from the PSR is going to result in incorrect behavior.
For instance, if a reactive task is active (reacting), and someone disables it, the entry still exists even after the active reaction completes since we need to remember that it was disabled for this entity. When a scenario loads, all reactive task state is remembered and restored and is then diff'd against the current available reactive tasks and makes intelligent decisions on what to do with the entry (remove it? keep it? add new ones?).
Similarly, during runtime, straight removal of entries must be treated differently in that they should not be removed. Using the function to mark them for deletion (in the entry class, see DtRwScriptReactiveTaskEntry) will guarantee that they will no longer be used by this controller (and the PSR) and will take care of all of the necessary cleanup.
Adding a new entry takes a bit more thought as it does require you to add it to the three maps that contain the current state data in the PSR. See the code for instances in which entries are created and added to the various maps.
Public Member Functions inherited from DtControllerComponent