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	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	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	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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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 DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes
DtString	myMunitionName
	The name of the munition.
Parameters
DtRwEntityType	myMunitionType
	Parameter Name: warhead Parameter Description: Specifies the type of warhead.
DtRwInt	myWarhead
	Parameter Name: warhead Parameter Description: Specifies the type of warhead.
DtRwGuidanceModeType	myGuidanceMode
	Parameter Name: warhead Parameter Description: Specifies the type of warhead.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

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::pair < DtSymbolString, DtString >	DtVariableNameType
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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

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

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

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

DtString DtSimMunition::myMunitionName

protected

The name of the munition.

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

include/vrfutil/simMunition.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation