VR-Forces Development_Version 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 | Protected Attributes
DtEmbeddedEntitiesController Class Reference

DtEmbeddedEntitiesController. More...

Inheritance diagram for DtEmbeddedEntitiesController:
Inheritance graph
[legend]

Public Member Functions

 DtEmbeddedEntitiesController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtEmbeddedEntitiesController ()
virtual const chartype () const
 Returns a string identifies the class type of component.
virtual bool init ()
 Checks for a valid descriptor and sets up the PSR for the controller.
virtual void preFirstTickInit ()
 Populates myNamedEntityMap with the name-keyed contents of the descriptor.
virtual void registerTaskMsgCallbacks ()
virtual DtEmbeddedEntitiesPSRcreatePSR ()
virtual void clearTask (int tskId)
 Overrides DtMultiTaskControllerComponent::clearTask() ensuring that - in addition to clearing the task - DtRwEmbeddedEntityTaskState::resetToIdle() is called for whichever Embedded Entity tskId corresponds to.
virtual void tick ()
 Iterates through myProcessState->entityTaskStateList() calling processEmbeddedEntityCurrentlyInContext() and calling taskComplete() when applicable.
virtual DtUUID getObjectNameOfEmbeddedEntity (std::string eeName, bool &found)
 Returns the object name of the sim object corresponding to the given Embedded Entity name, or DtString::nullString() with found==false if there is no corresponding extant object.
virtual
DtRwEmbeddedEntityStatus::DtEmbeddedEntityDeploymentState 
getStatusOfEmbeddedEntity (std::string eeName, bool &found)
 Returns the deployment status corresponding to the given Embedded Entity name, or DtRwEmbeddedEntityStatus::DtUnknown with found==false if the name is not recognized.
virtual void processForwardTask (DtSimMessage *msg)
 Core member function handling both Set- and Task- Forwarding tasks.
virtual void processTask (DtSimMessage *msg)
 Core member function handling both Deploy and Recover tasks.
virtual std::list
< DtEmbeddedEntity
availableEmbeddedEntities ()
 Builds a representative list of the available Embedded Entities present in the descriptor.
virtual void processEmbeddedEntityCurrentlyInContext (double deltaTime)
 Primary processing methods for Embedded EntitiesProcesses a single Embedded Entity based on the current value of myEeCurrentlyProcessing This method should not be called from outside tick() as it relies on contextual information.
virtual bool checkWithinRecoveryRange ()
 Called from within processEmbeddedEntityCurrentlyInContext() to determine if an Embedded Entity is within configured recovery range when the Embedded Entity's task state is DtWaitingToRecover.
virtual bool performDeployment ()
 Called from within processEmbeddedEntityCurrentlyInContext() when ready for deployment.
virtual bool performRecovery ()
 Called from within processEmbeddedEntityCurrentlyInContext() when ready for recovery.
virtual bool performSetForward ()
 Called from within processEmbeddedEntityCurrentlyInContext() when ready to forward a set message.
virtual bool performTaskForward ()
 Called from within processEmbeddedEntityCurrentlyInContext() when ready for forward a task message.
virtual DtVector calculateSpawnPosOfTarget ()
 Calculates the world position to create the Embedded Entity in context.
virtual bool commandEeToReturn (const DtString &entityName)
 Sends a task to the sim object corresponding the given Embedded Entity causing it to follow this object (it's parent) at the configured relative position, thus simulating a return to base order.
- Public Member Functions inherited from DtMultiTaskControllerComponent
 DtMultiTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtMultiTaskControllerComponent ()
 destructor
virtual void postTick ()
 Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
 Called by the task manager when this controller should start executing the specified task.
virtual void taskComplete (int taskId, bool success)
 This indicates that the specified task is complete.
virtual void suspendTask (int taskId)
 This method is called when the specified running task is being suspended.
virtual DtTaskMessagecurrentTaskMessage (int taskId)
virtual DtSimTaskStatePtr currentTaskState (int taskId) const
virtual int sendSubtask (DtSimTask &task, int taskId)
 Sends subtask to ourself.
virtual int sendTask (DtSimTask &task, const DtUUID &receiver, int taskId, bool actAsSubtask=true, bool useRadio=false)
 Sends a task to another entity, and adds the task to the local subtask status list for tracking its completion.
virtual void clearSubtask (int subtaskId, int taskId)
 Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void addPendingSubtaskId (int subtaskId, int taskId)
 Adds given subtask Id to list of pending subtasks.
virtual bool findPendingSubtaskId (int subtaskId, int taskId)
 Checks to see if given subtaskId exists in our list of pending subtasks.
virtual bool isSubtasked () const
 Returns true if this controller is currently subtasked.
virtual void removePendingSubtaskId (int subtaskId, int taskId)
 Removes pending subtask from list of subtasks for this component.
virtual DtSubtaskStatusEntrysubtaskStatus (int subtaskId, int taskId)
virtual void removeAllPendingSubtaskIds (int taskId)
 Clear all pending subtasks from our list of subtasks for taskId.
virtual std::vector< int > currentPendingSubstaskIds (int taskId) const
 Returns the list of all currently pending subtask ids for this controller.
virtual bool decideToGiveUpTask () const
 The DtMultiTaskControllerComponent does not current support decideToGiveUp.
virtual void giveUpTask ()
 Called when controller is tasked and decideToGiveUp() returns true.
virtual bool taskActive (int taskId) const
 
virtual bool clearTopLevelTasks ()
 If this controller has any top level tasks (not subtasks), they are cleared.
virtual void clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
 Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void clearTasksByType (const DtSimTaskMessageType &taskType)
 Clears any tasks of the specified type running in this controller.
virtual void clearTaskById (int taskId)
 Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfosuspendTaskById (int taskId)
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.
virtual DtPointTaskVisualizationPtr pointTaskVisualization (int taskId, const DtString &name)
 Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr lineTaskVisualization (int taskId, const DtString &name)
 Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (int taskId, const DtString &name)
 Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr textTaskVisualization (int taskId, const DtString &name)
 Finds an existing or creates a new text task visualization with the given name.
virtual void destroyTaskVisualization (int taskId, const DtString &name)
 Destroys an existing task visualization.
virtual void destroyTaskVisualizations (int taskId)
 Destroys all existing task visualizations for the specified task.
- Public Member Functions inherited from DtTaskControllerComponent
 DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtTaskControllerComponent ()
 destructor
virtual void taskNotify (const DtSimTask &task)
 This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual bool showCurrentTaskInGui () const
virtual void setRadio (DtSimRadio *radio)
 Calls registerTaskMsgCallbacks.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Adds a new function for processing the specified task type.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Deprecated form of addTaskProcessorCallback.
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Undoes anything done by addTaskProcessorCallback().
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Deprecated form of removeTaskProcessorCallback.
virtual void enable ()
 Overridden to call registerTaskMsgCallbacks().
virtual void disable ()
 Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void sendTaskCanceled (DtTaskMessage *taskMsg)
 Sends the task canceled report for the specified message.
DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this controller.
virtual void setTasked (bool tasked)
 The current tasked state of this controller.
virtual bool tasked () const
 The current tasked state of this controller.
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtControllerComponent ()
 destructor
virtual DtSimRadioradio ()
 The radio this component is listening to.
virtual void clearTask ()
 Called when you want to clear out this component's task state.
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
virtual void setEntity (DtVrfObject *entity)
 The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual 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_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_SystemcoordinateSystem ()
virtual
DtVrfObjectStateRepository
localStateRepository ()
 Gets the local state repository.
virtual const
DtVrfObjectStateRepository
localStateRepository () const
virtual bool isEnabled ()
 Is this component enabled or not.
virtual void setIsEnabled (bool yesNo)
 Is this component enabled or not.
virtual DtOutputStream & objectConsoleDebug (const DtString &channel="") const
virtual DtOutputStream & objectConsoleVerbose (const DtString &channel="") const
virtual DtOutputStream & objectConsoleInfo (const DtString &channel="") const
virtual DtOutputStream & objectConsoleWarn (const DtString &channel="") const
virtual DtOutputStream & objectConsoleError (const DtString &channel="") const
virtual 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 void addAlias (const DtString &alias)
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.

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void setForwardTaskCallback (DtSimMessage *msg, void *usrData)
 Static function handling set-forwarding task callbacks.
static void taskForwardTaskCallback (DtSimMessage *msg, void *usrData)
 Static function handling task-forwarding task callbacks.
static void deployTaskCallback (DtSimMessage *msg, void *usrData)
 Static function handling deploy task callbacks.
static void recoverTaskCallback (DtSimMessage *msg, void *usrData)
 Static function handling recover task callbacks.

Protected Member Functions

virtual void restoreEmbedded (DtRwEmbeddedEntityStatus *const eeStatus)
 Used by processHostRestore, handles restoration actions for a single Embedded Entity.
- Protected Member Functions inherited from DtMultiTaskControllerComponent
virtual void addCurrentTaskMessage (const DtTaskMessage *taskMessage)
 Adds a new task message to the list of current tasks for this controller.
virtual void clearCurrentTaskMessage (int taskId)
 Removes task with the specified task ID from the list of current tasks for this controller.
virtual void clearPendingSubtasks (int taskId)
 Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void clearSubtasksByType (const DtSimTaskMessageType &taskType, int taskId)
 Clear all subtasks of a given type.
virtual int taskIdWhichStartedSubtask (int subtaskId)
- Protected Member Functions inherited from DtTaskControllerComponent
virtual void suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
 Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo.
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick.
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations.
double calculateNextTaskVisTickTime () const
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT.
bool testInvariant () const
virtual bool createPortGroups ()
 Called by init.
virtual bool createPorts ()
 Called by init.
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 Creates a PSR for this component and registers it with the PSR manager.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()
- Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Protected Attributes

DtEmbeddedEntitiesPSRmyProcessState
const
DtEmbeddedEntitiesDescriptor
myComponentDescriptor
DtRwEmbeddedEntityTaskStatemyEeCurrentlyProcessing
 The task state of the Embedded Entity currently being processed All perform* methods, etc.
std::map< std::string,
DtRwEmbeddedEntity * > 
myNamedEntityMap
 A representation of myComponentDescriptor->embeddedEntities() where DtRwEmbeddedEntity::entityName() is used as a key.
std::list< int > myFaultedTasks
 Holds a list of any task ids that are uncompletable and can't be bound to any given task state such that they can be discarded immediately on the following tick.
virtual void processDeletion (DtVrfObject *spawnedObject)
 Handles keeping the PSR in sync with deletions not performed by the controller.
static void deletionCallback (DtVrfObject *spawnedObject, void *usrData)
 Handles keeping the PSR in sync with deletions not performed by the controller.
virtual void processHostRestore (DtSimMessage *message)
 Sets the deployment state of both destroyed and deleted Embedded Entities to DtRecovered, while passing over deployed Embedded Entities that are alive.
static void hostRestoreCallback (DtSimMessage *message, void *usrData)
 Recovers deleted and destroyed embedded entities when the host object is restored.

Additional Inherited Members

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

Detailed Description

DtEmbeddedEntitiesController.

Handles all tasking and name resolution of Embedded Entities. Handles state transitions, name resolution, task/set forwarding to Embedded Entities, recovery, deployment, etc.

Constructor & Destructor Documentation

DtEmbeddedEntitiesController::DtEmbeddedEntitiesController ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
virtual DtEmbeddedEntitiesController::~DtEmbeddedEntitiesController ( )
virtual

Member Function Documentation

static DtSimComponent* DtEmbeddedEntitiesController::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static
virtual const char* DtEmbeddedEntitiesController::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 DtEmbeddedEntitiesController::init ( )
virtual

Checks for a valid descriptor and sets up the PSR for the controller.

Reimplemented from DtMultiTaskControllerComponent.

virtual void DtEmbeddedEntitiesController::preFirstTickInit ( )
virtual

Populates myNamedEntityMap with the name-keyed contents of the descriptor.

Also populates the PSR with default states for each Embedded entity configured if the PSR does not contain state information yet for that Embedded Entity. (As with newly created objects and systems that have added more Embedded Entities.)

Reimplemented from DtSimComponent.

virtual void DtEmbeddedEntitiesController::registerTaskMsgCallbacks ( )
virtual

Reimplemented from DtTaskControllerComponent.

virtual DtEmbeddedEntitiesPSR* DtEmbeddedEntitiesController::createPSR ( )
virtual
virtual void DtEmbeddedEntitiesController::clearTask ( int  tskId)
virtual

Overrides DtMultiTaskControllerComponent::clearTask() ensuring that - in addition to clearing the task - DtRwEmbeddedEntityTaskState::resetToIdle() is called for whichever Embedded Entity tskId corresponds to.

Reimplemented from DtMultiTaskControllerComponent.

virtual void DtEmbeddedEntitiesController::tick ( )
virtual

Iterates through myProcessState->entityTaskStateList() calling processEmbeddedEntityCurrentlyInContext() and calling taskComplete() when applicable.

Reimplemented from DtSimComponent.

virtual void DtEmbeddedEntitiesController::processEmbeddedEntityCurrentlyInContext ( double  deltaTime)
virtual

Primary processing methods for Embedded EntitiesProcesses a single Embedded Entity based on the current value of myEeCurrentlyProcessing This method should not be called from outside tick() as it relies on contextual information.

virtual bool DtEmbeddedEntitiesController::checkWithinRecoveryRange ( )
virtual

Called from within processEmbeddedEntityCurrentlyInContext() to determine if an Embedded Entity is within configured recovery range when the Embedded Entity's task state is DtWaitingToRecover.

Will set the task state to DtUnable if the corresponding sim object becomes destroyed or deleted.

virtual bool DtEmbeddedEntitiesController::performDeployment ( )
virtual

Called from within processEmbeddedEntityCurrentlyInContext() when ready for deployment.

Performs the actual creation of a sim object.

virtual bool DtEmbeddedEntitiesController::performRecovery ( )
virtual

Called from within processEmbeddedEntityCurrentlyInContext() when ready for recovery.

virtual bool DtEmbeddedEntitiesController::performSetForward ( )
virtual

Called from within processEmbeddedEntityCurrentlyInContext() when ready to forward a set message.

virtual bool DtEmbeddedEntitiesController::performTaskForward ( )
virtual

Called from within processEmbeddedEntityCurrentlyInContext() when ready for forward a task message.

virtual DtVector DtEmbeddedEntitiesController::calculateSpawnPosOfTarget ( )
virtual

Calculates the world position to create the Embedded Entity in context.

virtual bool DtEmbeddedEntitiesController::commandEeToReturn ( const DtString entityName)
virtual

Sends a task to the sim object corresponding the given Embedded Entity causing it to follow this object (it's parent) at the configured relative position, thus simulating a return to base order.

virtual DtUUID DtEmbeddedEntitiesController::getObjectNameOfEmbeddedEntity ( std::string  eeName,
bool found 
)
virtual

Returns the object name of the sim object corresponding to the given Embedded Entity name, or DtString::nullString() with found==false if there is no corresponding extant object.

virtual DtRwEmbeddedEntityStatus::DtEmbeddedEntityDeploymentState DtEmbeddedEntitiesController::getStatusOfEmbeddedEntity ( std::string  eeName,
bool found 
)
virtual

Returns the deployment status corresponding to the given Embedded Entity name, or DtRwEmbeddedEntityStatus::DtUnknown with found==false if the name is not recognized.

static void DtEmbeddedEntitiesController::setForwardTaskCallback ( DtSimMessage msg,
void *  usrData 
)
static

Static function handling set-forwarding task callbacks.

static void DtEmbeddedEntitiesController::taskForwardTaskCallback ( DtSimMessage msg,
void *  usrData 
)
static

Static function handling task-forwarding task callbacks.

virtual void DtEmbeddedEntitiesController::processForwardTask ( DtSimMessage msg)
virtual

Core member function handling both Set- and Task- Forwarding tasks.

static void DtEmbeddedEntitiesController::deployTaskCallback ( DtSimMessage msg,
void *  usrData 
)
static

Static function handling deploy task callbacks.

static void DtEmbeddedEntitiesController::recoverTaskCallback ( DtSimMessage msg,
void *  usrData 
)
static

Static function handling recover task callbacks.

virtual void DtEmbeddedEntitiesController::processTask ( DtSimMessage msg)
virtual

Core member function handling both Deploy and Recover tasks.

virtual std::list<DtEmbeddedEntity> DtEmbeddedEntitiesController::availableEmbeddedEntities ( )
virtual

Builds a representative list of the available Embedded Entities present in the descriptor.

static void DtEmbeddedEntitiesController::deletionCallback ( DtVrfObject spawnedObject,
void *  usrData 
)
static

Handles keeping the PSR in sync with deletions not performed by the controller.

virtual void DtEmbeddedEntitiesController::processDeletion ( DtVrfObject spawnedObject)
virtual

Handles keeping the PSR in sync with deletions not performed by the controller.

static void DtEmbeddedEntitiesController::hostRestoreCallback ( DtSimMessage message,
void *  usrData 
)
static

Recovers deleted and destroyed embedded entities when the host object is restored.

virtual void DtEmbeddedEntitiesController::processHostRestore ( DtSimMessage message)
virtual

Sets the deployment state of both destroyed and deleted Embedded Entities to DtRecovered, while passing over deployed Embedded Entities that are alive.

Safely callable with a null message if necessary.

virtual void DtEmbeddedEntitiesController::restoreEmbedded ( DtRwEmbeddedEntityStatus *const  eeStatus)
protectedvirtual

Used by processHostRestore, handles restoration actions for a single Embedded Entity.

Member Data Documentation

DtEmbeddedEntitiesPSR* DtEmbeddedEntitiesController::myProcessState
protected
const DtEmbeddedEntitiesDescriptor* DtEmbeddedEntitiesController::myComponentDescriptor
protected
DtRwEmbeddedEntityTaskState* DtEmbeddedEntitiesController::myEeCurrentlyProcessing
protected

The task state of the Embedded Entity currently being processed All perform* methods, etc.

are based off this value.

std::map<std::string, DtRwEmbeddedEntity*> DtEmbeddedEntitiesController::myNamedEntityMap
protected

A representation of myComponentDescriptor->embeddedEntities() where DtRwEmbeddedEntity::entityName() is used as a key.

Created in preFirstTickInit() and used internally for code clarity.

std::list<int> DtEmbeddedEntitiesController::myFaultedTasks
protected

Holds a list of any task ids that are uncompletable and can't be bound to any given task state such that they can be discarded immediately on the following tick.


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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)