DtDamageProbabilityTable is a readable/writable entry that loads a damage table from a separate damage file.

Inheritance diagram for DtDamageProbabilityTable:

Public Member Functions
	DtDamageProbabilityTable ()

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

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

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

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

	DtDamageProbabilityTable (const DtDamageProbabilityTable &orig)

const DtDamageProbabilityTable &	operator= (const DtDamageProbabilityTable &orig)

virtual	~DtDamageProbabilityTable ()

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

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

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

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	addSurfaceEntry (const DtDmgSurfaceEntry &surfaceEntry)

virtual bool	getProbabilities (const DtString &surface, DtReal angleOfIncidence, DtReal value, DtPrbValueList *probList) const

virtual double	getMaximumInputValue () const

virtual double	getMinimumInputValue () const

virtual bool	isValid () const

const DtDmgSurfaceTable &	damageTable () const

DtDmgSurfaceTable &	damageTable ()

bool	operator== (const DtDamageProbabilityTable &rhs) const

bool	operator!= (const DtDamageProbabilityTable &rhs) const

virtual const char *	xmlType () const

virtual const char *	readerWriterType () const


virtual const DtString &	damageFilename () const

virtual void	setDamageFilename (const DtString &filename)

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	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

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 void	reset ()

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	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

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

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

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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

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

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

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
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)

Protected Member Functions
virtual void	removeSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry)

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

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtReaderWriterFile	myDamageFile

DtDmgSurfaceTable	myDamageTable

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 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

DtDamageProbabilityTable::DtDamageProbabilityTable ( )

default constructor

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

real constructor

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

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

copy constructor

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

DtDamageProbabilityTable::DtDamageProbabilityTable ( const DtDamageProbabilityTable & orig )

virtual DtDamageProbabilityTable::~DtDamageProbabilityTable ( )

virtual

Member Function Documentation

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

assignment operator

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

virtual

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

virtual

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

virtual

Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

virtual void DtDamageProbabilityTable::putSelf	(	std::string &	fp,
		int	indentLevel = `0`,
		bool	writeUnspecified = `false`,
		const DtFilename &	path = `DtFilename::nullFilename()`
	)

virtual

Top level call to write itself to file. If write unspecified is true, will write entries that are unspecified, in the format (name <use-default>). Path is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the path is specified with a non-NULL string, then the path prepended to the filename before writing the entry to file.

Reimplemented from DtReaderWriter.

virtual const DtString& DtDamageProbabilityTable::damageFilename ( ) const

virtual

Accessor/mutator for myDamageFile.

virtual void DtDamageProbabilityTable::setDamageFilename ( const DtString & filename )

virtual

Accessor/mutator for myDamageFile.

virtual void DtDamageProbabilityTable::addSurfaceEntry ( const DtDmgSurfaceEntry & surfaceEntry )

virtual

Add entry to the damage file.

virtual bool DtDamageProbabilityTable::getProbabilities	(	const DtString &	surface,
		DtReal	angleOfIncidence,
		DtReal	value,
		DtPrbValueList *	probList
	)		const

virtual

Fills in the proved probability list based on the remaining arguments. false is returned if appropriate data cannot be found.

virtual double DtDamageProbabilityTable::getMaximumInputValue ( ) const

virtual

Returns the maximum input value at which the munition can do damage.

virtual double DtDamageProbabilityTable::getMinimumInputValue ( ) const

virtual

Returns the minimum input value at which the munition can do damage.

virtual bool DtDamageProbabilityTable::isValid ( ) const

virtual

Returns true if this is a valid table.

const DtDmgSurfaceTable& DtDamageProbabilityTable::damageTable ( ) const

inline

Return the damage table.

DtDmgSurfaceTable& DtDamageProbabilityTable::damageTable ( )

inline

bool DtDamageProbabilityTable::operator== ( const DtDamageProbabilityTable & rhs ) const

Equivalence operator.

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

inline

static const char* DtDamageProbabilityTable::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* DtDamageProbabilityTable::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual const char* DtDamageProbabilityTable::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 DtReaderWriter.

virtual void DtDamageProbabilityTable::removeSurfaceEntry ( DtDmgSurfaceEntry * surfaceEntry )

protectedvirtual

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

Member Data Documentation

DtReaderWriterFile DtDamageProbabilityTable::myDamageFile

protected

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

DtDmgSurfaceTable DtDamageProbabilityTable::myDamageTable

protected

Parameter Name: damage-table
Parameter Description: The damage table used to determine damage based on power.
Parameter Default Value:
.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation