DtDamageComponentDescriptor Class Reference

DtDamageComponentDescriptor is used to specify the parameters for a DtDamageActuator object. More...

Inheritance diagram for DtDamageComponentDescriptor:

Public Member Functions
	DtDamageComponentDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtDamageComponentDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDamageComponentDescriptor (const DtDamageComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor.
DtDamageComponentDescriptor &	operator= (const DtDamageComponentDescriptor &orig)
	assignment. See note above.
virtual	~DtDamageComponentDescriptor ()
	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 table
virtual void	setDamageModel (const DtDmgMunitionTable *model)
	This can be used to set the damage model to some other damage table.
virtual const DtDmgMunitionTable *	damageModel () const
	Accessor for myDamageModel.
virtual bool	getKillProbabilities (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 void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to add myDamageModel to myRegistry temporarily if we don't own the damage table (we just have a copy), so that it 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.
virtual void	setUnderFireTime (DtTime underFireTime)
	Accessor/mutator for myUnderFireTime.
virtual DtTime	underFireTime () const
	Accessor/mutator for myUnderFireTime.
virtual DtReal	underFireDistance () const
	Accessor/mutator for myUnderFireDistance.
virtual void	setUnderFireDistance (DtReal underFireDistance)
	Accessor/mutator for myUnderFireDistance.
virtual bool	underFireFromFriendly () const
	Accessor/mutator for myUnderFireFromFriendly.
virtual void	setUnderFireFromFriendly (bool b)
	Accessor/mutator for myUnderFireFromFriendly.
Public Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)
	assignment
virtual	~DtActuatorComponentDescriptor ()
	destructor
virtual void	setArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)
	Accessor/mutator for myArtPartDescriptorList.
virtual const DtSimArtPartDescriptorList &	artPartDescriptorList () const
	Accessor/mutator for myArtPartDescriptorList.
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtDamageComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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.

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.
DtRwTime	myUnderFireTime
	Parameter Name: under-fire-time Parameter Description: The time after which an entity is no longer considered to be under fire.
DtRwReal	myUnderFireDistance
	Parameter Name: under-fire-distance Parameter Description: The distance from a detonation at which an entity is considered to be under fire.
DtRwBoolean	myUnderFireFromFriendly
	Parameter Name: under-fire-from-friendly Parameter Description: Determines if friendly fire should set the under fire condition.
const DtDmgMunitionTable *	myDamageModel
	Parameter Name: damage-model Parameter Description: Damage model for the entity (optional).
Protected Attributes inherited from DtActuatorComponentDescriptor
DtSimArtPartDescriptorList	myArtPartDescriptorList
	Parameter Name: art-part-list Parameter Description: List of articulated parts associated with this actuator.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

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::pair < DtSymbolString, DtString >	DtVariableNameType
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

DtDamageComponentDescriptor is used to specify the parameters for a DtDamageActuator object.

Constructor & Destructor Documentation

DtDamageComponentDescriptor::DtDamageComponentDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

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

DtDamageComponentDescriptor::DtDamageComponentDescriptor	(	const DtDamageComponentDescriptor &	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 DtDamageComponentDescriptor::~DtDamageComponentDescriptor ( )

virtual

destructor

DtDamageComponentDescriptor::DtDamageComponentDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtDamageComponentDescriptor& DtDamageComponentDescriptor::operator=

(

const DtDamageComponentDescriptor &

orig

)

assignment. See note above.

virtual DtString DtDamageComponentDescriptor::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

DtDamageComponentDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

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

virtual

Reimplemented from DtActuatorComponentDescriptor.

virtual bool DtDamageComponentDescriptor::init ( )

virtual

allocate the damage table

Reimplemented from DtComponentDescriptor.

virtual void DtDamageComponentDescriptor::setDamageModel ( const DtDmgMunitionTable *  model )

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. Mutator for myDamageModel

virtual const DtDmgMunitionTable* DtDamageComponentDescriptor::damageModel ( ) const

virtual

Accessor for myDamageModel.

virtual DtReal DtDamageComponentDescriptor::smokeTime ( ) const

virtual

Accessor/mutator for mySmokeTime.

virtual void DtDamageComponentDescriptor::setSmokeTime ( DtReal  smokeTime )

virtual

Accessor/mutator for mySmokeTime.

virtual DtTime DtDamageComponentDescriptor::flameTime ( ) const

virtual

Accessor/mutator for myFlameTime.

virtual void DtDamageComponentDescriptor::setFlameTime ( DtTime  flameTime )

virtual

Accessor/mutator for myFlameTime.

virtual bool DtDamageComponentDescriptor::terminateOnDestroy ( ) const

virtual

Accessor/mutator for myTerminateOnDestroy.

virtual void DtDamageComponentDescriptor::setTerminateOnDestroy ( bool  yesNo )

virtual

Accessor/mutator for myTerminateOnDestroy.

virtual bool DtDamageComponentDescriptor::getKillProbabilities ( 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 void DtDamageComponentDescriptor::setUnderFireTime ( DtTime  underFireTime )

virtual

Accessor/mutator for myUnderFireTime.

virtual DtTime DtDamageComponentDescriptor::underFireTime ( ) const

virtual

Accessor/mutator for myUnderFireTime.

virtual DtReal DtDamageComponentDescriptor::underFireDistance ( ) const

virtual

Accessor/mutator for myUnderFireDistance.

virtual void DtDamageComponentDescriptor::setUnderFireDistance ( DtReal  underFireDistance )

virtual

Accessor/mutator for myUnderFireDistance.

virtual bool DtDamageComponentDescriptor::underFireFromFriendly ( ) const

virtual

Accessor/mutator for myUnderFireFromFriendly.

virtual void DtDamageComponentDescriptor::setUnderFireFromFriendly ( bool  b )

virtual

Accessor/mutator for myUnderFireFromFriendly.

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

virtual

Override to add myDamageModel to myRegistry temporarily if we don't own the damage table (we just have a copy), so that it will get written out.

Reimplemented from DtReaderWriter.

static DtComponentDescriptor* DtDamageComponentDescriptor::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.

Member Data Documentation

DtRwTime DtDamageComponentDescriptor::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 DtDamageComponentDescriptor::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 DtDamageComponentDescriptor::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

DtRwTime DtDamageComponentDescriptor::myUnderFireTime

protected

Parameter Name: under-fire-time
Parameter Description: The time after which an entity is no longer considered to be under fire.

Parameter Default Value: 120.0
Parameter Units: seconds

DtRwReal DtDamageComponentDescriptor::myUnderFireDistance

protected

Parameter Name: under-fire-distance
Parameter Description: The distance from a detonation at which an entity is considered to be under fire.

Parameter Default Value: 1000.0
Parameter Units: meters

DtRwBoolean DtDamageComponentDescriptor::myUnderFireFromFriendly

protected

Parameter Name: under-fire-from-friendly
Parameter Description: Determines if friendly fire should set the under fire condition.

Parameter Default Value: True

const DtDmgMunitionTable* DtDamageComponentDescriptor::myDamageModel

protected

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

Parameter Default Value:

bool DtDamageComponentDescriptor::myOwnDamageModel

protected

---

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

• include/vrfobjparam/dmgCompDesc.h