DtDetonationParams Class Reference

Readable-writable class holding all parameters to configure the DtDetonationManager.

Inheritance diagram for DtDetonationParams:

Public Member Functions
	DtDetonationParams (const DtDetonationParams &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtDetonationParams &	operator= (const DtDetonationParams &orig)
virtual	~DtDetonationParams ()
virtual bool	load (const DtFilename &)
virtual bool	save ()
virtual bool	save (const DtFilename &)
virtual void	merge (const DtDetonationParams *rhs)
	DtDetonationParams (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDetonationParams (const DtSymbolString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setFilename (const DtFilename &)
const DtFilename &	filename () const
virtual void	setComment (const DtString &)
const DtString &	comment () const
virtual const DtMunitionDetonationPowerTable &	detonationPowerTable () const
virtual DtMunitionDetonationPowerTable &	detonationPowerTable ()
virtual void	setDetonationPowerTable (const DtMunitionDetonationPowerTable &table)
virtual const DtMunitionDetonationResultTable &	detonationResultTable () const
virtual DtMunitionDetonationResultTable &	detonationResultTable ()
virtual void	setDetonationResultTable (const DtMunitionDetonationResultTable &table)
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 const char *	readerWriterType () const
virtual const char *	xmlType () const
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)

Protected Attributes
DtMunitionDetonationPowerTable	myDetonationPowerTable
DtMunitionDetonationResultTable	myDetonationResultTable
DtFilename	myFilename
DtString	myComment
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

Private Member Functions
	DtDetonationParams ()

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

DtDetonationParams::DtDetonationParams	(	const DtString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Constructor.

DtDetonationParams::DtDetonationParams	(	const DtSymbolString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Constructor.

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

copy constructor

Parameters

orig	DtPhysicalWorldParams to copy.
parentRegistry	The registry of the DtReaderWriter object to which this object belongs.

virtual DtDetonationParams::~DtDetonationParams ( )

virtual

DtDetonationParams::DtDetonationParams ( )

private

default constructor; not implemented

Member Function Documentation

DtDetonationParams& DtDetonationParams::operator=

(

const DtDetonationParams &

orig

)

assignment

virtual bool DtDetonationParams::load ( const DtFilename &  )

virtual

Loads the parameters from the specified filename. If the filename load is sucessful will set the myFilename parameter to the file.

virtual bool DtDetonationParams::save ( )

virtual

Saves the file to myFilename if not empty. If it is will return false.

virtual bool DtDetonationParams::save ( const DtFilename &  )

virtual

Saves to the given filename. Will also write out comment block.

virtual void DtDetonationParams::setFilename ( const DtFilename &  )

virtual

Accessor/mutator for myFilename.

const DtFilename& DtDetonationParams::filename

(

)

const

Accessor/mutator for myFilename.

virtual void DtDetonationParams::setComment ( const DtString &  )

virtual

Accessor/mutator for myComment.

const DtString& DtDetonationParams::comment

(

)

const

Accessor/mutator for myComment.

virtual const DtMunitionDetonationPowerTable& DtDetonationParams::detonationPowerTable ( ) const

virtual

Accessor/mutator for myDetonationPowerTable.

virtual DtMunitionDetonationPowerTable& DtDetonationParams::detonationPowerTable ( )

virtual

Accessor/mutator for myDetonationPowerTable.

virtual void DtDetonationParams::setDetonationPowerTable ( const DtMunitionDetonationPowerTable &  table )

virtual

Accessor/mutator for myDetonationPowerTable.

virtual const DtMunitionDetonationResultTable& DtDetonationParams::detonationResultTable ( ) const

virtual

Accessor/mutator for myDetonationResultTable.

virtual DtMunitionDetonationResultTable& DtDetonationParams::detonationResultTable ( )

virtual

Accessor/mutator for myDetonationResultTable.

virtual void DtDetonationParams::setDetonationResultTable ( const DtMunitionDetonationResultTable &  table )

virtual

Accessor/mutator for myDetonationResultTable.

virtual void DtDetonationParams::merge ( const DtDetonationParams *  rhs )

virtual

Merges the given parameters into our parameters, favoring the new values over the existing ones if there is overlap.

Member Data Documentation

DtMunitionDetonationPowerTable DtDetonationParams::myDetonationPowerTable

protected

Table that indicates how the power of various munition detonations at defined ranges.

DtMunitionDetonationResultTable DtDetonationParams::myDetonationResultTable

protected

Table that indicates what the detonation result should be.

DtFilename DtDetonationParams::myFilename

protected

Filename last loaded and to save to.

DtString DtDetonationParams::myComment

protected

Comment block to write at top of file.

---

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

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