DtSimMunition class.

DtSimMunition is a readable/writable triplet of entityTypes (which is used in DIS/RPR as a munition type), detonator, and guidance system.

Its primary use is in the damage model. By including relational operators, a best match lookup capability is provided to the damage model code.

Inheritance diagram for DtSimMunition:

[legend]

Public Member Functions
	DtSimMunition ()

	DtSimMunition (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

	DtSimMunition (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)

	DtSimMunition (const DtString &name, const DtSimMunition &orig, DtReaderWriterRegistry *parentRegistry=0)

	DtSimMunition (const DtSymbolString &name, const DtSimMunition &orig, DtReaderWriterRegistry *parentRegistry=0)

const DtSimMunition &	operator= (const DtSimMunition &orig)

virtual	~DtSimMunition ()

virtual DtSimMunition *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const

virtual DtSimMunition *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0) const

virtual bool	operator== (const DtSimMunition &rhs) const

virtual bool	operator!= (const DtSimMunition &rhs) const

virtual bool	operator< (const DtSimMunition &rhs) const

virtual bool	operator<= (const DtSimMunition &rhs) const

virtual bool	operator> (const DtSimMunition &rhs) const

virtual bool	operator>= (const DtSimMunition &rhs) const

virtual bool	matchPattern (const DtSimMunition &pattern) const

virtual bool	findBestMatch (const std::list< DtSimMunition > &munitionList, DtSimMunition &bestMatch) const

virtual bool	findBestMatch (const std::vector< DtSimMunition > &munitionList, DtSimMunition &bestMatch) const

virtual void	setGuidanceMode (int gmode)

virtual DtRwGuidanceModeType	guidanceMode () const

virtual const char *	readerWriterType () const

virtual const DtString &	munitionName () const

virtual void	setMunitionName (DtString &name)


virtual void	setMunitionType (const DtEntityType &munitionType)

virtual void	setMunitionType (int kind, int domain, int country, int category, int subCategory, int specific, int extra)

virtual const DtEntityType &	munitionType () const


virtual void	setTracerType (const DtEntityType &munitionType)

virtual void	setTracerType (int kind, int domain, int country, int category, int subCategory, int specific, int extra)

virtual const DtEntityType &	tracerType () const


virtual DtReal	detonatorDelay () const

virtual void	setDetonatorDelay (const DtReal delay)


virtual void	setWarhead (int warhead)

virtual DtWarheadType	warhead () 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	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 *	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	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
DtString	myMunitionName

Parameters
DtRwEntityType	myMunitionType

DtRwEntityType	myTracerType

DtRwInt	myWarhead

DtRwGuidanceModeType	myGuidanceMode

DtRwReal	myDetonatorDelay

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

DtSimMunition::DtSimMunition ( )

default constructor

DtSimMunition::DtSimMunition	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

real constructor

DtSimMunition::DtSimMunition	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtSimMunition::DtSimMunition	(	const DtString &	name,
		const DtSimMunition &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor

DtSimMunition::DtSimMunition	(	const DtSymbolString &	name,
		const DtSimMunition &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

virtual DtSimMunition::~DtSimMunition ( )

virtual

Member Function Documentation

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

assignment operator

virtual DtSimMunition* DtSimMunition::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

virtual

Reimplemented in DtMineMunition.

virtual DtSimMunition* DtSimMunition::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

virtual

Reimplemented in DtMineMunition.

virtual bool DtSimMunition::operator== ( const DtSimMunition & rhs ) const

virtual

virtual bool DtSimMunition::operator!= ( const DtSimMunition & rhs ) const

virtual

virtual bool DtSimMunition::operator< ( const DtSimMunition & rhs ) const

virtual

virtual bool DtSimMunition::operator<= ( const DtSimMunition & rhs ) const

virtual

virtual bool DtSimMunition::operator> ( const DtSimMunition & rhs ) const

virtual

virtual bool DtSimMunition::operator>= ( const DtSimMunition & rhs ) const

virtual

virtual bool DtSimMunition::matchPattern ( const DtSimMunition & pattern ) const

virtual

virtual bool DtSimMunition::findBestMatch	(	const std::list< DtSimMunition > &	munitionList,
		DtSimMunition &	bestMatch
	)		const

virtual

return the best match munition type from the list. The munition list must be sorted.

virtual bool DtSimMunition::findBestMatch	(	const std::vector< DtSimMunition > &	munitionList,
		DtSimMunition &	bestMatch
	)		const

virtual

virtual void DtSimMunition::setMunitionType ( const DtEntityType & munitionType )

virtual

Accessor/mutator for munition-type.

virtual void DtSimMunition::setMunitionType	(	int	kind,
		int	domain,
		int	country,
		int	category,
		int	subCategory,
		int	specific,
		int	extra
	)

virtual

Accessor/mutator for munition-type.

virtual const DtEntityType& DtSimMunition::munitionType ( ) const

virtual

Accessor/mutator for munition-type.

virtual void DtSimMunition::setTracerType ( const DtEntityType & munitionType )

virtual

Accessor/mutator for tracer-type.

virtual void DtSimMunition::setTracerType	(	int	kind,
		int	domain,
		int	country,
		int	category,
		int	subCategory,
		int	specific,
		int	extra
	)

virtual

Accessor/mutator for tracer-type.

virtual const DtEntityType& DtSimMunition::tracerType ( ) const

virtual

Accessor/mutator for tracer-type.

virtual DtReal DtSimMunition::detonatorDelay ( ) const

virtual

Accessor/mutator for myDetonatorDelay.

virtual void DtSimMunition::setDetonatorDelay ( const DtReal delay )

virtual

Accessor/mutator for myDetonatorDelay.

virtual void DtSimMunition::setWarhead ( int warhead )

virtual

Accessor/mutator for myWarhead.

virtual DtWarheadType DtSimMunition::warhead ( ) const

virtual

Accessor/mutator for myWarhead.

virtual void DtSimMunition::setGuidanceMode ( int gmode )

virtual

virtual DtRwGuidanceModeType DtSimMunition::guidanceMode ( ) const

virtual

virtual const char* DtSimMunition::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 simulation object editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

Reimplemented in DtMineMunition.

virtual const DtString& DtSimMunition::munitionName ( ) const

virtual

The name of the munition. This can be used as a key in the entity resource database, or to print for information. It is initialized to the reader-writer myName member, which is the munition name for parameters read from scenario data files. However it can be changed during assignment, e.g. when passing the munition as a parameter. Munition name is not used for comparisons (e.g., ==) of munitions; only type, warhead and guidance mode are used. Those are assumed to be authoritative, while there could possibly be variations of the name for the same ammo type. (Although names used within an entity definition have to be consistent between the ammo selection table and resource spec.)

virtual void DtSimMunition::setMunitionName ( DtString & name )

virtual

Member Data Documentation

DtRwEntityType DtSimMunition::myMunitionType

protected

Parameter Name: tracer-type
Parameter Description: An alternate munition type that can be put into a fire/detonation interaction to indicate that a mix of ball and tracer rounds are being fired. Note that tracer type is not used for comparing munitions.
Parameter Default Value: Not present.

DtRwEntityType DtSimMunition::myTracerType

protected

Parameter Name: tracer-type
Parameter Description: An alternate munition type that can be put into a fire/detonation interaction to indicate that a mix of ball and tracer rounds are being fired. Note that tracer type is not used for comparing munitions.
Parameter Default Value: Not present.

DtRwInt DtSimMunition::myWarhead

protected

Parameter Name: warhead
Parameter Description: Specifies the type of warhead. Values are enumerations defined in the DIS enumerations document. The warhead is set in a detonation interaction issued when the missile impacts. Parameter Default Value: -1.

DtRwGuidanceModeType DtSimMunition::myGuidanceMode

protected

Parameter Name: tracer-type
Parameter Description: An alternate munition type that can be put into a fire/detonation interaction to indicate that a mix of ball and tracer rounds are being fired. Note that tracer type is not used for comparing munitions.
Parameter Default Value: Not present.

DtRwReal DtSimMunition::myDetonatorDelay

protected

Parameter Name: fuse-delay Parameter Description: For munitions with a timer fuse, this is the delay after which the munition will detonate regardless if it has hit the target Parameter Default Value: 0. Parameter Units: seconds.

DtString DtSimMunition::myMunitionName

protected

The name of the munition.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/simMunition.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation