VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes
DtSimMunition Class Reference

DtSimMunition class. More...

Inheritance diagram for DtSimMunition:
Inheritance graph
[legend]

List of all members.

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 DtSimMunitionoperator= (const DtSimMunition &orig)
 assignment operator
virtual ~DtSimMunition ()
virtual DtSimMunitionclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtSimMunitionclone (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 DtStringmunitionName () const
 The name of the munition.
virtual void setMunitionName (DtString &name)
virtual void setWarhead (int warhead)
virtual DtWarheadType warhead () const

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.

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

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

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

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

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

The name of the munition.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)