DtDamageAdjudicationComponentDescriptor Class Reference

DtDamageAdjudicationComponentDescriptor is used to specify the parameters for the DtDamageAdjudicationActuator. More...

Inheritance diagram for DtDamageAdjudicationComponentDescriptor:

List of all members.

Public Member Functions
	DtDamageAdjudicationComponentDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtDamageAdjudicationComponentDescriptor (const DtDamageAdjudicationComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor.
DtDamageAdjudicationComponentDescriptor &	operator= (const DtDamageAdjudicationComponentDescriptor &orig)
	assignment. See note above.
virtual	~DtDamageAdjudicationComponentDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual bool	init ()
	allocate the damage tables
virtual const DtDmgMunitionTable *	damageModel () const
	This can be used to set the damage model to some other damage table.
virtual void	setDamageModel (const DtDmgMunitionTable *model)
virtual bool	getDirectKillProbabilities (const DtSimMunition &munition, const DtString &surface, DtReal angleOfIncidence, DtReal range, DtPrbRangeTableEntry *rangeEntry) const
	Returns a DtPrbRangeTableEntry based on munition, surface, angle of incidence, and range.
virtual bool	getCollateralDamageProbabilities (const DtSimMunition &munition, const DtString &surface, DtReal angleOfIncidence, DtReal range, DtPrbRangeTableEntry *rangeEntry) const
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to add myDirectDamageModel and myCollateralDamageModel to myRegistry temporarily if we don't own them (we just have a copy), so that they will get written out.
virtual DtReal	smokeTime () const
	Accessor/mutator for mySmokeTime.
virtual void	setSmokeTime (DtReal smokeTime)
	Accessor/mutator for mySmokeTime.
virtual DtTime	flameTime () const
	Accessor/mutator for myFlameTime.
virtual void	setFlameTime (DtTime flameTime)
	Accessor/mutator for myFlameTime.
virtual bool	terminateOnDestroy () const
	Accessor/mutator for myTerminateOnDestroy.
virtual void	setTerminateOnDestroy (bool yesNo)
	Accessor/mutator for myTerminateOnDestroy.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtDamageAdjudicationComponentDescriptor ()
	default constructor; not implemented
Protected Attributes
bool	myOwnDamageModel
parameters
These parameters are available for setting in the OPD files.
DtRwTime	mySmokeTime
	Parameter Name: smoke-time Parameter Description: The time the smoking appearance indicator will be true after any entity is destroyed.
DtRwTime	myFlameTime
	Parameter Name: flame-time Parameter Description: The time the flaming appearance indicator will be true after any entity is destroyed.
DtRwBoolean	myTerminateOnDestroy
	Parameter Name: terminate-on-destroy Parameter Description: The flag that determines whether the entity will be terminated when it is destroyed.
const DtDmgMunitionTable *	myDamageModel
	Parameter Name: damage-model Parameter Description: Damage model for direct impacts on the entity(optional).

---

Detailed Description

DtDamageAdjudicationComponentDescriptor is used to specify the parameters for the DtDamageAdjudicationActuator.

---

Constructor & Destructor Documentation

DtDamageAdjudicationComponentDescriptor::DtDamageAdjudicationComponentDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtDamageAdjudicationComponentDescriptor::DtDamageAdjudicationComponentDescriptor	(	const DtDamageAdjudicationComponentDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor.

Note that this does not do a deep copy of the damage table; it only copies the pointer. If you want your own copy of the table, clone the one pointed to in this copy and then call setDamageModel

virtual DtDamageAdjudicationComponentDescriptor::~DtDamageAdjudicationComponentDescriptor

(

)

[virtual]

destructor

DtDamageAdjudicationComponentDescriptor::DtDamageAdjudicationComponentDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtDamageAdjudicationComponentDescriptor& DtDamageAdjudicationComponentDescriptor::operator=

(

const DtDamageAdjudicationComponentDescriptor &

orig

)

assignment. See note above.

virtual DtString DtDamageAdjudicationComponentDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtDamageAdjudicationComponentDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

Reimplemented in DtMultipleHitDamageActuatorDescriptor.

virtual DtComponentDescriptor* DtDamageAdjudicationComponentDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

Reimplemented in DtMultipleHitDamageActuatorDescriptor.

virtual bool DtDamageAdjudicationComponentDescriptor::init

(

)

[virtual]

allocate the damage tables

Reimplemented from DtComponentDescriptor.

virtual const DtDmgMunitionTable* DtDamageAdjudicationComponentDescriptor::damageModel

(

)

const [virtual]

This can be used to set the damage model to some other damage table.

If you need to have a copy of the damage table that you can modify, you can clone the damage table returned by damageModel() and then call setDamageModel with the result. It is then your responsibility to delete that cloned table. Accessor for myDamageModel

virtual void DtDamageAdjudicationComponentDescriptor::setDamageModel

(

const DtDmgMunitionTable *

model

)

[virtual]

virtual DtReal DtDamageAdjudicationComponentDescriptor::smokeTime

(

)

const [virtual]

Accessor/mutator for mySmokeTime.

virtual void DtDamageAdjudicationComponentDescriptor::setSmokeTime

(

DtReal

smokeTime

)

[virtual]

Accessor/mutator for mySmokeTime.

virtual DtTime DtDamageAdjudicationComponentDescriptor::flameTime

(

)

const [virtual]

Accessor/mutator for myFlameTime.

virtual void DtDamageAdjudicationComponentDescriptor::setFlameTime

(

DtTime

flameTime

)

[virtual]

Accessor/mutator for myFlameTime.

virtual bool DtDamageAdjudicationComponentDescriptor::terminateOnDestroy

(

)

const [virtual]

Accessor/mutator for myTerminateOnDestroy.

virtual void DtDamageAdjudicationComponentDescriptor::setTerminateOnDestroy

(

bool

yesNo

)

[virtual]

Accessor/mutator for myTerminateOnDestroy.

virtual bool DtDamageAdjudicationComponentDescriptor::getDirectKillProbabilities	(	const DtSimMunition &	munition,
		const DtString &	surface,
		DtReal	angleOfIncidence,
		DtReal	range,
		DtPrbRangeTableEntry *	rangeEntry
	)		const [virtual]

Returns a DtPrbRangeTableEntry based on munition, surface, angle of incidence, and range.

Returns false if the information requested can't be found.

virtual bool DtDamageAdjudicationComponentDescriptor::getCollateralDamageProbabilities	(	const DtSimMunition &	munition,
		const DtString &	surface,
		DtReal	angleOfIncidence,
		DtReal	range,
		DtPrbRangeTableEntry *	rangeEntry
	)		const [virtual]

virtual void DtDamageAdjudicationComponentDescriptor::putSelf	(	FILE *	fp,
		int	indentLevel = 0,
		bool	writeUnspecified = false,
		const DtFilename &	path = DtReaderWriter::appPath()
	)		[virtual]

Override to add myDirectDamageModel and myCollateralDamageModel to myRegistry temporarily if we don't own them (we just have a copy), so that they will get written out.

Reimplemented from DtReaderWriter.

static DtComponentDescriptor* DtDamageAdjudicationComponentDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtActuatorComponentDescriptor.

Reimplemented in DtMultipleHitDamageActuatorDescriptor.

---

Member Data Documentation

DtRwTime DtDamageAdjudicationComponentDescriptor::mySmokeTime [protected]

Parameter Name: smoke-time
Parameter Description: The time the smoking appearance indicator will be true after any entity is destroyed.

Parameter Default Value: 0.0
Parameter Units: seconds

DtRwTime DtDamageAdjudicationComponentDescriptor::myFlameTime [protected]

Parameter Name: flame-time
Parameter Description: The time the flaming appearance indicator will be true after any entity is destroyed.

Parameter Default Value: 0.0
Parameter Units: seconds

DtRwBoolean DtDamageAdjudicationComponentDescriptor::myTerminateOnDestroy [protected]

Parameter Name: terminate-on-destroy Parameter Description: The flag that determines whether the entity will be terminated when it is destroyed.

Parameter Default Value: False

const DtDmgMunitionTable* DtDamageAdjudicationComponentDescriptor::myDamageModel [protected]

Parameter Name: damage-model
Parameter Description: Damage model for direct impacts on the entity(optional).

Parameter Default Value:

bool DtDamageAdjudicationComponentDescriptor::myOwnDamageModel [protected]

---

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

• include/vrfobjparam/dmgAdjudicationCompDesc.h