Instances of DtDmgSurfaceTable are (readable/writable) lists of DtDmgSurfaceEntrys. A string hash index is maintained for quick lookup. Given a surface, angle, and some input value, this class's getProbabilities() method will fill in the supplied DtPrbValueList.

Inheritance diagram for DtDmgSurfaceTable:

[legend]

Public Member Functions
	DtDmgSurfaceTable (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

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

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

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

DtDmgSurfaceTable &	operator= (const DtDmgSurfaceTable &orig)

virtual	~DtDmgSurfaceTable () override

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

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

virtual void	addSurfaceEntry (const DtDmgSurfaceEntry &surfaceEntry)

virtual void	removeSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry)

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

virtual double	getMaximumInputValue () const

virtual double	getMinimumInputValue () const

bool	operator== (const DtDmgSurfaceTable &) const

bool	operator!= (const DtDmgSurfaceTable &rhs) const

virtual bool	isValid () const

Public Member Functions inherited from DtRwList
	DtRwList ()

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

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

virtual	~DtRwList () override

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

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

virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	removeAll ()

virtual void	removeAndDeleteAll ()

virtual void	reset () override

virtual const char *	readerWriterType () const override

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 override

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

virtual const char *	xmlType () const override

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

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

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

virtual void	emptyList ()

virtual void	copyList (const DtDmgSurfaceTable &orig)

virtual void	addSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry)

virtual void	removeSurfaceEntry (DtDmgSurfaceEntry surfaceEntry, DtListItem item)

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

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

DtDmgSurfaceTable::DtDmgSurfaceTable ( )

protected

default constructor

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

constructor

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

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

copy constructor

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

virtual DtDmgSurfaceTable::~DtDmgSurfaceTable ( )

overridevirtual

destructor

Member Function Documentation

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

Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.

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

virtual

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

virtual

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

virtual

virtual void DtDmgSurfaceTable::removeSurfaceEntry ( DtDmgSurfaceEntry * surfaceEntry )

virtual

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

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

virtual

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

virtual double DtDmgSurfaceTable::getMaximumInputValue ( ) const

virtual

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

virtual double DtDmgSurfaceTable::getMinimumInputValue ( ) const

virtual

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

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

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

inline

virtual bool DtDmgSurfaceTable::isValid ( ) const

virtual

Returns true if this is a valid table.

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

overrideprotectedvirtual

Constructs a DtDmgSurfaceEntry, reads it from the mtl stream, and then adds it to the list.

Implements DtRwList.

virtual void DtDmgSurfaceTable::emptyList ( )

protectedvirtual

Removes all descriptors from the list, and destroys them.

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

protectedvirtual

virtual void DtDmgSurfaceTable::addSurfaceEntry ( DtDmgSurfaceEntry * surfaceEntry )

protectedvirtual

virtual void DtDmgSurfaceTable::removeSurfaceEntry	(	DtDmgSurfaceEntry *	surfaceEntry,
		DtListItem *	item
	)

protectedvirtual

Member Data Documentation

DtHashlist DtDmgSurfaceTable::myHashIndex

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation