DtDamageAdjudicationComponentDescriptor is used to specify the parameters for the DtDamageAdjudicationActuator.

Inheritance diagram for DtDamageAdjudicationComponentDescriptor:

Public Types
typedef std::map< DtString, double >	DetonationPowerMap

Public Types inherited from DtActuatorComponentDescriptor
typedef std::set< DtArtPartType >	ArtPartTypeSet

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

Public Member Functions
	DtDamageAdjudicationComponentDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

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

DtDamageAdjudicationComponentDescriptor &	operator= (const DtDamageAdjudicationComponentDescriptor &orig)

virtual	~DtDamageAdjudicationComponentDescriptor ()

virtual DtString	type () const

virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const

virtual bool	init ()

virtual const DtDmgMunitionTable *	damageModel () const

virtual void	setDamageModel (const DtDmgMunitionTable *model)

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())


virtual const DtDamageByMunitionPowerMap &	damageModelByMunitionPower () const

virtual void	setDamageModelByMunitionPower (const DtDamageByMunitionPowerMap &model)


virtual DtReal	smokeTime () const

virtual void	setSmokeTime (DtReal smokeTime)


virtual DtTime	flameTime () const

virtual void	setFlameTime (DtTime flameTime)


virtual bool	terminateOnDestroy () const

virtual void	setTerminateOnDestroy (bool yesNo)


virtual bool	explodeWhenDestroyed () const

virtual void	setExplodeWhenDestroyed (bool b)


virtual DtRwExplosionList &	explosionList ()

virtual const DtRwExplosionList &	explosionList () const


virtual bool	getDirectKillProbabilities (const DtSimMunition &munition, const DtString &surface, DtReal angleOfIncidence, DtReal range, const DetonationPowerMap &powers, DtPrbValueList *probabilities) const

virtual bool	getCollateralDamageProbabilities (const DtSimMunition &munition, const DtString &surface, DtReal angleOfIncidence, DtReal range, const DetonationPowerMap &powers, DtPrbValueList *probabilities) const

Public Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)

virtual	~DtActuatorComponentDescriptor ()

virtual void	postGetSelf ()

virtual void	setDefaultArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)

virtual const DtSimArtPartDescriptorList &	defaultArtPartDescriptorList () const

virtual DtSimArtPartDescriptorList &	defaultArtPartDescriptorList ()

virtual void	setArtPartTypes (const ArtPartTypeSet &partTypes)

virtual const ArtPartTypeSet &	artPartTypes () const

virtual DtArtPartType	firstArtPartType () const

Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)

virtual	~DtComponentDescriptor ()

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

bool	operator== (const DtComponentDescriptor &) const

	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)

virtual void	setComponentType (const DtString &componentType)

virtual const DtString &	componentType () const

virtual void	setMinTickPeriod (DtReal minTickPeriod)

virtual DtReal	minTickPeriod () const

virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)

virtual DtReal	minTickPeriodVariance () const

virtual void	setTickPeriodUsesRealTime (bool value)

virtual bool	tickPeriodUsesRealTime () const

virtual const DtString &	processStateRepositoryName () const

virtual void	setProcessStateRepositoryName (const DtString &name)

virtual const DtString &	processStateRepositoryType () const

virtual void	setProcessStateRepositoryType (const DtString &type)

virtual void	setIsEnabled (bool yesNo)

virtual bool	isEnabled () const

virtual void	setDebugActive (bool active)

virtual bool	debugActive () const

virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)

virtual DtReal	minTaskVisualizationTickPeriod () const

virtual void	setTaskVisualizationsEnabled (bool enabled)

virtual bool	taskVisualizationsEnabled () const

virtual void	setCreateComponent (bool yesNo)

virtual bool	createComponent () const

virtual void	setCreateOnRemoteObject (bool yesNo)

virtual bool	createOnRemoteObject () const

virtual const DtRwNLengthStringVector &	scriptIds () const

virtual DtRwNLengthStringVector &	scriptIds ()

virtual const DtRwScriptVariablesList &	scriptVariables () const

virtual DtRwScriptVariablesList &	scriptVariables ()

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	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

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 DtComponentDescriptor *	creator ()

Static Public Member Functions inherited from DtActuatorComponentDescriptor
static DtComponentDescriptor *	creator ()

Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)

static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

static DtComponentDescriptor *	createComponentDescriptor (const char *pName)

static DtComponentDescriptor *	creator ()

static DtComponentDescriptorFactory *	factory ()

static void	setFactory (DtComponentDescriptorFactory *factory)

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
	DtDamageAdjudicationComponentDescriptor ()

Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()

Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
bool	myOwnDamageModel

parameters
These parameters are available for setting in the OPD files.
DtRwTime	mySmokeTime

DtRwTime	myFlameTime

DtRwBoolean	myTerminateOnDestroy

const DtDmgMunitionTable *	myDamageModel

DtRwDamageByMunitionPowerMap	myDamageModelByMunitionPower

DtRwBoolean	myExplodeWhenDestroyed

DtRwExplosionList	myExplosionList

Protected Attributes inherited from DtActuatorComponentDescriptor
ArtPartTypeSet	myArtPartTypes

DtSimArtPartDescriptorList	myDefaultArtPartDescriptorList

Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType

DtRwReal	myMinTickPeriod

DtRwReal	myMinTickPeriodVariance

DtRwBoolean	myTickPeriodUsesRealTime

DtRwString	myProcessStateRepositoryName

DtRwString	myProcessStateRepositoryType

DtRwBoolean	myIsEnabled

DtRwBoolean	myDebug

DtRwReal	myMinTaskVisualizationTickPeriod

DtRwBoolean	myTaskVisualizationsEnabled

DtRwBoolean	myCreateComponent

DtRwBoolean	myCreateOnRemoteObject

DtRwNLengthStringVector	myScriptIds

DtRwScriptVariablesList	myScriptVariables

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

Additional Inherited Members
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	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

Member Typedef Documentation

typedef std::map<DtString, double> DtDamageAdjudicationComponentDescriptor::DetonationPowerMap

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

virtual DtComponentDescriptor* DtDamageAdjudicationComponentDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const

virtual

Reimplemented from DtActuatorComponentDescriptor.

Reimplemented in DtMultipleHitDamageActuatorDescriptor, and DtHumanDamageActuatorDescriptor.

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 const DtDamageByMunitionPowerMap& DtDamageAdjudicationComponentDescriptor::damageModelByMunitionPower ( ) const

virtual

Accessor/mutator for myDamageModelByMunitionPower.

virtual void DtDamageAdjudicationComponentDescriptor::setDamageModelByMunitionPower ( const DtDamageByMunitionPowerMap & model )

virtual

Accessor/mutator for myDamageModelByMunitionPower.

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::explodeWhenDestroyed ( ) const

virtual

See Also: myExplodeWhenDestroyed

virtual void DtDamageAdjudicationComponentDescriptor::setExplodeWhenDestroyed ( bool b )

virtual

See Also: myExplodeWhenDestroyed

virtual DtRwExplosionList& DtDamageAdjudicationComponentDescriptor::explosionList ( )

virtual

See Also: myExplosionList

virtual const DtRwExplosionList& DtDamageAdjudicationComponentDescriptor::explosionList ( ) const

virtual

See Also: myExplosionList

virtual bool DtDamageAdjudicationComponentDescriptor::getDirectKillProbabilities	(	const DtSimMunition &	munition,
		const DtString &	surface,
		DtReal	angleOfIncidence,
		DtReal	range,
		const DetonationPowerMap &	powers,
		DtPrbValueList *	probabilities
	)		const

virtual

Returns a DtPrbValueList based on munition, surface, angle of incidence, range, and detonation powers. Returns false if the information requested can't be found.

virtual bool DtDamageAdjudicationComponentDescriptor::getCollateralDamageProbabilities	(	const DtSimMunition &	munition,
		const DtString &	surface,
		DtReal	angleOfIncidence,
		DtReal	range,
		const DetonationPowerMap &	powers,
		DtPrbValueList *	probabilities
	)		const

virtual

Returns a DtPrbValueList based on munition, surface, angle of incidence, range, and detonation powers. Returns false if the information requested can't be found.

virtual void DtDamageAdjudicationComponentDescriptor::putSelf	(	std::string &	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.

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 or collateral damage from specific munition types.
Parameter Default Value:
.

DtRwDamageByMunitionPowerMap DtDamageAdjudicationComponentDescriptor::myDamageModelByMunitionPower

protected

Parameter Name: damage-by-munition-power
Parameter Description: Damage model based on the power of the detonation at the entity;s location. Only used if munition is not found in the damage-model table.
Parameter Default Value:
.

DtRwBoolean DtDamageAdjudicationComponentDescriptor::myExplodeWhenDestroyed

protected

Parameter Name: explode-when-destroyed
Parameter Description: If true, entity will create one or more detonations when it is destroyed from detonations.
Parameter Default Value: False
.

DtRwExplosionList DtDamageAdjudicationComponentDescriptor::myExplosionList

protected

Parameter Name: explosion-list
Parameter Description: List of explosions that will occur when the entity is destroyed, if explode-when-destroyed is set to true.
Parameter Default Value: None.
.

bool DtDamageAdjudicationComponentDescriptor::myOwnDamageModel

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjparam/damageAdjudicationComponentDescriptor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation