VR-Engage  2.2
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
makVre::FireMessage Class Reference

#include <fire.h>

Inheritance diagram for makVre::FireMessage:
[legend]

Classes

struct  FireData
 

Public Types

enum  FuzeType {
  FuzeType_OTHER =0 , FuzeType_CONTACT =1000 , FuzeType_CONTACTINSTANT =1100 , FuzeType_CONTACTDELAYED =1200 ,
  FuzeType_TIMED =2000 , FuzeType_PROXIMITY =3000 , FuzeType_COMMAND =4000 , FuzeType_ALTITUDE =5000 ,
  FuzeType_DEPTH =6000 , FuzeType_ACOUSTIC =7000
}
 
enum  WarheadType {
  WarheadType_OTHER =0 , WarheadType_HIGHEXPLOSIVE =1000 , WarheadType_HIGHEXPLOSIVEPLATIC =1100 , WarheadType_HIGHEXPLOSIVEINCENDIARY =1200 ,
  WarheadType_HIGHEXPLOSIVEFRAGMENTATION =1300 , WarheadType_HIGHEXPLOSIVEANTITANK =1400 , WarheadType_HIGHEXPLOSIVEBOMBLETS =1500 , WarheadType_HIGHEXPLOSIVESHAPEDCHARGE =1600 ,
  WarheadType_SMOKE =2000 , WarheadType_ILLUMINATION =3000 , WarheadType_PRACTICE =4000 , WarheadType_KINETIC =5000 ,
  WarheadType_UNUSED =6000 , WarheadType_NUCLEAR =7000 , WarheadType_CHEMICALGENERAL =8000 , WarheadType_CHEMICALBLISTER =8100 ,
  WarheadType_CHEMICALBLOOD =8200 , WarheadType_CHEMICALNERVE =8300 , WarheadType_BIOLOGICALGENERAL =9000
}
 

Public Member Functions

virtual const std::string & type () const override
 
virtual const makVre::DtVreMessageId & messageId () const override
 
virtual ~FireMessage () override
 
virtual const std::string & getFiringId () const
 
virtual void setFiringId (const std::string &val)
 
virtual const std::string & getTargetId () const
 
virtual void setTargetId (const std::string &val)
 
virtual const std::string & getMunitionId () const
 
virtual void setMunitionId (const std::string &val)
 
virtual const DtVector & getWorldPosition () const
 
virtual void setWorldPosition (const DtVector &val)
 
virtual const DtVector & getVelocity () const
 
virtual void setVelocity (const DtVector &val)
 
virtual double getRange () const
 
virtual void setRange (double val)
 
virtual int getEventId () const
 
virtual void setEventId (int val)
 
virtual const DtEntityType & getMunitionType () const
 
virtual void setMunitionType (const DtEntityType &val)
 
virtual FuzeType getFuzeType () const
 
virtual void setFuzeType (FuzeType val)
 
virtual WarheadType getWarheadType () const
 
virtual void setWarheadType (WarheadType val)
 
virtual int getQuantity () const
 
virtual void setQuantity (int val)
 
virtual int getRate () const
 
virtual void setRate (int val)
 
virtual int messageSize () const override
 
FireData getData ()
 
FireData getData () const
 
bool operator== (const FireMessage &rhs) const
 
- Public Member Functions inherited from makVre::DtVreMessage
 DtVreMessage ()
 
virtual ~DtVreMessage ()
 
virtual char * encode ()
 
virtual void encode (char *buffer, int bufferSize)
 
virtual const UInt64 originatingApplicationId () const
 
virtual void setOriginatingApplicationId (UInt64 appId)
 
virtual void setDelay (double delay)
 
virtual bool isDelayed ()
 
virtual void reduceDelay (double dt)
 
virtual const UInt64 versionNumber () const
 

Static Public Member Functions

static FireMessage * create ()
 
static FireMessage * createFrom (FireMessage *)
 
static FireMessage * createFromData (const FireData)
 
static const std::string & theType ()
 
static const makVre::DtVreMessageId & theId ()
 
static UInt64 theVersionNumber ()
 
static makVre::DtVreMessage * decode (char *buffer, int length)
 

Protected Member Functions

 FireMessage ()
 
virtual void serialize (DtStreamWriter &writer) const override
 
virtual void deserialize (DtStreamReader &reader) override
 

Protected Attributes

FireData myData
 
- Protected Attributes inherited from makVre::DtVreMessage
double myDelay
 
UInt64 myApplicationId
 
UInt64 myVersion
 

Static Protected Attributes

static makVre::DtVreMessageId theMessageId
 
static UInt64 theVersion
 

Member Enumeration Documentation

◆ FuzeType

enum makVre::FireMessage::FuzeType
Enumerator
FuzeType_OTHER 
FuzeType_CONTACT 
FuzeType_CONTACTINSTANT 
FuzeType_CONTACTDELAYED 
FuzeType_TIMED 
FuzeType_PROXIMITY 
FuzeType_COMMAND 
FuzeType_ALTITUDE 
FuzeType_DEPTH 
FuzeType_ACOUSTIC 

◆ WarheadType

enum makVre::FireMessage::WarheadType
Enumerator
WarheadType_OTHER 
WarheadType_HIGHEXPLOSIVE 
WarheadType_HIGHEXPLOSIVEPLATIC 
WarheadType_HIGHEXPLOSIVEINCENDIARY 
WarheadType_HIGHEXPLOSIVEFRAGMENTATION 
WarheadType_HIGHEXPLOSIVEANTITANK 
WarheadType_HIGHEXPLOSIVEBOMBLETS 
WarheadType_HIGHEXPLOSIVESHAPEDCHARGE 
WarheadType_SMOKE 
WarheadType_ILLUMINATION 
WarheadType_PRACTICE 
WarheadType_KINETIC 
WarheadType_UNUSED 
WarheadType_NUCLEAR 
WarheadType_CHEMICALGENERAL 
WarheadType_CHEMICALBLISTER 
WarheadType_CHEMICALBLOOD 
WarheadType_CHEMICALNERVE 
WarheadType_BIOLOGICALGENERAL 

Constructor & Destructor Documentation

◆ ~FireMessage()

virtual makVre::FireMessage::~FireMessage ( )
overridevirtual

◆ FireMessage()

makVre::FireMessage::FireMessage ( )
protected

Referenced by create(), createFrom(), createFromData(), and operator==().

Member Function Documentation

◆ create()

static FireMessage * makVre::FireMessage::create ( )
static

References FireMessage().

◆ createFrom()

static FireMessage * makVre::FireMessage::createFrom ( FireMessage * )
static

References FireMessage().

◆ createFromData()

static FireMessage * makVre::FireMessage::createFromData ( const FireData )
static

References FireMessage().

◆ theType()

static const std::string & makVre::FireMessage::theType ( )
static

static message identity functions

◆ theId()

static const makVre::DtVreMessageId & makVre::FireMessage::theId ( )
static

◆ theVersionNumber()

static UInt64 makVre::FireMessage::theVersionNumber ( )
static

◆ type()

virtual const std::string & makVre::FireMessage::type ( ) const
overridevirtual

Get the name of the message type.

Implements makVre::DtVreMessage.

◆ messageId()

virtual const makVre::DtVreMessageId & makVre::FireMessage::messageId ( ) const
overridevirtual

Gets the message ID object.

Returns
Reference to the message ID object

This pure virtual method must be implemented by derived classes to return a unique identifier object for the message. The message ID contains both the type name and a hash value for efficient routing.

Implements makVre::DtVreMessage.

◆ getFiringId()

virtual const std::string & makVre::FireMessage::getFiringId ( ) const
virtual

◆ setFiringId()

virtual void makVre::FireMessage::setFiringId ( const std::string & val)
virtual

◆ getTargetId()

virtual const std::string & makVre::FireMessage::getTargetId ( ) const
virtual

◆ setTargetId()

virtual void makVre::FireMessage::setTargetId ( const std::string & val)
virtual

◆ getMunitionId()

virtual const std::string & makVre::FireMessage::getMunitionId ( ) const
virtual

