VR-Forces 4.3.1 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 | 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)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtDamageAdjudicationActuator ()
 destructor Unregisters with the detonation manager.
virtual bool init ()
 Registers callbacks with the detonation manager.
virtual bool createPSR ()
 Create a process state repository (DtDamageAdjudicationPSR), or a different type if it is specified in the OPD.
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.
virtual bool adjudicateCollateralDamage (const DtDetonationContext &detonationContext)
 Determines collateral damage from an impact near the entity.
virtual DtString type () const
 Returns a string identifies the class type of component.
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.
- Public Member Functions inherited from DtActuatorComponent
virtual ~DtActuatorComponent ()
 destructor
virtual DtSimRadioradio ()
virtual bool tickWhileDestroyed () const
 By default, all actuators tick when the entity is destroyed.
- 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 preFirstTickInit ()
 called from preprocess if appropriate
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
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.

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.
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.
static void setDestroyedCallback (DtSimMessage *msg, void *usrData)
 Calls setDestroyed()
static void setRestoredCallback (DtSimMessage *msg, void *usrData)
 Calls setRestored()
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

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.
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.
virtual DtSymbolString getSurface (DtBoundingVolumeFace impactSurface)
virtual bool getRangeEntry (const DtDetonationContext &detonationContext, DtPrbRangeTableEntry &rangeEntry, bool isDirectDamage=true) const
 Gets the range entry from the damage component descriptor's kill probabilities.
virtual bool isCatastrophicallyKilled (DtPrbRangeTableEntry &rangeEntry, DtSymbolString catastrophicKillString) const
 Gets the probability of being catastrophically killed by the detonation from the specified range entry.
virtual bool isFirepowerKilled (DtPrbRangeTableEntry &rangeEntry, DtSymbolString firepowerKillString) const
 Gets the probability of being firepower killed by the detonation from the specified range entry.
virtual bool isMobilityKilled (DtPrbRangeTableEntry &rangeEntry, DtSymbolString mobilityKillString) const
 Gets the probability of being mobility killed by the detonation from the specified range entry.
virtual DtSymbolString catastrophicKillString () const
virtual DtSymbolString mobilityKillString () const
virtual DtSymbolString firepowerKillString () const
virtual void determineDestroyedStatus ()
 This function determines if anything we are attached to are occupying was destroyed (last tick).
virtual void setDestroyed ()
 Calls setDestroyed on the myLocalStateRepository.
virtual void setRestored ()
 Re-registers the entity to receive detonations since it is now restored.
virtual bool registerForDetonations ()
 Registers the entity to receive notification of appropriate detonations and notes that the callbacks have been registered.
virtual bool unregisterForDetonations ()
 Unregisters the entity to receive notification of appropriate detonations, and notes that the callbacks have been unregistered.
virtual void setMobilityKilled ()
 Calls setMobilityKilled on the myLocalStateRepository.
virtual void setFirepowerKilled ()
 Calls setFirepowerKilled on the myLocalStateRepository.
virtual void setRadio (DtSimRadio *radio)
 Overrides this so it can register its interest the set destroyed message.
virtual bool isRegisteredForDetonations () const
 Keep track of whether or not we're registered for detonations direct or collateral.
virtual void setIsRegisteredForDetonations (bool yesOrNo)
 Keep track of whether or not we're registered for detonations direct or collateral.
- Protected Member Functions inherited from DtActuatorComponent
 DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
 DtActuatorComponent (const DtActuatorComponent &orig)
 copy constructor
const DtActuatorComponentoperator= (const DtActuatorComponent &orig)
 assignment operator
 DtActuatorComponent ()
 Default constructor; should not be called.
- 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 Attributes

DtDamageAdjudicationComponentDescriptormyDamageComponentDescriptor
DtDamageAdjudicationPSRmyProcessState
- Protected Attributes inherited from DtActuatorComponent
DtSimRadiomyRadio
 Actuators 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.

Private Member Functions

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

Private Attributes

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

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

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 maxium 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 
)

(const DtString&,DtVrfObject*,DtSimManager*,

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).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

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, 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.

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
getRangeEntry
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.

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

Determines collateral damage from an impact near the entity.

Reimplemented in DtMultipleHitDamageActuator.

virtual DtString 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.

Returns
DtDamageAdjudicationActuatorType

Reimplemented from DtSimComponent.

Reimplemented in DtMultipleHitDamageActuator, 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 DtIndividualLifeFormDamageAdjudicationActuator.

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

(const DtString&,DtVrfObject*,DtSimManager*,

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).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns
New instance of this class.

Reimplemented in DtMultipleHitDamageActuator, and DtIndividualLifeFormDamageAdjudicationActuator.

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::getRangeEntry ( const DtDetonationContext detonationContext,
DtPrbRangeTableEntry rangeEntry,
bool  isDirectDamage = true 
) const
protectedvirtual

Gets the range entry from the damage component descriptor's kill probabilities.

Returns
a boolean signifying whether or not it was able to get the appropriate range entry.
Parameters
detonationContextContains all relevant information for finding the proper range entry.
rangeEntryThe range entry 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 ( DtPrbRangeTableEntry rangeEntry,
DtSymbolString  catastrophicKillString 
) const
protectedvirtual

Gets the probability of being catastrophically killed by the detonation from the specified range entry.

Returns
a boolean signifying whether or not it the entity was catastrophically killed.
Parameters
rangeEntryThe range entry used to determine the probability.
catastrophicKillStringUsed to look up the probability in the range entry.

from adjudicateDirectDamage and adjudicateCollateralDamage

virtual bool DtDamageAdjudicationActuator::isFirepowerKilled ( DtPrbRangeTableEntry rangeEntry,
DtSymbolString  firepowerKillString 
) const
protectedvirtual

Gets the probability of being firepower killed by the detonation from the specified range entry.

Returns
a boolean signifying whether or not it the entity was firepower killed.
Parameters
rangeEntryThe range entry used to determine the probability.
catastrophicKillStringUsed to look up the probability in the range entry.
See Also
adjudicateDamage
virtual bool DtDamageAdjudicationActuator::isMobilityKilled ( DtPrbRangeTableEntry rangeEntry,
DtSymbolString  mobilityKillString 
) const
protectedvirtual

Gets the probability of being mobility killed by the detonation from the specified range entry.

Returns
a boolean signifying whether or not it the entity was mobility killed.
Parameters
rangeEntryThe range entry used to determine the probability.
catastrophicKillStringUsed to look up the probability in the range entry.
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 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

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

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
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::setRadio ( DtSimRadio radio)
protectedvirtual

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

Reimplemented from DtActuatorComponent.

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 Wed Jul 29 00:55:00 EDT 2015 from SVN revision 155257
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)