DtDamageAdjudicationActuator Class Reference

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

Inheritance diagram for DtDamageAdjudicationActuator:

Public Member Functions
	DtDamageAdjudicationActuator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtDamageAdjudicationActuator ()
virtual bool	init ()
virtual bool	createPSR ()
virtual bool	adjudicateDirectDamage (const DtDetonationContext &detonationContext)
virtual bool	adjudicateCollateralDamage (const DtDetonationContext &detonationContext)
virtual const char *	type () const
virtual void	tick ()
Public Member Functions inherited from DtActuatorComponent
virtual	~DtActuatorComponent ()
virtual DtSimRadio *	radio ()
virtual bool	tickWhileDestroyed () const
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
virtual void	setParentSystem (DtComponentSystem *system)
DtComponentSystem *	parentSystem () const
virtual bool	postAddComponentsInit ()
virtual void	registerAttributeFunctions ()
virtual void	preFirstTickInit ()
virtual void	postTick ()
virtual void	timedTick ()
virtual void	setMinTickPeriod (double minTickPeriod)
virtual double	minTickPeriod () const
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
virtual double	minTickPeriodVariance () const
virtual void	setNextTickTime (double nextTickTime)
virtual double	nextTickTime () const
virtual double	calculateNextTickTime () const
virtual double	calculateFirstTickTime () const
virtual void	setEntity (DtLocalObject *entity)
virtual DtSimComponent *	nextComponent ()
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	addInputPort (DtInputPort *port)
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
virtual DtList	inputPortList () const
virtual void	addOutputPort (DtOutputPort *port)
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
virtual DtList	outputPortList () const
virtual void	addInputPortGroup (DtInputPortGroup *group)
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
virtual DtList	inputPortGroupList () const
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
virtual DtList	outputPortGroupList () const
virtual int	priority () const
virtual void	setPriority (int priority)
double	dT () const
virtual void	setDT (double deltaT)
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual const DtSymbolString &	componentFullName () const
DtPhysicalWorld *	physicalWorld ()
const DtPhysicalWorld *	physicalWorld () const
const DtAttachedTerrain *	terrainAttachedTo () const
DtLocalObject *	entity ()
const DtLocalObject *	entity () const
DtSimulationServices *	simulationServices ()
const DtSimulationServices *	simulationServices () const
const Coordinate_System *	coordinateSystem () const
virtual bool	taskVisualizationsActive () const
virtual bool	taskVisualizationsEnabled () const
virtual void	onRestore ()
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
virtual void	enable ()
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 int	notifyLevel () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
VRF4API_METHOD const DtSimulationServices *	simManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	wasUpdatedSince (DtTime t) const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
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())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static bool	processDirectDetonationCallback (const DtDetonationContext &detonationContext, void *usr)
static bool	processCollateralDetonationCallback (const DtDetonationContext &detonationContext, void *usr)
static void	setDestroyedCallback (DtSimMessage *msg, void *usrData)
static void	setRestoredCallback (DtSimMessage *msg, void *usrData)
static void	setInvulnerableCallback (DtSimMessage *msg, void *usrData)
static void	setFunctionDamageStatusCallback (DtSimMessage *msg, void *usrData)
static DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)
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 char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual void	getDirectFireSurfaceAndAngleOfIncidence (DtDetonationContext &detonationContext)
virtual void	getIndirectFireSurfaceAndAngleOfIncidence (DtDetonationContext &detonationContext)
virtual DtSymbolString	getSurface (DtBoundingVolumeFace impactSurface)
virtual bool	getProbabilities (const DtDetonationContext &detonationContext, DtPrbValueList &probabilities, bool isDirectDamage=true) const
virtual bool	isCatastrophicallyKilled (DtPrbValueList &probabilities, DtSymbolString catastrophicKillString) const
virtual bool	isFirepowerKilled (DtPrbValueList &probabilities, DtSymbolString firepowerKillString) const
virtual bool	isMobilityKilled (DtPrbValueList &probabilities, DtSymbolString mobilityKillString) const
virtual bool	isSensorsKilled (DtPrbValueList &probabilities, DtSymbolString sensorsKillString) const
virtual DtSymbolString	catastrophicKillString () const
virtual DtSymbolString	mobilityKillString () const
virtual DtSymbolString	firepowerKillString () const
virtual DtSymbolString	sensorsKillString () const
virtual bool	protectedFromCollateralDamageByEmbarkation () const
virtual void	determineDestroyedStatus ()
virtual void	setDestroyed ()
virtual void	setRestored ()
virtual void	processSetInvulnerable (DtSimMessage *msg)
virtual void	processSetFunctionDamageStatus (DtSimMessage *msg)
virtual bool	registerForDetonations ()
virtual bool	unregisterForDetonations ()
virtual void	setMobilityKilled ()
virtual void	setFirepowerKilled ()
virtual void	setSensorsKilled ()
virtual void	setRadio (DtSimRadio *radio)
virtual void	triggerDestructionExplosions ()
virtual void	updateDestructionExplosions ()
virtual void	sendDetonation (const DtRwExplosionEntry &explosionEntry)
virtual DtVector	positionOnEntity (const DtVector &percentOffset)
virtual bool	isRegisteredForDetonations () const
virtual void	setIsRegisteredForDetonations (bool yesOrNo)
Protected Member Functions inherited from DtActuatorComponent
	DtActuatorComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	DtActuatorComponent ()
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
bool	testInvariant () const
virtual bool	createPortGroups ()
virtual bool	createPorts ()
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
virtual void	updateTaskVisualizations ()
virtual void	destroyTaskVisualizations ()
virtual void	destroyTaskVisualization (const DtString &name)
virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
double	calculateNextTaskVisTickTime () const
DtVrfObjectStateRepository *	localStateRepository ()
const DtVrfObjectStateRepository *	localStateRepository () const
void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	removeSimObjectPredicateCallback (const DtSimObject *, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	invokeSimObjectPredicateCallbacks ()
virtual void	clearPredicateCallbacks ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtDamageAdjudicationComponentDescriptor *	myDamageComponentDescriptor
DtDamageAdjudicationPSR *	myProcessState
bool	myIsRegisteredForDetonations
DtPlatformLocalObjectFacade	myPlatformLocalObjectFacade
DtHumanLocalObjectFacade	myHumanLocalObjectFacade
Protected Attributes inherited from DtActuatorComponent
DtSimRadio *	myRadio
Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity
DtComponentSystem *	mySystem
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
bool	myTickEveryFrame
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager	myPredicateCallbackManager
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Private Member Functions
	DtDamageAdjudicationActuator ()
	DtDamageAdjudicationActuator (const DtDamageAdjudicationActuator &orig)
DtDamageAdjudicationActuator &	operator= (const DtDamageAdjudicationActuator &orig)

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 DtSimComponentFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtDamageAdjudicationActuator::DtDamageAdjudicationActuator	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer 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

detonationContext	The detonation context to process
usr	A 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

detonationContext	The detonation context to process
usr	A 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

Calls setDestroyed()

static void DtDamageAdjudicationActuator::setRestoredCallback ( DtSimMessage *  msg, void *  usrData  )

static

Calls setRestored()

static void DtDamageAdjudicationActuator::setInvulnerableCallback ( DtSimMessage *  msg, void *  usrData  )

static

Calls processSetInvulnerable()

static void DtDamageAdjudicationActuator::setFunctionDamageStatusCallback ( DtSimMessage *  msg, void *  usrData  )

static

Calls processSetFunctionDamageStatus()

static DtSimComponent* DtDamageAdjudicationActuator::creator ( const DtString &  name, DtLocalObject *  owner, DtSimulationServices *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer 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

detonationContext	Contains all relevant information for finding the proper probability list.
probabilities	The 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

probabilities	The probability list used to determine the outcome.
catastrophicKillString	Used 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

probabilities	The probability list used to determine the outcome.
firepowerKillString	Used 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

probabilities	The probability list used to determine the outcome.
mobilityKillString	Used 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

probabilities	The probability list used to determine the outcome.
sensorsKillString	Used 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

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 DtHumanDamageActuator, and 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

protected

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

DtPlatformLocalObjectFacade DtDamageAdjudicationActuator::myPlatformLocalObjectFacade

protected

Member to allow for access to platform specific data.

DtHumanLocalObjectFacade DtDamageAdjudicationActuator::myHumanLocalObjectFacade

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmodel/damageAdjudicationActuator.h