◆ setMunitionId()

virtual void makVre::FireMessage::setMunitionId ( const std::string & val)
virtual

◆ getWorldPosition()

virtual const DtVector & makVre::FireMessage::getWorldPosition ( ) const
virtual

◆ setWorldPosition()

virtual void makVre::FireMessage::setWorldPosition ( const DtVector & val)
virtual

◆ getVelocity()

virtual const DtVector & makVre::FireMessage::getVelocity ( ) const
virtual

◆ setVelocity()

virtual void makVre::FireMessage::setVelocity ( const DtVector & val)
virtual

◆ getRange()

virtual double makVre::FireMessage::getRange ( ) const
virtual

◆ setRange()

virtual void makVre::FireMessage::setRange ( double val)
virtual

◆ getEventId()

virtual int makVre::FireMessage::getEventId ( ) const
virtual

◆ setEventId()

virtual void makVre::FireMessage::setEventId ( int val)
virtual

◆ getMunitionType()

virtual const DtEntityType & makVre::FireMessage::getMunitionType ( ) const
virtual

◆ setMunitionType()

virtual void makVre::FireMessage::setMunitionType ( const DtEntityType & val)
virtual

◆ getFuzeType()

virtual FuzeType makVre::FireMessage::getFuzeType ( ) const
virtual

◆ setFuzeType()

virtual void makVre::FireMessage::setFuzeType ( FuzeType val)
virtual

◆ getWarheadType()

virtual WarheadType makVre::FireMessage::getWarheadType ( ) const
virtual

◆ setWarheadType()

virtual void makVre::FireMessage::setWarheadType ( WarheadType val)
virtual

◆ getQuantity()

virtual int makVre::FireMessage::getQuantity ( ) const
virtual

◆ setQuantity()

virtual void makVre::FireMessage::setQuantity ( int val)
virtual

◆ getRate()

virtual int makVre::FireMessage::getRate ( ) const
virtual

◆ setRate()

virtual void makVre::FireMessage::setRate ( int val)
virtual

◆ messageSize()

virtual int makVre::FireMessage::messageSize ( ) const
overridevirtual

Static decode function pattern for derived classes.

Note
Each derived class must implement a static decode function with the signature:
static DtVreMessage* decode(unsigned char* buffer, int length);
makVre::DtVreMessage::DtVreMessage
DtVreMessage()
Default constructor.
makVre::FireMessage::decode
static makVre::DtVreMessage * decode(char *buffer, int length)
This function is used by the message factory to create messages from raw data.

Gets the total size of the serialized message in bytes

Returns
Size of the message in bytes

This method calculates the total size of the message when serialized, including the base message header (message size, type hash, application ID, version, and delay) and any data added by derived classes.

Derived classes should override this method to include their own data size while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

◆ decode()

static makVre::DtVreMessage * makVre::FireMessage::decode ( char * buffer,
int length )
static

◆ getData() [1/2]

FireData makVre::FireMessage::getData ( )

◆ getData() [2/2]

FireData makVre::FireMessage::getData ( ) const

◆ operator==()

bool makVre::FireMessage::operator== ( const FireMessage & rhs) const

References FireMessage().

◆ serialize()

virtual void makVre::FireMessage::serialize ( DtStreamWriter & writer) const
overrideprotectedvirtual

Serializes the message to a stream writer.

Parameters
writerReference to the stream writer

This method writes the message header fields to the stream writer. Derived classes should override this method to add their own fields while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

◆ deserialize()

virtual void makVre::FireMessage::deserialize ( DtStreamReader & reader)
overrideprotectedvirtual

Deserializes the message from a stream reader.

Parameters
readerReference to the stream reader

This method reads the message header fields from the stream reader. Derived classes should override this method to read their own fields while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

Member Data Documentation

◆ theMessageId

makVre::DtVreMessageId makVre::FireMessage::theMessageId
staticprotected

◆ theVersion

UInt64 makVre::FireMessage::theVersion
staticprotected

◆ myData

FireData makVre::FireMessage::myData
protected
The documentation for this class was generated from the following file: