DtDmgMunitionTable is the parameter that specifies the damage model for an entity. An entity may choose not to have a damage model, so this class uses the setValueSpecified() capability of DtReaderWriter to support being an optional argument.

Inheritance diagram for DtDmgMunitionTable:

[legend]

Public Member Functions
	DtDmgMunitionTable ()

	DtDmgMunitionTable (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)

	DtDmgMunitionTable (const DtString &writeName, const DtDmgMunitionTable &orig, DtReaderWriterRegistry *parentRegistry=0)

const DtDmgMunitionTable &	operator= (const DtDmgMunitionTable &orig)

virtual	~DtDmgMunitionTable ()

virtual DtDmgMunitionTable *	clone (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) const

virtual DtDmgMunitionEntry *	addMunitionEntry (const DtDmgMunitionEntry &munEntry)

virtual DtDmgMunitionEntry *	addMunitionEntry (const DtEntityType &munEntry)

virtual DtListItem *	lookupMunitionEntry (const DtSimMunition &munition) const

virtual bool	getProbabilities (const DtSimMunition &munition, const DtString &surface, DtReal angleOfIncidence, DtReal range, DtPrbValueList rangeEntry, bool isDirectDamage=true, DtSimMunition bestMatch=0) const

virtual double	getMaximumInputValue (const DtSimMunition &munitionType)

virtual double	getMaximumSuppressionRadius (const DtSimMunition &munitionType)

bool	operator== (const DtDmgMunitionTable &rhs) const

bool	operator!= (const DtDmgMunitionTable &rhs) 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	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
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	emptyList ()

virtual void	copyList (const DtDmgMunitionTable &orig)

virtual DtDmgMunitionEntry *	addMunitionEntry (DtDmgMunitionEntry *munEntry)

virtual const char *	readerWriterType () const

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)

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)

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

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

DtDmgMunitionTable::DtDmgMunitionTable ( )

default constructor

DtDmgMunitionTable::DtDmgMunitionTable	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

DtDmgMunitionTable::DtDmgMunitionTable	(	const DtString &	writeName,
		const DtDmgMunitionTable &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor

virtual DtDmgMunitionTable::~DtDmgMunitionTable ( )

virtual

Member Function Documentation

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

assignment operator

virtual DtDmgMunitionTable* DtDmgMunitionTable::clone	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

virtual

virtual DtDmgMunitionEntry* DtDmgMunitionTable::addMunitionEntry ( const DtDmgMunitionEntry & munEntry )

virtual

Entry is added in ascending sorted order by munition.

virtual DtDmgMunitionEntry* DtDmgMunitionTable::addMunitionEntry ( const DtEntityType & munEntry )

virtual

virtual DtListItem* DtDmgMunitionTable::lookupMunitionEntry ( const DtSimMunition & munition ) const

virtual

virtual bool DtDmgMunitionTable::getProbabilities	(	const DtSimMunition &	munition,
		const DtString &	surface,
		DtReal	angleOfIncidence,
		DtReal	range,
		DtPrbValueList *	rangeEntry,
		bool	isDirectDamage = `true`,
		DtSimMunition *	bestMatch = `0`
	)		const

virtual

Fills in the range entry passed based on the remaining arguments. false is returned if appropriate data can not be found. An attempt is made to make a best match on munition type in the same way entity parameters are looked up; -1 can be put into the table to 'match any'. direct damage bool used to determine if we are looking up direct damage or collateral damage.

virtual double DtDmgMunitionTable::getMaximumInputValue ( const DtSimMunition & munitionType )

virtual

Returns the maximum radius from the detonation at which the munition can do damage.

virtual double DtDmgMunitionTable::getMaximumSuppressionRadius ( const DtSimMunition & munitionType )

virtual

Returns the maximum radius from the detonation at which the munition can cause suppression.

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

Equivalence operator.

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

inline

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

protectedvirtual

Constructs a DtDmgMunitionEntry, reads the data from the mtl stream, and add it to the list.

Implements DtRwList.

virtual void DtDmgMunitionTable::emptyList ( )

protectedvirtual

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

protectedvirtual

virtual DtDmgMunitionEntry* DtDmgMunitionTable::addMunitionEntry ( DtDmgMunitionEntry * munEntry )

protectedvirtual

virtual const char* DtDmgMunitionTable::readerWriterType ( ) const

protectedvirtual

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.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation