DtSimMunition Class Reference

DtSimMunition class. More...

Inheritance diagram for DtSimMunition:

Public Member Functions
	DtSimMunition ()
	default constructor
	DtSimMunition (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtSimMunition (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtSimMunition (const DtString &name, const DtSimMunition &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
	DtSimMunition (const DtSymbolString &name, const DtSimMunition &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSimMunition &	operator= (const DtSimMunition &orig)
	assignment operator
virtual	~DtSimMunition ()
virtual DtSimMunition *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtSimMunition *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual int	operator== (const DtSimMunition &rhs) const
virtual int	operator!= (const DtSimMunition &rhs) const
virtual int	operator< (const DtSimMunition &rhs) const
virtual int	operator<= (const DtSimMunition &rhs) const
virtual int	operator> (const DtSimMunition &rhs) const
virtual int	operator>= (const DtSimMunition &rhs) const
virtual int	matchPattern (const DtSimMunition &pattern) const
virtual void	setGuidanceMode (int gmode)
virtual DtRwGuidanceModeType	guidanceMode () const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const DtString &	munitionName () const
	The name of the munition.
virtual void	setMunitionName (DtString &name)
virtual void	setMunitionType (const DtEntityType &munitionType)
	Accessor/mutator for munition-type.
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)
	Accessor/mutator for tracer-type.
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
	Accessor/mutator for myDetonatorDelay.
virtual void	setDetonatorDelay (const DtReal delay)
virtual void	setWarhead (int warhead)
virtual DtWarheadType	warhead () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Attributes
DtString	myMunitionName
	The name of the munition.
Parameters
DtRwEntityType	myMunitionType
DtRwEntityType	myTracerType
	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.
DtRwInt	myWarhead
	Parameter Name: warhead Parameter Description: Specifies the type of warhead.
DtRwGuidanceModeType	myGuidanceMode
DtRwReal	myDetonatorDelay
	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.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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 ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
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)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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

Detailed Description

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.

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

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

virtual int DtSimMunition::matchPattern ( const DtSimMunition &  pattern ) 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

virtual const DtEntityType& DtSimMunition::munitionType ( ) const

virtual

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

virtual const DtEntityType& DtSimMunition::tracerType ( ) const

virtual

virtual DtReal DtSimMunition::detonatorDelay ( ) const

virtual

Accessor/mutator for myDetonatorDelay.

virtual void DtSimMunition::setDetonatorDelay ( const DtReal  delay )

virtual

virtual void DtSimMunition::setWarhead ( int  warhead )

virtual

Accessor/mutator for myWarhead.

virtual DtWarheadType DtSimMunition::warhead ( ) const

virtual

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 opd editor to determine which type of control to create

Reimplemented from DtReaderWriter.

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

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

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/simMunition.h