VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
DtScriptReactiveTaskController Class Reference

READ ME! More...

Inheritance diagram for DtScriptReactiveTaskController:
Inheritance graph
[legend]

Public Member Functions

 DtScriptReactiveTaskController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *parentRegistry)
virtual ~DtScriptReactiveTaskController ()
virtual DtString type () const
 This returns a string from compTypes.h, and identifies the type of component.
virtual bool init ()
 Calls setRadio()
virtual void preFirstTickInit ()
 called from preprocess if appropriate
virtual void tick ()
 This gives the thread of control to the component.
virtual std::list
< DtScriptedTaskTask
reactiveTaskStatus () const
virtual bool isReactiveTaskEnabled (const DtString &scriptId) const
virtual void notifySuspend (const DtString &scriptId, int taskId)
virtual void notifyResume (const DtString &scriptId, int taskId)
virtual void processReturnScriptInterface (const DtString &scriptId, int taskId, boost::shared_ptr< DtScriptInterface > iFace)
virtual void enableReactiveTask (const DtString &scriptId, DtRwVariableBindings &params, bool resetIfEnabled=false)
virtual bool createPSR ()
virtual std::vector< std::string > availableReactiveTasks () const
virtual DtString systemFor (const DtString &scriptId) const
virtual void scriptSetTickPeriod (const DtString &scriptId, double period)
 No-op. This is not relevant for reactive tasks.
virtual void scriptSetRespondToNewSensorContacts (const DtString &scriptId, bool tick)
 No-op. This is not relevant for reactive tasks.
virtual void scriptTaskComplete (int taskId, bool success)
 No-op. This is not relevant for reactive tasks.
virtual int scriptSendSubtask (DtSimTask &task, int parentTaskId)
 No-op. This is not relevant for reactive tasks.
virtual std::vector< intscriptPendingSubstaskIds (int taskId)
 No-op. This is not relevant for reactive tasks.
virtual DtSubtaskStatusEntryscriptSubtaskStatus (int subtaskId, int parentTaskId)
 No-op. This is not relevant for reactive tasks.
virtual void scriptClearSubtask (int subtaskId, int parentTaskId)
 No-op. This is not relevant for reactive tasks.
virtual int scriptSendTask (DtSimTask &task, const DtString &entityName, int parentTaskId, bool actAsSubtask=true)
 No-op. This is not relevant for reactive tasks.
virtual int askUserQuestion (const DtString &scriptId, const DtTranslatableStream &title, const DtTranslatableStream &message, const std::vector< DtTranslatableStream > &options, int displayFlag)
 No-op. This is not relevant for reactive tasks.
virtual int statusOfUserQuestion (int questionId)
 No-op. This is not relevant for reactive tasks.
virtual void cancelUserQuestion (int questionId)
 No-op. This is not relevant for reactive tasks.
virtual void addReactiveTaskType (const DtString &, const DtString &system="")
 Adds this task to be considered a reactive task of this entity.
virtual void notifyScriptTaskError (const DtString &scriptId, int taskId)
 No-op. This is not relevant for reactive tasks.
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtControllerComponent ()
 destructor
virtual DtSimRadioradio ()
 The radio this component is listening to.
virtual void taskNotify (const DtSimTask &task)
 This is used by the entity to notify all controllers that a new task has been received.
virtual void clearTask ()
 Called when you want to clear out this component's task state.
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void preprocess ()
 Perform parallel preprocessing prior to tick and similar computations.
virtual void parallelTick ()
 called in parallel
virtual void postTick ()
 This function is called immediately after tick() is called.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
virtual void setEntity (DtVrfObject *entity)
 The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
virtual void setListItem (DtListItem *item)
 Used by DtComponentList.
virtual DtListItem * listItem ()
virtual void putData (FILE *fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void addInputPort (DtInputPort *port)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPort (DtInputPort *port)
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name.
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component.
virtual void addOutputPort (DtOutputPort *port)
 Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void removeOutputPort (DtOutputPort *port)
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name.
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component.
virtual void addInputPortGroup (DtInputPortGroup *group)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name.
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component.
virtual void addOutputPortGroup (DtOutputPortGroup *group)
 Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name.
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component.
virtual int priority () const
 Return the current connection priority for this component.
virtual void setPriority (int priority)
 Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void setDT (double deltaT)
 Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
 The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const
DtComponentDescriptor
componentDescriptor () const
virtual bool tickWhileDestroyed () const
 If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManagerpsrManager ()
virtual DtString componentFullName () const
virtual DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorldphysicalWorld () const
virtual DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrainterrainAttachedTo () const
virtual DtVrfObjectentity ()
 Gets the entity.
virtual const DtVrfObjectentity () const
virtual DtSimManagersimManager ()
 Gets the sim manager.
virtual const DtSimManagersimManager () const
virtual const Coordinate_System * coordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System * coordinateSystem ()
virtual
DtVrfObjectStateRepository
localStateRepository ()
 Gets the local state repository.
virtual const
DtVrfObjectStateRepository
localStateRepository () const
virtual void enable ()
 Is this component enabled or not.
virtual void disable ()
 Is this component enabled or not.
virtual bool isEnabled ()
 Is this component enabled or not.
virtual void setIsEnabled (bool yesNo)
 Is this component enabled or not.
virtual DtOutputStreamobjectConsoleDebug () const
virtual DtOutputStreamobjectConsoleVerbose () const
virtual DtOutputStreamobjectConsoleInfo () const
virtual DtOutputStreamobjectConsoleWarn () const
virtual DtOutputStreamobjectConsoleError () const
virtual DtSimResourceManagerresourceManager ()
virtual const
DtSimResourceManager
resourceManager () const
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
const DtReaderWriteroperator= (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 aliasContaineraliases () 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () const
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
std::string debugText () const
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated.
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename.
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid.
virtual bool fromXmlFile (const DtFilename &)
 Restires object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value.
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference.
- Public Member Functions inherited from DtScriptTaskControllerInterface
virtual ~DtScriptTaskControllerInterface ()

Static Public Member Functions

static void setReactiveTaskCallback (DtSimMessage *msg, void *usr)
static void scriptUpdatedCallback (const DtScriptedTaskManagerCallbackInfo &info, void *usr)
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *parentRegistry)

Protected Member Functions

 DtScriptReactiveTaskController ()
 DtScriptReactiveTaskController (const DtScriptReactiveTaskController &other)
DtScriptReactiveTaskControlleroperator= (const DtScriptReactiveTaskController &other)
virtual bool shouldInvokeCheck (DtRwScriptReactiveTaskEntry *entry)
virtual
DtRwScriptReactiveTaskEntry
createDefaultEntry (const DtString &scriptId, const DtString &system="")
virtual bool createAndInitScriptInterface (DtRwScriptReactiveTaskEntry *entry, DtRwVariableBindings *params, bool loadState=false)
virtual void activateReactiveTask (DtRwScriptReactiveTaskEntry *entry)
virtual void disableReactiveTask (DtRwScriptReactiveTaskEntry *entry, bool cancelActive)
virtual void processSetReactiveTaskCallback (DtSetDataRequest *setMsg)
virtual void processSetCancel (DtSetReactiveTaskCancel *setMsg)
virtual void processSetDisabled (DtSetReactiveTaskDisabled *setMsg)
virtual void processSetEnabled (DtSetReactiveTaskEnabled *setMsg)
virtual void processSetPriority (DtSetReactiveTaskPriority *setMsg)
virtual void processSetTable (DtSetReactiveTaskTable *setMsg)
virtual void setupReactiveTasks ()
virtual void processScriptUpdatedCallback (const DtScriptedTaskManagerCallbackInfo &info)
virtual bool doesScriptIdApply (const DtString &scriptId) const
virtual bool isForMyEntityType (const DtScriptedTaskMetaData &metaData) const
virtual void processUserQuestionOperation (DtSimMessage *)
virtual void sendOffOutstandingQuestionFor (const DtString &scriptId)
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator
virtual void setRadio (DtSimRadio *radio)
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT, common between preprocess and timedTick.
bool testInvariant () const
virtual bool createPortGroups ()
 Called by init.
virtual bool createPorts ()
 Called by init.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()
- Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()
- Protected Member Functions inherited from DtScriptTaskControllerInterface
 DtScriptTaskControllerInterface ()
 DtScriptTaskControllerInterface (const DtScriptTaskControllerInterface &other)
DtScriptTaskControllerInterfaceoperator= (const DtScriptTaskControllerInterface &other)

Static Protected Member Functions

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

Protected Attributes

DtScriptReactiveTaskControllerPSRmyProcessState
DtForceType myCurrentForceType
std::map< DtString, DtStringmyAdditionalReactiveTasks
- Protected Attributes inherited from DtControllerComponent
DtSimRadiomyRadio
 Controller components can send messages.
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
DtVrfObjectStateRepositorymyLocalStateRepository
DtSimManagermySimManager
DtComponentSystemmySystem
 Pointer to the DtComponentSystem that this component belongs.
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.
bool myFirstTick
 Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptormyComponentDescriptor
- 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.
bool myInvalid
 Set to true if there is a problem reading this item.

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString > 
aliasContainer
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
typedef std::vector< DtFilename > SearchPaths
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- Protected Types inherited from 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
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

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.

Constructor & Destructor Documentation

DtScriptReactiveTaskController::DtScriptReactiveTaskController ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc,
DtReaderWriterRegistry parentRegistry 
)
virtual DtScriptReactiveTaskController::~DtScriptReactiveTaskController ( )
virtual
DtScriptReactiveTaskController::DtScriptReactiveTaskController ( )
protected
DtScriptReactiveTaskController::DtScriptReactiveTaskController ( const DtScriptReactiveTaskController other)
protected

Member Function Documentation

virtual DtString DtScriptReactiveTaskController::type ( ) const
virtual

This returns a string from compTypes.h, and identifies the type of component.

Reimplemented from DtControllerComponent.

virtual bool DtScriptReactiveTaskController::init ( )
virtual

Calls setRadio()

Reimplemented from DtControllerComponent.

virtual void DtScriptReactiveTaskController::preFirstTickInit ( )
virtual

called from preprocess if appropriate

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 DtScriptReactiveTaskController::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 std::list<DtScriptedTaskTask> DtScriptReactiveTaskController::reactiveTaskStatus ( ) const
virtual
virtual bool DtScriptReactiveTaskController::isReactiveTaskEnabled ( const DtString scriptId) const
virtual
virtual void DtScriptReactiveTaskController::notifySuspend ( const DtString scriptId,
int  taskId 
)
virtual
virtual void DtScriptReactiveTaskController::notifyResume ( const DtString scriptId,
int  taskId 
)
virtual
virtual void DtScriptReactiveTaskController::processReturnScriptInterface ( const DtString scriptId,
int  taskId,
boost::shared_ptr< DtScriptInterface iFace 
)
virtual
virtual void DtScriptReactiveTaskController::enableReactiveTask ( const DtString scriptId,
DtRwVariableBindings params,
bool  resetIfEnabled = false 
)
virtual
static void DtScriptReactiveTaskController::setReactiveTaskCallback ( DtSimMessage msg,
void *  usr 
)
static
static void DtScriptReactiveTaskController::scriptUpdatedCallback ( const DtScriptedTaskManagerCallbackInfo info,
void *  usr 
)
static
virtual void DtScriptReactiveTaskController::scriptSetTickPeriod ( const DtString scriptId,
double  period 
)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::scriptSetRespondToNewSensorContacts ( const DtString scriptId,
bool  tick 
)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::scriptTaskComplete ( int  taskId,
bool  success 
)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual int DtScriptReactiveTaskController::scriptSendSubtask ( DtSimTask task,
int  parentTaskId 
)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual std::vector<int> DtScriptReactiveTaskController::scriptPendingSubstaskIds ( int  taskId)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual DtSubtaskStatusEntry* DtScriptReactiveTaskController::scriptSubtaskStatus ( int  subtaskId,
int  parentTaskId 
)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::scriptClearSubtask ( int  subtaskId,
int  parentTaskId 
)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual int DtScriptReactiveTaskController::scriptSendTask ( DtSimTask task,
const DtString entityName,
int  parentTaskId,
bool  actAsSubtask = true 
)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual int DtScriptReactiveTaskController::askUserQuestion ( const DtString scriptId,
const DtTranslatableStream title,
const DtTranslatableStream message,
const std::vector< DtTranslatableStream > &  options,
int  displayFlag 
)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual int DtScriptReactiveTaskController::statusOfUserQuestion ( int  questionId)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::cancelUserQuestion ( int  questionId)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::addReactiveTaskType ( const DtString ,
const DtString system = "" 
)
virtual

Adds this task to be considered a reactive task of this entity.

virtual void DtScriptReactiveTaskController::notifyScriptTaskError ( const DtString scriptId,
int  taskId 
)
virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual bool DtScriptReactiveTaskController::createPSR ( )
virtual
static DtSimComponent* DtScriptReactiveTaskController::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc,
DtReaderWriterRegistry parentRegistry 
)
static
virtual std::vector<std::string> DtScriptReactiveTaskController::availableReactiveTasks ( ) const
virtual
virtual DtString DtScriptReactiveTaskController::systemFor ( const DtString scriptId) const
virtual
DtScriptReactiveTaskController& DtScriptReactiveTaskController::operator= ( const DtScriptReactiveTaskController other)
protected
virtual bool DtScriptReactiveTaskController::shouldInvokeCheck ( DtRwScriptReactiveTaskEntry entry)
protectedvirtual
virtual DtRwScriptReactiveTaskEntry* DtScriptReactiveTaskController::createDefaultEntry ( const DtString scriptId,
const DtString system = "" 
)
protectedvirtual
virtual bool DtScriptReactiveTaskController::createAndInitScriptInterface ( DtRwScriptReactiveTaskEntry entry,
DtRwVariableBindings params,
bool  loadState = false 
)
protectedvirtual
virtual void DtScriptReactiveTaskController::activateReactiveTask ( DtRwScriptReactiveTaskEntry entry)
protectedvirtual
virtual void DtScriptReactiveTaskController::disableReactiveTask ( DtRwScriptReactiveTaskEntry entry,
bool  cancelActive 
)
protectedvirtual
virtual void DtScriptReactiveTaskController::processSetReactiveTaskCallback ( DtSetDataRequest setMsg)
protectedvirtual
virtual void DtScriptReactiveTaskController::processSetCancel ( DtSetReactiveTaskCancel setMsg)
protectedvirtual
virtual void DtScriptReactiveTaskController::processSetDisabled ( DtSetReactiveTaskDisabled setMsg)
protectedvirtual
virtual void DtScriptReactiveTaskController::processSetEnabled ( DtSetReactiveTaskEnabled setMsg)
protectedvirtual
virtual void DtScriptReactiveTaskController::processSetPriority ( DtSetReactiveTaskPriority setMsg)
protectedvirtual
virtual void DtScriptReactiveTaskController::processSetTable ( DtSetReactiveTaskTable setMsg)
protectedvirtual
virtual void DtScriptReactiveTaskController::setupReactiveTasks ( )
protectedvirtual
virtual void DtScriptReactiveTaskController::processScriptUpdatedCallback ( const DtScriptedTaskManagerCallbackInfo info)
protectedvirtual
virtual bool DtScriptReactiveTaskController::doesScriptIdApply ( const DtString scriptId) const
protectedvirtual
virtual bool DtScriptReactiveTaskController::isForMyEntityType ( const DtScriptedTaskMetaData metaData) const
protectedvirtual
static void DtScriptReactiveTaskController::userQuestionOperationCallback ( DtSimMessage msg,
void *  usrData 
)
staticprotected
virtual void DtScriptReactiveTaskController::processUserQuestionOperation ( DtSimMessage )
protectedvirtual
virtual void DtScriptReactiveTaskController::sendOffOutstandingQuestionFor ( const DtString scriptId)
protectedvirtual

Member Data Documentation

DtScriptReactiveTaskControllerPSR* DtScriptReactiveTaskController::myProcessState
protected
DtForceType DtScriptReactiveTaskController::myCurrentForceType
protected
std::map<DtString, DtString> DtScriptReactiveTaskController::myAdditionalReactiveTasks
protected

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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)