VR-Link API Documentation for HLA 1516
Public Member Functions | Static Public Member Functions | Protected Attributes
DtFireInteraction Class Reference

Instances of DtFireInteraction are used to represent the firing of a weapon. More...

+ Inheritance diagram for DtFireInteraction:
+ Collaboration diagram for DtFireInteraction:

List of all members.

Public Member Functions

 DtFireInteraction ()
 default constructor
virtual ~DtFireInteraction ()
 destructor
 DtFireInteraction (const DtFireInteraction &orig)
 copy constructor
DtFireInteractionoperator= (const DtFireInteraction &orig)
 assignment operator
virtual void printData () const
 Print the interaction's data to DtInfo.
virtual void printDataToStream (std::ostream &stream) const
 Print the interaction's data to the specified stream.
virtual void printDataToString (DtString &buffer) const
 Put the interaction's data into the given buffer.
virtual void setAttackerId (const DtGlobalObjectDesignator &id)
 Set/Get the attacker identifier.
virtual const
DtGlobalObjectDesignator
attackerId () const
virtual void setTargetId (const DtGlobalObjectDesignator &id)
 Set/Get the target identifier.
virtual const
DtGlobalObjectDesignator
targetId () const
virtual void setMunitionId (const DtGlobalObjectDesignator &id)
 Set/Get the munition identifier.
virtual const
DtGlobalObjectDesignator
munitionId () const
virtual void setEventId (const DtEventID &id)
 Set/Get the event id.
virtual const DtEventIDeventId () const
virtual void setFireMissionIndex (unsigned long i)
 Set/Get the fire mission index.
virtual unsigned long fireMissionIndex () const
virtual void setLocation (const DtVector &location)
 Set/Get the location in world coordinates.
virtual const DtVectorlocation () const
virtual void setVelocity (const DtVector &velocity)
 Set/Get the velocity.
virtual const DtVectorvelocity () const
virtual void setRange (double range)
 Set/Get the range.
virtual double range () const
virtual void setFuseType (DtDetonatorFuze f)
 Set/Get the detonator fuse type.
virtual DtDetonatorFuze fuseType () const
virtual void setMunitionType (const DtEntityType &t)
 Set/Get the munition type.
virtual const DtEntityTypemunitionType () const
virtual void setQuantity (int q)
 Set/Get the quantity.
virtual int quantity () const
virtual void setRate (int r)
 Set/Get the rate.
virtual int rate () const
virtual void setWarheadType (DtWarheadType t)
 Set/Get the warhead type.
virtual DtWarheadType warheadType () const
virtual const char * name () const
 Name of the interaction. (Not necessarily the ClassName from the FOM.)

Static Public Member Functions

static DtInteractioncreate ()
 Create a DtFireInteraction.
static void addCallback (DtExerciseConn *conn, DtFireInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 Add (register)/Remove (deregister) function to be called when interaction occurs.
static void removeCallback (DtExerciseConn *conn, DtFireInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes

DtGlobalObjectDesignator myAttackerId
DtGlobalObjectDesignator myTargetId
DtGlobalObjectDesignator myMunitionId
DtEventID myEventId
unsigned long myFireMissionIndex
DtVector myLocation
DtVector myVelocity
double myRange
DtDetonatorFuze myFuseType
DtEntityType myMunitionType
int myQuantity
int myRate
DtWarheadType myWarheadType

Detailed Description

Instances of DtFireInteraction are used to represent the firing of a weapon.

Examples

Constructor & Destructor Documentation

default constructor

destructor

copy constructor


Member Function Documentation

static void DtFireInteraction::addCallback ( DtExerciseConn conn,
DtFireInteractionCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
) [static]

Add (register)/Remove (deregister) function to be called when interaction occurs.

virtual const DtGlobalObjectDesignator& DtFireInteraction::attackerId ( ) const [virtual]

Create a DtFireInteraction.

Caller is responsible for deletion.

Reimplemented in MyFireInteraction.

virtual const DtEventID& DtFireInteraction::eventId ( ) const [virtual]
virtual unsigned long DtFireInteraction::fireMissionIndex ( ) const [virtual]
virtual DtDetonatorFuze DtFireInteraction::fuseType ( ) const [virtual]
virtual const DtVector& DtFireInteraction::location ( ) const [virtual]
virtual const DtGlobalObjectDesignator& DtFireInteraction::munitionId ( ) const [virtual]
virtual const DtEntityType& DtFireInteraction::munitionType ( ) const [virtual]
virtual const char* DtFireInteraction::name ( ) const [virtual]

Name of the interaction. (Not necessarily the ClassName from the FOM.)

Implements DtInteraction.

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

assignment operator

virtual void DtFireInteraction::printData ( ) const [virtual]

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

Reimplemented in MyFireInteraction.

virtual void DtFireInteraction::printDataToStream ( std::ostream &  stream) const [virtual]

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

virtual void DtFireInteraction::printDataToString ( DtString buffer) const [virtual]

Put the interaction's data into the given buffer.

Reimplemented from DtInteraction.

virtual int DtFireInteraction::quantity ( ) const [virtual]
virtual double DtFireInteraction::range ( ) const [virtual]
virtual int DtFireInteraction::rate ( ) const [virtual]
static void DtFireInteraction::removeCallback ( DtExerciseConn conn,
DtFireInteractionCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
) [static]
virtual void DtFireInteraction::setAttackerId ( const DtGlobalObjectDesignator id) [virtual]

Set/Get the attacker identifier.

virtual void DtFireInteraction::setEventId ( const DtEventID id) [virtual]

Set/Get the event id.

virtual void DtFireInteraction::setFireMissionIndex ( unsigned long  i) [virtual]

Set/Get the fire mission index.

virtual void DtFireInteraction::setFuseType ( DtDetonatorFuze  f) [virtual]

Set/Get the detonator fuse type.

virtual void DtFireInteraction::setLocation ( const DtVector location) [virtual]

Set/Get the location in world coordinates.

virtual void DtFireInteraction::setMunitionId ( const DtGlobalObjectDesignator id) [virtual]

Set/Get the munition identifier.

virtual void DtFireInteraction::setMunitionType ( const DtEntityType t) [virtual]

Set/Get the munition type.

virtual void DtFireInteraction::setQuantity ( int  q) [virtual]

Set/Get the quantity.

virtual void DtFireInteraction::setRange ( double  range) [virtual]

Set/Get the range.

virtual void DtFireInteraction::setRate ( int  r) [virtual]

Set/Get the rate.

virtual void DtFireInteraction::setTargetId ( const DtGlobalObjectDesignator id) [virtual]

Set/Get the target identifier.

virtual void DtFireInteraction::setVelocity ( const DtVector velocity) [virtual]

Set/Get the velocity.

virtual void DtFireInteraction::setWarheadType ( DtWarheadType  t) [virtual]

Set/Get the warhead type.

virtual const DtGlobalObjectDesignator& DtFireInteraction::targetId ( ) const [virtual]
virtual const DtVector& DtFireInteraction::velocity ( ) const [virtual]
virtual DtWarheadType DtFireInteraction::warheadType ( ) const [virtual]

Member Data Documentation

unsigned long DtFireInteraction::myFireMissionIndex [protected]
double DtFireInteraction::myRange [protected]
int DtFireInteraction::myRate [protected]

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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)