DtMineMunition Class Reference

DtMineMunition class.

DtMineMunition is derived from DtMineMunition. It uses a differnt kind of fuse to trigger the mine to detonate. This is different from a detonator fuse which it would also have

Inheritance diagram for DtMineMunition:

Public Member Functions
	DtMineMunition ()
	DtMineMunition (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtMineMunition (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtMineMunition (const DtString &name, const DtMineMunition &orig, DtReaderWriterRegistry *parentRegistry=0)
	DtMineMunition (const DtSymbolString &name, const DtMineMunition &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtMineMunition &	operator= (const DtMineMunition &orig)
virtual int	operator== (const DtMineMunition &rhs) const
virtual int	operator!= (const DtMineMunition &rhs) const
virtual int	operator< (const DtMineMunition &rhs) const
virtual	~DtMineMunition ()
virtual DtMineMunition *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtMineMunition *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual int	matchPattern (const DtMineMunition &pattern) const
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	stringRepresentation ()
virtual void	setMineFuse (int fuse)
virtual DtMinefieldFusing	mineFuse () const
virtual void	setTripwireLength (double length)
virtual double	tripwireLength () const
Public Member Functions inherited from DtSimMunition
	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 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 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)
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
DtRwInt	myMineFuse
DtRwReal	myTripWireLength
Protected Attributes inherited from DtSimMunition
DtString	myMunitionName
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 )()
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

DtMineMunition::DtMineMunition

(

)

default constructor

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

real constructor

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

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

copy constructor

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

virtual DtMineMunition::~DtMineMunition ( )

virtual

Member Function Documentation

const DtMineMunition& DtMineMunition::operator=

(

const DtMineMunition &

orig

)

assignment operator

virtual int DtMineMunition::operator== ( const DtMineMunition &  rhs ) const

virtual

virtual int DtMineMunition::operator!= ( const DtMineMunition &  rhs ) const

virtual

virtual int DtMineMunition::operator< ( const DtMineMunition &  rhs ) const

virtual

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

virtual

Reimplemented from DtSimMunition.

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

virtual

Reimplemented from DtSimMunition.

virtual int DtMineMunition::matchPattern ( const DtMineMunition &  pattern ) const

virtual

virtual void DtMineMunition::setMineFuse ( int  fuse )

virtual

Accessor/mutator for myFuse.

virtual DtMinefieldFusing DtMineMunition::mineFuse ( ) const

virtual

Accessor/mutator for myFuse.

virtual void DtMineMunition::setTripwireLength ( double  length )

virtual

Accessor/mutator for myTripwire length. Only relavent for mines with a trip wire fuse.

virtual double DtMineMunition::tripwireLength ( ) const

virtual

Accessor/mutator for myTripwire length. Only relavent for mines with a trip wire fuse.

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

static const char* DtMineMunition::theXmlType ( )

static

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

virtual const char* DtMineMunition::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual DtString DtMineMunition::stringRepresentation ( )

virtual

Returns a string containining all parameters seperted by " " for easy splitting. Excludes tracer type and guidance mode as they are not relavent to mines.

Member Data Documentation

DtRwInt DtMineMunition::myMineFuse

protected

Parameter Name: mine-fuse
Parameter Description: Specifies the type of fuse for the mine. Values are enumerations defined in the DIS enumerations document under DtMinefieldFusing. Parameter Default Value: -1.

DtRwReal DtMineMunition::myTripWireLength

protected

Parameter Name: tripwire-length
Parameter Description: Specifies the length of the tripwire if using . tripwire fuse. Parameter Default Value: 3.0 m.

---

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

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