DtHighFidelityTerrainDamageConfig Class Reference

Inheritance diagram for DtHighFidelityTerrainDamageConfig:

Public Member Functions
	DtHighFidelityTerrainDamageConfig ()
	DtHighFidelityTerrainDamageConfig (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtHighFidelityTerrainDamageConfig (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtHighFidelityTerrainDamageConfig (const DtHighFidelityTerrainDamageConfig &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtHighFidelityTerrainDamageConfig (const DtString &name, const DtHighFidelityTerrainDamageConfig &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtHighFidelityTerrainDamageConfig (const DtSymbolString &name, const DtHighFidelityTerrainDamageConfig &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtHighFidelityTerrainDamageConfig &	operator= (const DtHighFidelityTerrainDamageConfig &orig)
virtual	~DtHighFidelityTerrainDamageConfig ()
virtual DtHighFidelityTerrainDamageConfig *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtHighFidelityTerrainDamageConfig *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
bool	operator== (const DtHighFidelityTerrainDamageConfig &) const
bool	operator!= (const DtHighFidelityTerrainDamageConfig &rhs)
virtual DtString	dynamicTerrainType () const
virtual void	setDynamicTerrainType (const DtString &type)
virtual DtString	powerType () const
virtual void	setPowerType (const DtString &type)
virtual DtString	damageAlgorithm () const
virtual void	setDamageAlgorithm (const DtString &alg)
virtual double	delay () const
virtual void	setDelay (double d)
virtual bool	detonateOnDestroy () const
virtual void	setDetonateOnDestroy (bool v)
virtual const DtEntityType &	detonationMunition () const
virtual void	setDetonationMunition (const DtEntityType &m)
virtual const std::map < DtRwReal, DtRwString > &	terrainDamageTable () const
virtual void	setTerrainDamageTable (const std::map< DtRwReal, DtRwString > &table)
virtual const DtRwKeyValueList &	additionalAlgorithmConfigList () const
virtual void	setAdditionalAlgorithmConfigList (const DtRwKeyValueList &l)
virtual DtString	additionalAlgorithmConfigValue (const DtString &key) const
virtual void	setAdditionalAlgorithmConfigValue (const DtString &key, const DtString &val)
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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
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	wasUpdatedSince (DtTime t) 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 Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myDynamicTerrainType
DtRwString	myPowerType
DtRwString	myDamageAlgorithm
DtRwReal	myDelay
DtRwBoolean	myDetonateOnDestroy
DtRwEntityType	myDetonationMunition
DtTerrainDamageTable	myTerrainDamageTable
DtRwKeyValueList	myAdditionalAlgorithmConfig
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 )()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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

DtHighFidelityTerrainDamageConfig::DtHighFidelityTerrainDamageConfig

(

)

default constructor

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

real constructor

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

DtHighFidelityTerrainDamageConfig::DtHighFidelityTerrainDamageConfig	(	const DtHighFidelityTerrainDamageConfig &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

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

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

virtual DtHighFidelityTerrainDamageConfig::~DtHighFidelityTerrainDamageConfig ( )

virtual

Member Function Documentation

const DtHighFidelityTerrainDamageConfig& DtHighFidelityTerrainDamageConfig::operator=

(

const DtHighFidelityTerrainDamageConfig &

orig

)

assignment operator

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

virtual

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

virtual

virtual DtString DtHighFidelityTerrainDamageConfig::dynamicTerrainType ( ) const

virtual

See Also

myDynamicTerrainType

virtual void DtHighFidelityTerrainDamageConfig::setDynamicTerrainType ( const DtString &  type )

virtual

See Also

myDynamicTerrainType

virtual DtString DtHighFidelityTerrainDamageConfig::powerType ( ) const

virtual

See Also

myPowerType

virtual void DtHighFidelityTerrainDamageConfig::setPowerType ( const DtString &  type )

virtual

See Also

myPowerType

virtual DtString DtHighFidelityTerrainDamageConfig::damageAlgorithm ( ) const

virtual

See Also

myDamageAlgorithm

virtual void DtHighFidelityTerrainDamageConfig::setDamageAlgorithm ( const DtString &  alg )

virtual

See Also

myDamageAlgorithm

virtual double DtHighFidelityTerrainDamageConfig::delay ( ) const

virtual

See Also

myDelay

virtual void DtHighFidelityTerrainDamageConfig::setDelay ( double  d )

virtual

See Also

myDelay

virtual bool DtHighFidelityTerrainDamageConfig::detonateOnDestroy ( ) const

virtual

See Also

myDetonateOnDestroy

virtual void DtHighFidelityTerrainDamageConfig::setDetonateOnDestroy ( bool  v )

virtual

See Also

myDetonateOnDestroy

virtual const DtEntityType& DtHighFidelityTerrainDamageConfig::detonationMunition ( ) const

virtual

See Also

myDetonationMunition

virtual void DtHighFidelityTerrainDamageConfig::setDetonationMunition ( const DtEntityType &  m )

virtual

See Also

myDetonationMunition

virtual const std::map<DtRwReal, DtRwString>& DtHighFidelityTerrainDamageConfig::terrainDamageTable ( ) const

virtual

See Also

myTerrainDamageTable

virtual void DtHighFidelityTerrainDamageConfig::setTerrainDamageTable ( const std::map< DtRwReal, DtRwString > &  table )

virtual

See Also

myTerrainDamageTable

virtual const DtRwKeyValueList& DtHighFidelityTerrainDamageConfig::additionalAlgorithmConfigList ( ) const

virtual

See Also

myAdditionalAlgorithmConfig

virtual void DtHighFidelityTerrainDamageConfig::setAdditionalAlgorithmConfigList ( const DtRwKeyValueList &  l )

virtual

See Also

myAdditionalAlgorithmConfig

virtual DtString DtHighFidelityTerrainDamageConfig::additionalAlgorithmConfigValue ( const DtString &  key ) const

virtual

See Also

myAdditionalAlgorithmConfig

virtual void DtHighFidelityTerrainDamageConfig::setAdditionalAlgorithmConfigValue ( const DtString &  key, const DtString &  val  )

virtual

See Also

myAdditionalAlgorithmConfig

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

static const char* DtHighFidelityTerrainDamageConfig::theXmlType ( )

static

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

virtual const char* DtHighFidelityTerrainDamageConfig::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

bool DtHighFidelityTerrainDamageConfig::operator==

(

const DtHighFidelityTerrainDamageConfig &

)

const

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

inline

Member Data Documentation

DtRwString DtHighFidelityTerrainDamageConfig::myDynamicTerrainType

protected

Parameter Name: dynamic-terrain-type
Parameter Description: String identifying the dynamic terrain type to be effected.
Parameter Default Value:
.

DtRwString DtHighFidelityTerrainDamageConfig::myPowerType

protected

Parameter Name: power-type
Parameter Description: String identifying the type of detonation power that causes this damage.
Parameter Default Value:
.

DtRwString DtHighFidelityTerrainDamageConfig::myDamageAlgorithm

protected

Parameter Name: damage-algorithm
Parameter Description: Name of the algorithm to be used to determine what damage has occurred.
Parameter Default Value:
.

DtRwReal DtHighFidelityTerrainDamageConfig::myDelay

protected

Parameter Name: delay
Parameter Description: Delay, in seconds, before dynamic terrain changes should take effect.
Parameter Default Value: 0.0
.

DtRwBoolean DtHighFidelityTerrainDamageConfig::myDetonateOnDestroy

protected

Parameter Name: detonate-on-destroy
Parameter Description: If true, then a detonation will be created when this terrain element is destroyed.
Parameter Default Value: False
.

DtRwEntityType DtHighFidelityTerrainDamageConfig::myDetonationMunition

protected

Parameter Name: detonation-munition
Parameter Description: Munition types used for detonation, if detonate-on-destroy is true.
Parameter Default Value: ""
.

DtTerrainDamageTable DtHighFidelityTerrainDamageConfig::myTerrainDamageTable

protected

Parameter Name: standard-terrain-damage-table
Parameter Description: Table that indicates the damaged caused by detonations of various powers.
.

DtRwKeyValueList DtHighFidelityTerrainDamageConfig::myAdditionalAlgorithmConfig

protected

Parameter Name: additional-algorithm-config
Parameter Description: A list of key/value pairs which can be used for additional configuration required for custom algorithms.
.

---

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

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