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

DtDamageAdjudicationActuator is responsible for adjudicating the damage from appropriate detonations. More...

Inheritance diagram for DtDamageAdjudicationActuator:
Inheritance graph
[legend]

Public Member Functions

 DtDamageAdjudicationActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtDamageAdjudicationActuator ()
 destructor Unregisters with the detonation manager. More...
 
virtual bool init ()
 Registers callbacks with the detonation manager. More...
 
virtual bool createPSR ()
 Create a process state repository (DtDamageAdjudicationPSR), or a different type if it is specified in the OPD. More...
 
virtual bool adjudicateDirectDamage (const DtDetonationContext &detonationContext)
 When a detonation context is received, from the detonation manager, it is processed in order to determine the appropriate damage to the entity. More...
 
virtual bool adjudicateCollateralDamage (const DtDetonationContext &detonationContext)
 Determines collateral damage from an impact near the entity. More...
 
virtual const chartype () const
 Returns a string identifies the class type of component. More...
 
virtual void tick ()
 Determines the destroyed status of the entity, and then checks to see if the flaming and smoking indicators should be turned off. More...
 
- Public Member Functions inherited from DtActuatorComponent
virtual ~DtActuatorComponent ()
 destructor More...
 
virtual DtSimRadioradio ()
 
virtual bool tickWhileDestroyed () const
 By default, all actuators tick when the entity is destroyed. More...
 
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtSimComponent ()
 destructor More...
 
virtual void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component. More...
 
DtComponentSystemparentSystem () const
 
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager. More...
 
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values. More...
 
virtual void preFirstTickInit ()
 This function can be overridden to initialize a component before it is ticked for the first time. 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 DtSimComponentnextComponent ()
 List management functions. More...
 
virtual DtSimComponentprevComponent ()
 
virtual void setListItem (DtListItem *item)
 Used by DtComponentList. More...
 
virtual DtListItem * listItem ()
 
virtual void putData (std::string &fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class. More...
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 getData is just used to get us past the type in the data stream, since it's not actual stored. More...
 
virtual void addInputPort (DtInputPort *port)
 Adds this input port to the components input port list so that other components can look it up and attach to it. More...
 
virtual void removeInputPort (DtInputPort *port)
 
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name. More...
 
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component. More...
 
virtual void addOutputPort (DtOutputPort *port)
 Adds this output port to the components output port list so that other components can look it up and attach to it. More...
 
virtual void removeOutputPort (DtOutputPort *port)
 
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name. More...
 
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component. More...
 
virtual void addInputPortGroup (DtInputPortGroup *group)
 Adds this input port to the components input port list so that other components can look it up and attach to it. More...
 
virtual void removeInputPortGroup (DtInputPortGroup *group)
 
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name. More...
 
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component. More...
 
virtual void addOutputPortGroup (DtOutputPortGroup *group)
 Adds this output port group to the components output port group list so that other components can look it up and attach to it. More...
 
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
 
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name. More...
 
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component. More...
 
virtual int priority () const
 Return the current connection priority for this component. More...
 
virtual void setPriority (int priority)
 Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value. More...
 
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...
 
virtual void setDT (double deltaT)
 Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary. More...
 
virtual void setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
 The component descriptor specified in the order of battle file or parameter file that was used to create this component. More...
 
virtual const
DtComponentDescriptor
componentDescriptor () const
 
DtVrfProcessStateRepositoryManagerpsrManager ()
 
virtual const DtSymbolStringcomponentFullName () const
 
DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in. More...
 
const DtPhysicalWorldphysicalWorld () const
 
DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any. More...
 
const DtAttachedTerrainterrainAttachedTo () const
 
DtVrfObjectentity ()
 Gets the entity. More...
 
const DtVrfObjectentity () const
 
const DtVrfObjectconst_entity () const
 You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...
 
DtSimManagersimManager ()
 Gets the sim manager. More...
 
const DtSimManagersimManager () const
 
const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...
 
DtVrfObjectStateRepositorylocalStateRepository ()
 Gets the local state repository. More...
 
const DtVrfObjectStateRepositorylocalStateRepository () const
 
const DtVrfObjectStateRepositoryconst_localStateRepository () const
 You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...
 
virtual DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component. More...
 
virtual bool 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 onRestore ()
 Called whenever a component is restored. Default is no-op. 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 DtSimResourceManagerresourceManager ()
 
virtual const
DtSimResourceManager
resourceManager () const
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor More...
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor More...
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator More...
 
bool operator== (const DtReaderWriter &) const
 Equivalence operator. More...
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 destructor More...
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file. More...
 
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op. More...
 
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op. More...
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream. More...
 
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op. More...
 
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op. More...
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More...
 
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object. More...
 
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object. More...
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 Set read-only flag. More...
 
bool isReadonly () const
 
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
 
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment. More...
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false. More...
 
virtual void setName (const DtString &)
 Set the name of the object. More...
 
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable. More...
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children. More...
 
virtual std::list
< DtVariableNameType
unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain. More...
 
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference. More...
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More...
 
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated. More...
 
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time. More...
 
virtual bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called. More...
 
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values. More...
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively. More...
 
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference. More...
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here. More...
 
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () const
 Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
 
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename. More...
 
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid. More...
 
virtual bool fromXmlFile (const DtFilename &)
 Restores object from given xml file. More...
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data. More...
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference. More...
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value. More...
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference. More...
 

Static Public Member Functions

static bool processDirectDetonationCallback (const DtDetonationContext &detonationContext, void *usr)
 The detonation manager uses this function to notify the actuator of when it needs to process an entity detonation for the entity. More...
 
static bool processCollateralDetonationCallback (const DtDetonationContext &detonationContext, void *usr)
 The detonation manager uses this function to notify the actuator of when it needs to process an ground detonation to determine any collateral damage for the entity. More...
 
static void setDestroyedCallback (DtSimMessage *msg, void *usrData)
 Calls setDestroyed() More...
 
static void setRestoredCallback (DtSimMessage *msg, void *usrData)
 Calls setRestored() More...
 
static void setInvulnerableCallback (DtSimMessage *msg, void *usrData)
 Calls processSetInvulnerable() More...
 
static void setFunctionDamageStatusCallback (DtSimMessage *msg, void *usrData)
 Calls processSetFunctionDamageStatus() More...
 
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtSimComponent
static DtSimComponentMarkThreadSafe (DtSimComponent *)
 Marks an instance of a component as being thread safe. More...
 
static DtSimComponentFactoryfactory ()
 A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...
 
static void setFactory (DtSimComponentFactory *factory)
 
static DtSimComponentcreateComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More...
 
static void addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
 Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList
nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const chartheXmlType ()
 The type that is used when archiving to an XML stream. More...
 
static const DtFilename & appPath ()
 Gets the current working directory. More...
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory. More...
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within. More...
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP. More...
 

Protected Member Functions

virtual void getDirectFireSurfaceAndAngleOfIncidence (DtDetonationContext &detonationContext)
 Determines the fire surface and the angle of incidence of the detonation from a direct fire weapon and puts them in the specified detonation context. More...
 
virtual void getIndirectFireSurfaceAndAngleOfIncidence (DtDetonationContext &detonationContext)
 Determines the fire surface and the angle of incidence of the detonation and puts them in the specified detonation context. More...
 
virtual DtSymbolString getSurface (DtBoundingVolumeFace impactSurface)
 
virtual bool getProbabilities (const DtDetonationContext &detonationContext, DtPrbValueList &probabilities, bool isDirectDamage=true) const
 Gets the list of probabilities from the damage component descriptor's damage tables. More...
 
virtual bool isCatastrophicallyKilled (DtPrbValueList &probabilities, DtSymbolString catastrophicKillString) const
 Determines if the entity is catastrophically killed by the detonation with the specified list of probabilities. More...
 
virtual bool isFirepowerKilled (DtPrbValueList &probabilities, DtSymbolString firepowerKillString) const
 Determines if the entity is firepower killed by the detonation with the specified list of probabilities. More...
 
virtual bool isMobilityKilled (DtPrbValueList &probabilities, DtSymbolString mobilityKillString) const
 Determines if the entity is mobility killed by the detonation with the specified list of probabilities. More...
 
virtual bool isSensorsKilled (DtPrbValueList &probabilities, DtSymbolString sensorsKillString) const
 Determines if the entity has its sensors killed by the detonation with the specified list of probabilities. More...
 
virtual DtSymbolString catastrophicKillString () const
 
virtual DtSymbolString mobilityKillString () const
 
virtual DtSymbolString firepowerKillString () const
 
virtual DtSymbolString sensorsKillString () const
 
virtual bool protectedFromCollateralDamageByEmbarkation () const
 Returns true if this entity is protected from collateral damage because it is embarked. More...
 
virtual void determineDestroyedStatus ()
 This function determines if anything we are attached to are occupying was destroyed (last tick). More...
 
virtual void setDestroyed ()
 Calls setDestroyed on the myLocalStateRepository. More...
 
virtual void setRestored ()
 Re-registers the entity to receive detonations since it is now restored. More...
 
virtual void processSetInvulnerable (DtSimMessage *msg)
 Tells the entity to either ignore or process damage caused by detonations. More...
 
virtual void processSetFunctionDamageStatus (DtSimMessage *msg)
 Updates the function (fire power, mobility, and sensors) damage status of the entity. More...
 
virtual bool registerForDetonations ()
 Registers the entity to receive notification of appropriate detonations and notes that the callbacks have been registered. More...
 
virtual bool unregisterForDetonations ()
 Unregisters the entity to receive notification of appropriate detonations, and notes that the callbacks have been unregistered. More...
 
virtual void setMobilityKilled ()
 Calls setMobilityKilled on the myLocalStateRepository. More...
 
virtual void setFirepowerKilled ()
 Calls setFirepowerKilled on the myLocalStateRepository. More...
 
virtual void setSensorsKilled ()
 Calls setSensorsKilled on the myLocalStateRepository. More...
 
virtual void setRadio (DtSimRadio *radio)
 Overrides this so it can register its interest the set destroyed message. More...
 
virtual void triggerDestructionExplosions ()
 Starts the destruction explosions if they are configured in the descriptor. More...
 
virtual void updateDestructionExplosions ()
 Called each tick while the entity is destroyed to create any new destruction detonations that should occur since the previous tick. More...
 
virtual void sendDetonation (const DtRwExplosionEntry &explosionEntry)
 
virtual DtVector positionOnEntity (const DtVector &percentOffset)
 
virtual bool isRegisteredForDetonations () const
 Keep track of whether or not we're registered for detonations direct or collateral. More...
 
virtual void setIsRegisteredForDetonations (bool yesOrNo)
 
- Protected Member Functions inherited from DtActuatorComponent
 DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
 DtActuatorComponent ()
 Default constructor; should not be called. More...
 
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT. More...
 
bool testInvariant () const
 
virtual bool createPortGroups ()
 Called by init. More...
 
virtual bool createPorts ()
 Called by init. More...
 
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 Creates a PSR for this component and registers it with the PSR manager. More...
 
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick. More...
 
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations for this component. More...
 
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization. More...
 
virtual DtPointTaskVisualizationPtr pointTaskVisualization (const DtString &name)
 Finds an existing or creates a new point task visualization with the given name. More...
 
virtual DtLineTaskVisualizationPtr lineTaskVisualization (const DtString &name)
 Finds an existing or creates a new line task visualization with the given name. More...
 
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (const DtString &name)
 Finds an existing or creates a new area task visualization with the given name. More...
 
virtual DtTextTaskVisualizationPtr textTaskVisualization (const DtString &name)
 Finds an existing or creates a new text task visualization with the given name. More...
 
double calculateNextTaskVisTickTime () const
 Determines the next time the task visualizations should be ticked. More...
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 

Protected Attributes

DtDamageAdjudicationComponentDescriptormyDamageComponentDescriptor
 
DtDamageAdjudicationPSRmyProcessState
 
- Protected Attributes inherited from DtActuatorComponent
DtSimRadiomyRadio
 Actuators can send messages. More...
 
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
 
DtVrfObjectStateRepositorymyLocalStateRepository
 
DtSimManagermySimManager
 
DtComponentSystemmySystem
 Pointer to the DtComponentSystem that this component belongs. More...
 
DtListItem * myListItem
 
DtInputPortMap myInputPortList
 
DtOutputPortMap myOutputPortList
 
DtInputPortGroupMap myInputPortGroupList
 
DtOutputPortGroupMap myOutputPortGroupList
 
int myPriority
 
double myMinTickPeriod
 
double myMinTickPeriodVariance
 
double myNextTickTime
 
double myLastTickSimTime
 
double myDT
 
bool myIsEnabled
 Indicates whether this component should be enabled for ticking or not. More...
 
bool myFirstTick
 Initialized to true in the constructor, set to false by the first call to postTick. More...
 
bool myIsThreadSafe
 Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...
 
const DtComponentDescriptormyComponentDescriptor
 
std::list
< DtVrfProcessStateRepository * > 
myComponentPsrs
 List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...
 
bool myTickEveryFrame
 Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...
 
DtTaskVisualizationMap myTaskVisualizations
 The visualization objects to be drawn for this component. More...
 
double myNextTaskVisTickTime
 The next tick time for updating the task visualizations. More...
 
DtSymbolString myFullComponentName
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 

Private Member Functions

 DtDamageAdjudicationActuator ()
 Default constructor; not implemented. More...
 
 DtDamageAdjudicationActuator (const DtDamageAdjudicationActuator &orig)
 copy constructor; not implemented More...
 
DtDamageAdjudicationActuatoroperator= (const DtDamageAdjudicationActuator &orig)
 assignment operator; not implemented More...
 

Private Attributes

bool myIsRegisteredForDetonations
 Keep track of whether or not we've registered detonation callbacks with detonation manager. More...
 

Additional Inherited Members

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

Detailed Description

DtDamageAdjudicationActuator is responsible for adjudicating the damage from appropriate detonations.

End User Description: DtDamageAdjudicationActuator provides a simple damage model.

The damage actuator registers callbacks with the DtDetonationManager, so that it is notified of the appropriate detonations. It holds 2 damage tables. One for direct fire damage( Rifles, tank 120mm) where detonation result is an entity impact or entity proximate impact. And one for collateral damage– there was a detonation near the entity where it might take secondary damage from the detonation. This would be things like artillery fire, or damage from standing next to something else thats been hit. An example would be an entity standing very close to another that's been shot with a HE round. This is also the place people could add ricochet effects. During initialization, the damage actuator will run thru each damage table and registers the appropriate callback for the table with the detonation manager. When registering both the maximum range of the weapon and its munition type are registered. When an appropriate detonation occurs (see the DtDetonationManager for more information on what constitutes an appropriate detonation.), the registered callback is called with the appropriate detonation context (contains all relevant information for the detonation).

The actuator's callback uses this information, which includes the ammunition type, range, surface, and angle of incidence of the impact, to look up the damage results in the appropriate damage table, specified for that ammunition type.

If the entity is destroyed, the damage actuator sets its flaming and smoking indicators, and leaves these on for the duration specified in the component descriptor. It also unregisters for further notice of detonations.

Uses Descriptor Type: DtDamageAdjudicationComponentDescriptor

Constructor & Destructor Documentation

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

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
virtual DtDamageAdjudicationActuator::~DtDamageAdjudicationActuator ( )
virtual

destructor Unregisters with the detonation manager.

DtDamageAdjudicationActuator::DtDamageAdjudicationActuator ( )
private

Default constructor; not implemented.

DtDamageAdjudicationActuator::DtDamageAdjudicationActuator ( const DtDamageAdjudicationActuator orig)
private

copy constructor; not implemented

Member Function Documentation

virtual bool DtDamageAdjudicationActuator::init ( )
virtual

Registers callbacks with the detonation manager.

Provides the detonation manager a pointer to the component's entity ,the entity's global ID, the munition type the entity can be damaged by, and the maximum range within which this munition can cause damage to the entity. Registers 2 callbacks, one registers the entity's interest direct fire–when the entity is the intended target and the other registers for collateral fire– detonations that are within range of the entity that might damage it be it direct or indirect fire.

Relies on the destructor or the setDestroyed callback for unregistration from the detonation manager.

Reimplemented from DtActuatorComponent.

Reimplemented in DtMultipleHitDamageActuator, DtHumanDamageActuator, and DtIndividualLifeFormDamageAdjudicationActuator.

virtual bool DtDamageAdjudicationActuator::createPSR ( )
virtual

Create a process state repository (DtDamageAdjudicationPSR), or a different type if it is specified in the OPD.

Reimplemented in DtMultipleHitDamageActuator, and DtHumanDamageActuator.

static bool DtDamageAdjudicationActuator::processDirectDetonationCallback ( const DtDetonationContext detonationContext,
void *  usr 
)
static

The detonation manager uses this function to notify the actuator of when it needs to process an entity detonation for the entity.

Parameters
detonationContextThe detonation context to process
usrA pointer to the damage actuator that should process the detonation context.
See Also
adjudicateDirectDamage()
static bool DtDamageAdjudicationActuator::processCollateralDetonationCallback ( const DtDetonationContext detonationContext,
void *  usr 
)
static

The detonation manager uses this function to notify the actuator of when it needs to process an ground detonation to determine any collateral damage for the entity.

Parameters
detonationContextThe detonation context to process
usrA pointer to the damage actuator that should process the detonation context.
See Also
adjudicateCollateralDamage()
virtual bool DtDamageAdjudicationActuator::adjudicateDirectDamage ( const DtDetonationContext detonationContext)
virtual

When a detonation context is received, from the detonation manager, it is processed in order to determine the appropriate damage to the entity.

Determines if the entity is catastrophically killed, mobility killed, and/or firepower killed. If an entity is catastrophically killed, mobility and firepower killed status are not determined as there is no point. However, an entity that is not catastrophically killed can be both firepower killed and mobility killed, or just one or the other.

See Also
getProbabilities
isCatastrophicallyKilled
isFirepowerKilled
isMobilityKilled
setDestroyed
setMobilityKilled
setFirepowerKilled
Returns
A boolean indicating whether or not the component was able to properly adjudicate the damage done to the associated entity by the detonation.
Note
If this returns false, then the detonation could not be processed for some reason. Determines damage from a direct impact on the entity

Reimplemented in DtMultipleHitDamageActuator, and DtHumanDamageActuator.

virtual bool DtDamageAdjudicationActuator::adjudicateCollateralDamage ( const DtDetonationContext detonationContext)
virtual

Determines collateral damage from an impact near the entity.

Reimplemented in DtMultipleHitDamageActuator, and DtHumanDamageActuator.

virtual const char* DtDamageAdjudicationActuator::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.

Returns
DtDamageAdjudicationActuatorType

Implements DtSimComponent.

Reimplemented in DtMultipleHitDamageActuator, DtHumanDamageActuator, and DtIndividualLifeFormDamageAdjudicationActuator.

virtual void DtDamageAdjudicationActuator::tick ( )
virtual

Determines the destroyed status of the entity, and then checks to see if the flaming and smoking indicators should be turned off.

Note
Determining destroyed status updates the status if appropriate. Also, if the entity is destroyed, it ensures that it unregisters for detonation notifications if it hasn't already done so.
See Also
determineDestroyedStatus
unregisterForDetonations

Reimplemented from DtSimComponent.

Reimplemented in DtHumanDamageActuator, and DtIndividualLifeFormDamageAdjudicationActuator.

static void DtDamageAdjudicationActuator::setDestroyedCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtDamageAdjudicationActuator::setRestoredCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtDamageAdjudicationActuator::setInvulnerableCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtDamageAdjudicationActuator::setFunctionDamageStatusCallback ( DtSimMessage msg,
void *  usrData 
)
static
static DtSimComponent* DtDamageAdjudicationActuator::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
Returns
New instance of this class.
virtual void DtDamageAdjudicationActuator::getDirectFireSurfaceAndAngleOfIncidence ( DtDetonationContext detonationContext)
protectedvirtual

Determines the fire surface and the angle of incidence of the detonation from a direct fire weapon and puts them in the specified detonation context.

virtual void DtDamageAdjudicationActuator::getIndirectFireSurfaceAndAngleOfIncidence ( DtDetonationContext detonationContext)
protectedvirtual

Determines the fire surface and the angle of incidence of the detonation and puts them in the specified detonation context.

virtual DtSymbolString DtDamageAdjudicationActuator::getSurface ( DtBoundingVolumeFace  impactSurface)
protectedvirtual
Returns
the appropriate symbol string from the specified impact surface.
virtual bool DtDamageAdjudicationActuator::getProbabilities ( const DtDetonationContext detonationContext,
DtPrbValueList probabilities,
bool  isDirectDamage = true 
) const
protectedvirtual

Gets the list of probabilities from the damage component descriptor's damage tables.

Returns
a boolean signifying whether or not it was able to get the appropriate probability list.
Parameters
detonationContextContains all relevant information for finding the proper probability list.
probabilitiesThe list of probabilities to be filled in correctly if found.

from adjudicateDirectDamage and adjudicateCollateralDamage Passes in boolean to determine which damage table to use for the look up Default is to lookup in the direct damage file. Set to false for collateral damage file.

virtual bool DtDamageAdjudicationActuator::isCatastrophicallyKilled ( DtPrbValueList probabilities,
DtSymbolString  catastrophicKillString 
) const
protectedvirtual

Determines if the entity is catastrophically killed by the detonation with the specified list of probabilities.

Returns
a boolean signifying whether or not it the entity was catastrophically killed.
Parameters
probabilitiesThe probability list used to determine the outcome.
catastrophicKillStringUsed to look up the probability in the probability list.

from adjudicateDirectDamage and adjudicateCollateralDamage

virtual bool DtDamageAdjudicationActuator::isFirepowerKilled ( DtPrbValueList probabilities,
DtSymbolString  firepowerKillString 
) const
protectedvirtual

Determines if the entity is firepower killed by the detonation with the specified list of probabilities.

Returns
a boolean signifying whether or not it the entity was firepower killed.
Parameters
probabilitiesThe probability list used to determine the outcome.
firepowerKillStringUsed to look up the probability in the probability list.
See Also
adjudicateDamage
virtual bool DtDamageAdjudicationActuator::isMobilityKilled ( DtPrbValueList probabilities,
DtSymbolString  mobilityKillString 
) const
protectedvirtual

Determines if the entity is mobility killed by the detonation with the specified list of probabilities.

Returns
a boolean signifying whether or not it the entity was mobility killed.
Parameters
probabilitiesThe probability list used to determine the outcome.
mobilityKillStringUsed to look up the probability in the probability list.
See Also
adjudicateDamage
virtual bool DtDamageAdjudicationActuator::isSensorsKilled ( DtPrbValueList probabilities,
DtSymbolString  sensorsKillString 
) const
protectedvirtual

Determines if the entity has its sensors killed by the detonation with the specified list of probabilities.

Returns
a boolean signifying whether or not it the entity was sensors killed.
Parameters
probabilitiesThe probability list used to determine the outcome.
sensorsKillStringUsed to look up the probability in the probability list.
See Also
adjudicateDamage
virtual DtSymbolString DtDamageAdjudicationActuator::catastrophicKillString ( ) const
protectedvirtual
Returns
The DtSymbolString for "catastrophic-kill"
virtual DtSymbolString DtDamageAdjudicationActuator::mobilityKillString ( ) const
protectedvirtual
Returns
The DtSymbolString for "mobility-kill"
virtual DtSymbolString DtDamageAdjudicationActuator::firepowerKillString ( ) const
protectedvirtual
Returns
The DtSymbolString for "firepower-kill"
virtual DtSymbolString DtDamageAdjudicationActuator::sensorsKillString ( ) const
protectedvirtual
Returns
The DtSymbolString for "sensors-kill"
virtual bool DtDamageAdjudicationActuator::protectedFromCollateralDamageByEmbarkation ( ) const
protectedvirtual

Returns true if this entity is protected from collateral damage because it is embarked.

virtual void DtDamageAdjudicationActuator::determineDestroyedStatus ( )
protectedvirtual

This function determines if anything we are attached to are occupying was destroyed (last tick).

If anything we were attached to was destroyed, then we are setDestroyed() as well. If anything we were occupying was destroyed, then 50% of the time, we are determined to be destroyed as well.

See Also
setDestroyed()
virtual bool DtDamageAdjudicationActuator::isRegisteredForDetonations ( ) const
protectedvirtual

Keep track of whether or not we're registered for detonations direct or collateral.

virtual void DtDamageAdjudicationActuator::setIsRegisteredForDetonations ( bool  yesOrNo)
protectedvirtual
virtual void DtDamageAdjudicationActuator::setDestroyed ( )
protectedvirtual

Calls setDestroyed on the myLocalStateRepository.

Also calls setFlaming and setSmoking based on the parameters from the component descriptor. If the terminate-on-destroy parameter is true, the parent entity is queued for removal from the simulation. Also unregisters for detonations.

See Also
unregisterForDetonations.

Reimplemented in DtIndividualLifeFormDamageAdjudicationActuator.

virtual void DtDamageAdjudicationActuator::setRestored ( )
protectedvirtual

Re-registers the entity to receive detonations since it is now restored.

See Also
registerForDetonations

Reimplemented in DtMultipleHitDamageActuator, and DtHumanDamageActuator.

virtual void DtDamageAdjudicationActuator::processSetInvulnerable ( DtSimMessage msg)
protectedvirtual

Tells the entity to either ignore or process damage caused by detonations.

virtual void DtDamageAdjudicationActuator::processSetFunctionDamageStatus ( DtSimMessage msg)
protectedvirtual

Updates the function (fire power, mobility, and sensors) damage status of the entity.

virtual bool DtDamageAdjudicationActuator::registerForDetonations ( )
protectedvirtual

Registers the entity to receive notification of appropriate detonations and notes that the callbacks have been registered.

Registers for both direct and collateral if damage files exist for them

Note
Only registers if we're not registered yet.
virtual bool DtDamageAdjudicationActuator::unregisterForDetonations ( )
protectedvirtual

Unregisters the entity to receive notification of appropriate detonations, and notes that the callbacks have been unregistered.

Note
Only unregisters if we're registered
virtual void DtDamageAdjudicationActuator::setMobilityKilled ( )
protectedvirtual

Calls setMobilityKilled on the myLocalStateRepository.

virtual void DtDamageAdjudicationActuator::setFirepowerKilled ( )
protectedvirtual

Calls setFirepowerKilled on the myLocalStateRepository.

virtual void DtDamageAdjudicationActuator::setSensorsKilled ( )
protectedvirtual

Calls setSensorsKilled on the myLocalStateRepository.

virtual void DtDamageAdjudicationActuator::setRadio ( DtSimRadio radio)
protectedvirtual

Overrides this so it can register its interest the set destroyed message.

Reimplemented from DtActuatorComponent.

virtual void DtDamageAdjudicationActuator::triggerDestructionExplosions ( )
protectedvirtual

Starts the destruction explosions if they are configured in the descriptor.

virtual void DtDamageAdjudicationActuator::updateDestructionExplosions ( )
protectedvirtual

Called each tick while the entity is destroyed to create any new destruction detonations that should occur since the previous tick.

virtual void DtDamageAdjudicationActuator::sendDetonation ( const DtRwExplosionEntry explosionEntry)
protectedvirtual
virtual DtVector DtDamageAdjudicationActuator::positionOnEntity ( const DtVector percentOffset)
protectedvirtual
Returns
A geocentric position that is offset from the center of the entity based on the percentOffset vector, which represents a percent of the bounding geometry on the entity.
DtDamageAdjudicationActuator& DtDamageAdjudicationActuator::operator= ( const DtDamageAdjudicationActuator orig)
private

assignment operator; not implemented

Member Data Documentation

DtDamageAdjudicationComponentDescriptor* DtDamageAdjudicationActuator::myDamageComponentDescriptor
protected
DtDamageAdjudicationPSR* DtDamageAdjudicationActuator::myProcessState
protected
bool DtDamageAdjudicationActuator::myIsRegisteredForDetonations
private

Keep track of whether or not we've registered detonation callbacks with detonation manager.


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)