DtRangeProbabilityTable is a readable/writable list of DtRangeProbEntrys. It's sorted by the entity type in the entry, and will return a DtPrbValueList based on the specified range and the best match found for the entity type indicated.

Inheritance diagram for DtRangeProbabilityTable:

[legend]

Public Member Functions
	DtRangeProbabilityTable ()

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

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

	DtRangeProbabilityTable (const DtRangeProbabilityTable &orig)

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

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

const DtRangeProbabilityTable &	operator= (const DtRangeProbabilityTable &orig)

virtual	~DtRangeProbabilityTable ()

virtual DtRangeProbabilityTable *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtRangeProbabilityTable *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtRangeProbEntry *	addDetectionProbabilityEntry (const DtRangeProbEntry &detectEntry)

virtual DtRangeProbEntry *	replaceTableEntry (const DtRangeProbEntry &detectEntry)

virtual void	addDetectionProbabilityEntry (DtRangeProbEntry *detectEntry)

virtual bool	removeDetectionProbabilityEntry (const DtEntityType &)

virtual bool	ammunitionCanBeUsedBy (const DtAmmunitionParamsEntry *, const DtEntityType &checkType=DtEntityType()) const

virtual DtRangeProbEntry *	changeEntityType (const DtEntityType &oldType, const DtEntityType &newType)

virtual double	getMaximumRange (const DtEntityType &) const

virtual bool	getProbabilities (const DtEntityType &entityType, DtReal range, DtPrbValueList rangeEntry, DtEntityType bestMatch=NULL) const

virtual const char *	readerWriterType () const

bool	operator== (const DtRangeProbabilityTable &) const

bool	operator!= (const DtRangeProbabilityTable &rhs) const

virtual bool	hasEntityType (const DtEntityType &) const

virtual bool	isValid () const

virtual void	postGetSelf ()


virtual void	setIsOptional (bool)

bool	isOptional () const

Public Member Functions inherited from DtRwList
	DtRwList ()

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

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

virtual	~DtRwList ()

const DtRwList &	operator= (const DtRwList &orig)

virtual DtListItem *	add (DtReaderWriter *data)

virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)

virtual DtListItem *	addToStart (DtReaderWriter *data)

virtual DtListItem *	addToEnd (DtReaderWriter *data)

virtual void *	remove (DtReaderWriter data, DtListItem item)

virtual DtlObjPtr	getLocalData (DtlObjPtr args)

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

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	removeAll ()

virtual void	removeAndDeleteAll ()

virtual void	reset ()

bool	operator== (const DtRwList &rhs) const

bool	operator!= (const DtRwList &rhs) const

virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

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

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

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)

virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual const char *	xmlType () const

virtual std::set< DtString >	supportedXmlTypes () const

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	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

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 int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

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	putData (std::string &fp, int indentLevel=0)

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	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

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

virtual DtListItem *	lookupDetectProbEntry (const DtEntityType &entityType) const

virtual void	emptyList ()

virtual void	copyList (const DtRangeProbabilityTable &orig)

Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)

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

Protected Attributes
DtRwBoolean	myIsOptional

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
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 DtRwList
static const char *	theXmlType ()

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)

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

Constructor & Destructor Documentation

DtRangeProbabilityTable::DtRangeProbabilityTable ( )

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

constructor with parameters to set up read/writability correctly

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

DtRangeProbabilityTable::DtRangeProbabilityTable ( const DtRangeProbabilityTable & orig )

copy constructor

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

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

virtual DtRangeProbabilityTable::~DtRangeProbabilityTable ( )

virtual

destructor

Member Function Documentation

const DtRangeProbabilityTable& DtRangeProbabilityTable::operator= ( const DtRangeProbabilityTable & orig )

virtual DtRangeProbabilityTable* DtRangeProbabilityTable::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

virtual DtRangeProbabilityTable* DtRangeProbabilityTable::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

