DtMunitionDispersal specifies how a cluster munition or burst of fire is dispersed around the target.

Inheritance diagram for DtMunitionDispersal:

Public Member Functions
	DtMunitionDispersal ()

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

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

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

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

const DtMunitionDispersal &	operator= (const DtMunitionDispersal &orig)

virtual	~DtMunitionDispersal ()

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

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

bool	operator== (const DtMunitionDispersal &rhs) const

bool	operator!= (const DtMunitionDispersal &rhs) const

virtual DtMunitionDispersalParams *	params ()

virtual DtBaseMunitionDispersalDeterminant *	determinant ()

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

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

Static Public Member Functions
static void	setParamsFactory (DtMunitionDispersalParamsFactory *factory)

static DtMunitionDispersalParamsFactory *	paramsFactory ()

static void	setDeterminantFactory (DtMunitionDispersalDeterminantFactory *factory)

static DtMunitionDispersalDeterminantFactory *	determinantFactory ()

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 DtMunitionDispersalParams *	createParams (const DtString &determinantType)

virtual DtBaseMunitionDispersalDeterminant *	createDeterminant (const DtString &determinantType)

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

Protected Attributes
DtMunitionDispersalParams *	myParams

DtBaseMunitionDispersalDeterminant *	myDeterminant

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
static DtMunitionDispersalParamsFactory *	theParamsFactory

static DtMunitionDispersalDeterminantFactory *	theDeterminantFactory

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

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

Constructor & Destructor Documentation

DtMunitionDispersal::DtMunitionDispersal ( )

default constructor

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

real constructor

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

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

copy constructor

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

virtual DtMunitionDispersal::~DtMunitionDispersal ( )

virtual

Member Function Documentation

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

assignment operator

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

virtual

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

virtual

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

Equivalence operator.

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

inline

virtual DtMunitionDispersalParams* DtMunitionDispersal::params ( )

virtual

Returns the dispersal params.

virtual DtBaseMunitionDispersalDeterminant* DtMunitionDispersal::determinant ( )

virtual

Returns the dispersal determinant.

static void DtMunitionDispersal::setParamsFactory ( DtMunitionDispersalParamsFactory * factory )

static

Set the factory used to create munition dispersal params.

static DtMunitionDispersalParamsFactory* DtMunitionDispersal::paramsFactory ( )

static

Access the factory used to create munition dispersal params.

static void DtMunitionDispersal::setDeterminantFactory ( DtMunitionDispersalDeterminantFactory * factory )

static

Set the factory used to create munition dispersal functions.

static DtMunitionDispersalDeterminantFactory* DtMunitionDispersal::determinantFactory ( )

static

Access the factory used to create munition dispersal determinants. The default determinant factory is empty. It is initialized by the detonation manager in the sim.

virtual void DtMunitionDispersal::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 DtMunitionDispersalParams* DtMunitionDispersal::createParams ( const DtString & determinantType )

protectedvirtual

Creates a new params of the given type.

virtual DtBaseMunitionDispersalDeterminant* DtMunitionDispersal::createDeterminant ( const DtString & determinantType )

protectedvirtual

Creates a new determinant of the given type.

Member Data Documentation

DtMunitionDispersalParams* DtMunitionDispersal::myParams

protected

DtBaseMunitionDispersalDeterminant* DtMunitionDispersal::myDeterminant

protected

DtMunitionDispersalParamsFactory* DtMunitionDispersal::theParamsFactory

staticprotected

DtMunitionDispersalDeterminantFactory* DtMunitionDispersal::theDeterminantFactory

staticprotected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation