DtDmgMunitionEntry Class Reference

DtDmgMunitionEntry. More...

Inheritance diagram for DtDmgMunitionEntry:

List of all members.

Public Member Functions
	DtDmgMunitionEntry ()
	default constructor
	DtDmgMunitionEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtDmgMunitionEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDmgMunitionEntry (const DtString &name, const DtDmgMunitionEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtDmgMunitionEntry (const DtSymbolString &name, const DtDmgMunitionEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtDmgMunitionEntry &	operator= (const DtDmgMunitionEntry &orig)
	assignment operator
virtual	~DtDmgMunitionEntry ()
virtual DtDmgMunitionEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtDmgMunitionEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	addSurfaceEntry (const DtDmgSurfaceEntry &surfaceEntry, bool isDirectDamge=true)
	Add entry to one of the damage files.
virtual bool	getProbabilities (const DtString &surface, DtReal angleOfIncidence, DtReal range, DtPrbRangeTableEntry *rangeEntry, bool isDirectDamage=true)
	Fills in the range entry passed based on the remaining arguments.
virtual double	getMaximumDamageRadius ()
	Returns the maximum radius at which the munition can do damage.
virtual const DtSimMunition &	munition () const
	Accessor/mutator for myMunition.
virtual void	setMunition (const DtSimMunition &munition)
	Accessor/mutator for myMunition.
virtual const DtString &	directDamageFilename ()
	Accessor/mutator for myDirectDamageFile.
virtual void	setDirectDamageFilename (const DtString &filename)
	Accessor/mutator for myDirectDamageFile.
virtual const DtString &	collateralDamageFilename ()
	Accessor/mutator for myCollateralDamageFile.
virtual void	setCollateralDamageFilename (const DtString &filename)
	Accessor/mutator for myCollateralDamageFile.
Protected Member Functions
virtual void	removeSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry, bool isDirectDamage=true)
	Removes entry pointed to by surfaceEntry, but does not delete.
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtSimMunition	myMunition
	Parameter Name: ammo Parameter Description: The type of munition we're taking damage from Parameter Default Value: .
DtReaderWriterFile	myDirectDamageFile
	Parameter Name: direct-damage-file Parameter Description: The direct damage file to read in from Parameter Default Value: .
DtReaderWriterFile	myCollateralDamageFile
	Parameter Name: collateral-damage-file Parameter Description: The collateral damage file to read in from Parameter Default Value: .
DtDmgSurfaceTable	myDirectDamageTable
	Parameter Name: damage-table Parameter Description: The direct damage table used to determine damage from direct fire.
DtDmgSurfaceTable	myCollateralDamageTable
	Parameter Name: damage-table Parameter Description: The collateral damage table used to determine any collateral damage from a detonation.

---

Detailed Description

DtDmgMunitionEntry.

DtDmgMunitionEntry is a readable/writable triplet of DtSimMunition and 2 DtDmgSurfaceTable, with one important distinction: Instead of the DtDmgSurfaceTables being read from/written to the FILE given to this objects getSelf/putSelf, it is read/written from a separate file, specified using the setFilename() member. Holds 2 damage files one for direct damage--i.e a direct fire weapon makes direct hit and one for collateral damage--i.e. from being near a detonation from a weapon be it an explosive direct fire round, an indirect fire round from artillery, or a missile detonation

---

Constructor & Destructor Documentation

DtDmgMunitionEntry::DtDmgMunitionEntry

(

)

default constructor

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

real constructor

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

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

copy constructor

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

virtual DtDmgMunitionEntry::~DtDmgMunitionEntry

(

)

[virtual]

---

Member Function Documentation

const DtDmgMunitionEntry& DtDmgMunitionEntry::operator=

(

const DtDmgMunitionEntry &

orig

)

assignment operator

virtual DtDmgMunitionEntry* DtDmgMunitionEntry::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

virtual DtDmgMunitionEntry* DtDmgMunitionEntry::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

virtual const DtSimMunition& DtDmgMunitionEntry::munition

(

)

const [virtual]

Accessor/mutator for myMunition.

virtual void DtDmgMunitionEntry::setMunition

(

const DtSimMunition &

munition

)

[virtual]

Accessor/mutator for myMunition.

virtual const DtString& DtDmgMunitionEntry::directDamageFilename

(

)

[virtual]

Accessor/mutator for myDirectDamageFile.

virtual void DtDmgMunitionEntry::setDirectDamageFilename

(

const DtString &

filename

)

[virtual]

Accessor/mutator for myDirectDamageFile.

virtual const DtString& DtDmgMunitionEntry::collateralDamageFilename

(

)

[virtual]

Accessor/mutator for myCollateralDamageFile.

virtual void DtDmgMunitionEntry::setCollateralDamageFilename

(

const DtString &

filename

)

[virtual]

Accessor/mutator for myCollateralDamageFile.

virtual void DtDmgMunitionEntry::addSurfaceEntry	(	const DtDmgSurfaceEntry &	surfaceEntry,
		bool	isDirectDamge = true
	)		[virtual]

Add entry to one of the damage files.

Default is to add to the direct damage file. Set isDirectDamage to false if adding to the collateral damage file

virtual bool DtDmgMunitionEntry::getProbabilities	(	const DtString &	surface,
		DtReal	angleOfIncidence,
		DtReal	range,
		DtPrbRangeTableEntry *	rangeEntry,
		bool	isDirectDamage = true
	)		[virtual]

Fills in the range entry passed based on the remaining arguments.

false is returned if appropriate data cannot be found.

virtual double DtDmgMunitionEntry::getMaximumDamageRadius

(

)

[virtual]

Returns the maximum radius at which the munition can do damage.

virtual void DtDmgMunitionEntry::removeSurfaceEntry	(	DtDmgSurfaceEntry *	surfaceEntry,
		bool	isDirectDamage = true
	)		[protected, virtual]

Removes entry pointed to by surfaceEntry, but does not delete.

---

Member Data Documentation

DtSimMunition DtDmgMunitionEntry::myMunition [protected]

Parameter Name: ammo
Parameter Description: The type of munition we're taking damage from
Parameter Default Value:
.

DtReaderWriterFile DtDmgMunitionEntry::myDirectDamageFile [protected]

Parameter Name: direct-damage-file
Parameter Description: The direct damage file to read in from
Parameter Default Value:
.

DtReaderWriterFile DtDmgMunitionEntry::myCollateralDamageFile [protected]

Parameter Name: collateral-damage-file
Parameter Description: The collateral damage file to read in from
Parameter Default Value:
.

DtDmgSurfaceTable DtDmgMunitionEntry::myDirectDamageTable [protected]

Parameter Name: damage-table
Parameter Description: The direct damage table used to determine damage from direct fire.

Parameter Default Value:

DtDmgSurfaceTable DtDmgMunitionEntry::myCollateralDamageTable [protected]

Parameter Name: damage-table
Parameter Description: The collateral damage table used to determine any collateral damage from a detonation.

Parameter Default Value:

---

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

• include/vrfobjparam/dmgMunEntry.h