DtPrbTableRangeDeterminant Class Reference

DtPrbTableRangeDeterminant provides a list of kill probabilities base on range. More...

Inheritance diagram for DtPrbTableRangeDeterminant:

Public Member Functions
	DtPrbTableRangeDeterminant ()
	DtPrbTableRangeDeterminant (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor with parameters to set up read/writability correctly
	DtPrbTableRangeDeterminant (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbTableRangeDeterminant (const DtString &name, const DtPrbTableRangeDeterminant &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtPrbTableRangeDeterminant (const DtSymbolString &name, const DtPrbTableRangeDeterminant &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtPrbTableRangeDeterminant &	operator= (const DtPrbTableRangeDeterminant &orig)
virtual	~DtPrbTableRangeDeterminant ()
	destructor
virtual DtPrbRangeDeterminant *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtPrbRangeDeterminant *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	addTableEntry (const DtPrbRangeTableEntry &tableEntry)
	Adds a table entry in sorted (ascending) order.
virtual void	getProbabilities (DtReal range, DtPrbRangeTableEntry *entry)
	The caller provides a pointer to a DtPrbRangeTableEntry, which is filled in with the appropriate set of probabilities.
virtual double	getMaximumDamageRadius ()
	Determines the maximum radius this munition can do damage for this angle Calls myRangeList->maxRangeValue();.
virtual const DtPrbRangeList &	rangeList () const
	Accessor for myRangeList.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtPrbRangeList	myRangeList
	Parameter Name: range-list Parameter Description: List of range/probability entries, in order of increasing range.

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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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 char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Protected Member Functions inherited from DtPrbRangeDeterminant
	DtPrbRangeDeterminant ()
	default constructor
	DtPrbRangeDeterminant (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtPrbRangeDeterminant (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbRangeDeterminant (const DtString &name, const DtPrbRangeDeterminant &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtPrbRangeDeterminant (const DtSymbolString &name, const DtPrbRangeDeterminant &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtPrbRangeDeterminant &	operator= (const DtPrbRangeDeterminant &orig)
virtual	~DtPrbRangeDeterminant ()
	destructor
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

Detailed Description

DtPrbTableRangeDeterminant provides a list of kill probabilities base on range.

These probabilities are looked up in a table that is managed by the DtPrbRangeList that is a member of this class.

Constructor & Destructor Documentation

DtPrbTableRangeDeterminant::DtPrbTableRangeDeterminant

(

)

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

constructor with parameters to set up read/writability correctly

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

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

copy constructor

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

virtual DtPrbTableRangeDeterminant::~DtPrbTableRangeDeterminant ( )

virtual

destructor

Member Function Documentation

const DtPrbTableRangeDeterminant& DtPrbTableRangeDeterminant::operator=

(

const DtPrbTableRangeDeterminant &

orig

)

virtual DtPrbRangeDeterminant* DtPrbTableRangeDeterminant::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

Implements DtPrbRangeDeterminant.

virtual DtPrbRangeDeterminant* DtPrbTableRangeDeterminant::clone ( const DtSymbolString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

Implements DtPrbRangeDeterminant.

virtual void DtPrbTableRangeDeterminant::addTableEntry ( const DtPrbRangeTableEntry &  tableEntry )

virtual

Adds a table entry in sorted (ascending) order.

virtual void DtPrbTableRangeDeterminant::getProbabilities ( DtReal  range, DtPrbRangeTableEntry *  entry  )

virtual

The caller provides a pointer to a DtPrbRangeTableEntry, which is filled in with the appropriate set of probabilities.

Implements DtPrbRangeDeterminant.

virtual double DtPrbTableRangeDeterminant::getMaximumDamageRadius ( )

virtual

Determines the maximum radius this munition can do damage for this angle Calls myRangeList->maxRangeValue();.

Implements DtPrbRangeDeterminant.

virtual const DtPrbRangeList& DtPrbTableRangeDeterminant::rangeList ( ) const

virtual

Accessor for myRangeList.

Member Data Documentation

DtPrbRangeList DtPrbTableRangeDeterminant::myRangeList

protected

Parameter Name: range-list
Parameter Description: List of range/probability entries, in order of increasing range.

The probability for a given entry applies to a range interval going from the range in the previous entry to the current entry range. For the first item in the list, the probability applies to a range of zero to the range specified in the entry.
Parameter Default Value:

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/prbTableRangeDeterminant.h