virtual DtRangeProbEntry* DtRangeProbabilityTable::addDetectionProbabilityEntry ( const DtRangeProbEntry & detectEntry )

virtual

Adds a detection probability entry. List is kept in ascending order (by the entity type specified in the entry). Returns the new entry.

virtual DtRangeProbEntry* DtRangeProbabilityTable::replaceTableEntry ( const DtRangeProbEntry & detectEntry )

virtual

If the table entry with the type exists replaces it, else adds it.

virtual void DtRangeProbabilityTable::addDetectionProbabilityEntry ( DtRangeProbEntry * detectEntry )

virtual

Adds the new entry and takes control of the memory. Do not delete after added to this class.

virtual bool DtRangeProbabilityTable::removeDetectionProbabilityEntry ( const DtEntityType & )

virtual

Removes the entry that matches the given entity type exactly. Returns true if removed.

virtual bool DtRangeProbabilityTable::ammunitionCanBeUsedBy	(	const DtAmmunitionParamsEntry *	,
		const DtEntityType &	checkType = `DtEntityType()`
	)		const

virtual

Returns true if the supplied ammunition can hit any of the targets in this table. If checkType is supplied will only check the range whose entity type pattern matches the given type.

virtual DtRangeProbEntry* DtRangeProbabilityTable::changeEntityType	(	const DtEntityType &	oldType,
		const DtEntityType &	newType
	)

virtual

Changes the entity type from the current to the new. If the new type already exists then the old type will be removed and the new type will take on the old types data. Changing the entity type will clone the old entry and create a new one and return it.

virtual double DtRangeProbabilityTable::getMaximumRange ( const DtEntityType & ) const

virtual

Given the entity type, return the maximum range that this table will cover.

virtual bool DtRangeProbabilityTable::getProbabilities	(	const DtEntityType &	entityType,
		DtReal	range,
		DtPrbValueList *	rangeEntry,
		DtEntityType *	bestMatch = `NULL`
	)		const

virtual

Fills in the DtPrbValueList with a category/value pair for each item on its list (including the actual calculation of the probability value. Returns false if no entry found for entityType specified. (Note: if no entry is found for the range specified, the range entry will have 0.0s filled in for probabilities.)

virtual const char* DtRangeProbabilityTable::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtRwList.

bool DtRangeProbabilityTable::operator== ( const DtRangeProbabilityTable & ) const

Equivalence operator.

bool DtRangeProbabilityTable::operator!= ( const DtRangeProbabilityTable & rhs ) const

inline

virtual bool DtRangeProbabilityTable::hasEntityType ( const DtEntityType & ) const

virtual

Returns true if the entity type by exact match is in this list.

virtual bool DtRangeProbabilityTable::isValid ( ) const

virtual

Returns true if there is at least one range with at least one valid determinant.

virtual void DtRangeProbabilityTable::postGetSelf ( )

virtual

Set value to not be specified if empty.

Reimplemented from DtReaderWriter.

virtual void DtRangeProbabilityTable::setIsOptional ( bool )

virtual

Accessor/mutator for myIsOptional.

bool DtRangeProbabilityTable::isOptional ( ) const

Accessor/mutator for myIsOptional.

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

protectedvirtual

Creates the right kind of DtRangeProbEntry, reads it, and adds it to the list.

Implements DtRwList.

virtual DtListItem* DtRangeProbabilityTable::lookupDetectProbEntry ( const DtEntityType & entityType ) const

protectedvirtual

virtual void DtRangeProbabilityTable::emptyList ( )

protectedvirtual

virtual void DtRangeProbabilityTable::copyList ( const DtRangeProbabilityTable & orig )

protectedvirtual

Member Data Documentation

DtRwBoolean DtRangeProbabilityTable::myIsOptional

protected

Parameter Name: is-optional
Parameter Description: This is for the simulation object editor to let it know that this hit table is optional in usage Parameter Default Value: False.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation