VR-Link API Documentation for DIS
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtDetonationPdu Class Reference

DtDetonationPdu is used to represent the impact or detonation of a munition. More...

+ Inheritance diagram for DtDetonationPdu:
+ Collaboration diagram for DtDetonationPdu:

Public Types

enum  { PduStaticSize = 104 }

Public Member Functions

 DtDetonationPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtDetonationPdu (const DtNetDetonationPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtDetonationPdu (const DtEntityIdentifier &attacker, const DtEntityIdentifier &target, const DtEntityIdentifier &munition, const DtEventID &eventId, const DtVector &linVelocity, const DtVector &location, const DtBurstDescriptor &burst, const DtVector &entLocation, DtDetonationResult result, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtDetonationPdu (const DtFireInteraction &fire, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Fills in common fields with data from Fire Interaction.
const DtObjectIdattackerId () const
void setAttackerId (const DtObjectId &id)
const DtObjectIdtargetId () const
void setTargetId (const DtObjectId &id)
const DtObjectIdmunitionId () const
void setMunitionId (const DtObjectId &id)
const DtEventIDeventId () const
void setEventId (const DtEventID &id)
const DtVectorvelocity () const
void setVelocity (const DtVector &velocity)
const DtVectorworldLocation () const
void setWorldLocation (const DtVector &location)
const DtVectorentityLocation () const
void setEntityLocation (const DtVector &location)
DtDetonationResult result () const
void setResult (DtDetonationResult result)
DtDetonatorFuze fuseType () const
void setFuseType (DtDetonatorFuze fuse)
const DtEntityTypemunitionType () const
void setMunitionType (const DtEntityType &munType)
int quantity () const
void setQuantity (int quant)
int rate () const
void setRate (int rate)
DtWarheadType warheadType () const
void setWarheadType (DtWarheadType type)
const DtBurstDescriptorburst () const
 NOT USED IN HLA.
void setBurst (const DtBurstDescriptor &burst)
void setArticulatedParts (const DtArticulatedPartCollection &apList)
const DtArticulatedPartCollectionarticulatedParts () const
virtual void printData () const
 Print the PDU's data (not including header).
virtual void printDataToStream (std::ostream &stream) const
virtual void printDataToString (DtString &str) const
- Public Member Functions inherited from DtInteraction
 DtInteraction ()
 default constructor
virtual ~DtInteraction ()
 destructor
 DtInteraction (const DtInteraction &orig)
 copy constructor
DtInteractionoperator= (const DtInteraction &orig)
 assignment operator
- Public Member Functions inherited from DtPdu
virtual ~DtPdu ()
 Destructor.
 DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Copy constructor.
DtPduoperator= (const DtPdu &pdu)
 Assignment operator.
virtual void * packet () const
 Older function that returns a pointer to the network representation.
virtual int status () const
 Get PDU status.
virtual void setVersion (int vers)
 Set/Get protocol version from PDU header.
virtual int protocolVersion () const
virtual void setExerciseId (int id)
 Set/Get exerciseID in PDU header.
virtual int exerciseId () const
virtual DtPduKind kind () const
 Returns PDU kind from PDU header.
virtual DtProtocolFamily protocolFamily () const
 Returns protocol family from PDU header.
virtual void setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
 Set the PDU header's time stamp to reflect time and type.
virtual DtTime timeStamp () const
 Return the time (in seconds past an hour) encoded in the PDU header's time stamp.
virtual DtTimeStampType timeStampType () const
 Return the type of the time stamp, as indicated in PDU header.
virtual DtTime guessTimeValid (DtTime referenceTime) const
 Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour.
virtual DtNetPduHeadernetHeader () const
 Returns a pointer to the PDU's header.
virtual void print () const
 Print the contents of the PDU by calling printToStream(DtInfo).
virtual void printToStream (std::ostream &stream) const
 Print the contents of the PDU by calling printHeaderToStream and printDataToStream.
virtual void printHeader () const
 Print the PDU's header. This calls printHeaderToStream(DtInfo).
virtual void printHeaderToStream (std::ostream &stream) const
 Print the PDU's header to a stream.
- Public Member Functions inherited from DtBaseMsg
virtual ~DtBaseMsg ()
 Destructor.
 DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Copy constructor.
DtBaseMsgoperator= (const DtBaseMsg &msg)
 Assignment.
virtual const char * netRep () const
 Get network representation.
virtual int length () const
 Get size of message.

Static Public Member Functions

static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void addCallback (DtExerciseConn *conn, DtDetonationInteractionCb cb, void *usr)
static void removeCallback (DtExerciseConn *conn, DtDetonationInteractionCb cb, void *usr)

Protected Member Functions

DtPduKind internalGetPduKind () const
 Returns the PDU kind associated with the derived PDU class.

Protected Attributes

DtObjectId att
DtObjectId tar
DtObjectId mun
DtEventID event
DtVector vel
DtVector world
DtVector ent
DtBurstDescriptor theBurst
DtEntityType myMunType
DtArticulatedPartCollection myArtPartCollection

Detailed Description

DtDetonationPdu is used to represent the impact or detonation of a munition.

Member Enumeration Documentation

anonymous enum
Enumerator:
PduStaticSize 

Constructor & Destructor Documentation

DtDetonationPdu::DtDetonationPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
DtDetonationPdu::DtDetonationPdu ( const DtNetDetonationPdu initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtDetonationPdu::DtDetonationPdu ( const DtEntityIdentifier attacker,
const DtEntityIdentifier target,
const DtEntityIdentifier munition,
const DtEventID eventId,
const DtVector linVelocity,
const DtVector location,
const DtBurstDescriptor burst,
const DtVector entLocation,
DtDetonationResult  result,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtDetonationPdu::DtDetonationPdu ( const DtFireInteraction fire,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Fills in common fields with data from Fire Interaction.

Member Function Documentation

static void DtDetonationPdu::addCallback ( DtExerciseConn conn,
DtDetonationInteractionCb  cb,
void *  usr 
)
static
const DtArticulatedPartCollection& DtDetonationPdu::articulatedParts ( ) const
const DtObjectId& DtDetonationPdu::attackerId ( ) const
const DtBurstDescriptor& DtDetonationPdu::burst ( ) const

NOT USED IN HLA.

static DtPdu* DtDetonationPdu::create ( const DtNetPacket initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
static
const DtVector& DtDetonationPdu::entityLocation ( ) const
const DtEventID& DtDetonationPdu::eventId ( ) const
DtDetonatorFuze DtDetonationPdu::fuseType ( ) const
DtPduKind DtDetonationPdu::internalGetPduKind ( ) const
inlineprotectedvirtual

Returns the PDU kind associated with the derived PDU class.

Implements DtPdu.

References DtDetonationPduKind.

const DtObjectId& DtDetonationPdu::munitionId ( ) const
const DtEntityType& DtDetonationPdu::munitionType ( ) const
virtual void DtDetonationPdu::printData ( ) const
virtual

Print the PDU's data (not including header).

Base DtPdu version just prints hex. Use the printDataToString to put the data into a DtString instead of simply sending the output to stdout. printData() calls printDataToStream(DtInfo).

Reimplemented from DtPdu.

virtual void DtDetonationPdu::printDataToStream ( std::ostream &  stream) const
virtual

Reimplemented from DtPdu.

virtual void DtDetonationPdu::printDataToString ( DtString str) const
virtual

Reimplemented from DtPdu.

int DtDetonationPdu::quantity ( ) const
int DtDetonationPdu::rate ( ) const
static void DtDetonationPdu::removeCallback ( DtExerciseConn conn,
DtDetonationInteractionCb  cb,
void *  usr 
)
static
DtDetonationResult DtDetonationPdu::result ( ) const
void DtDetonationPdu::setArticulatedParts ( const DtArticulatedPartCollection apList)
void DtDetonationPdu::setAttackerId ( const DtObjectId id)
void DtDetonationPdu::setBurst ( const DtBurstDescriptor burst)
void DtDetonationPdu::setEntityLocation ( const DtVector location)
void DtDetonationPdu::setEventId ( const DtEventID id)
void DtDetonationPdu::setFuseType ( DtDetonatorFuze  fuse)
void DtDetonationPdu::setMunitionId ( const DtObjectId id)
void DtDetonationPdu::setMunitionType ( const DtEntityType munType)
void DtDetonationPdu::setQuantity ( int  quant)
void DtDetonationPdu::setRate ( int  rate)
void DtDetonationPdu::setResult ( DtDetonationResult  result)
void DtDetonationPdu::setTargetId ( const DtObjectId id)
void DtDetonationPdu::setVelocity ( const DtVector velocity)
void DtDetonationPdu::setWarheadType ( DtWarheadType  type)
void DtDetonationPdu::setWorldLocation ( const DtVector location)
const DtObjectId& DtDetonationPdu::targetId ( ) const
const DtVector& DtDetonationPdu::velocity ( ) const
DtWarheadType DtDetonationPdu::warheadType ( ) const
const DtVector& DtDetonationPdu::worldLocation ( ) const

Member Data Documentation

DtObjectId DtDetonationPdu::att
protected
DtVector DtDetonationPdu::ent
protected
DtEventID DtDetonationPdu::event
protected
DtObjectId DtDetonationPdu::mun
protected
DtArticulatedPartCollection DtDetonationPdu::myArtPartCollection
mutableprotected
DtEntityType DtDetonationPdu::myMunType
protected
DtObjectId DtDetonationPdu::tar
protected
DtBurstDescriptor DtDetonationPdu::theBurst
protected
DtVector DtDetonationPdu::vel
protected
DtVector DtDetonationPdu::world
protected

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

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)