DtDmgMunitionEntry Class Reference

DtDmgMunitionEntry. More...

Inheritance diagram for DtDmgMunitionEntry:

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.
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	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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.

Protected Member Functions
virtual void	removeSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry, bool isDirectDamage=true)
	Removes entry pointed to by surfaceEntry, but does not delete.
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.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

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.
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 Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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  )

protectedvirtual

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