VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::SimulationStateMessage Class Reference

#include <simulationState.h>

Inheritance diagram for makVre::SimulationStateMessage:
[legend]

Classes

struct  ArtPart
 
struct  AttPart
 
struct  EmbeddedEntity
 
struct  EngagedRole
 
struct  Parameter
 
struct  SimulationStateData
 

Public Types

enum  TrailingEffects { TrailingEffects_NONE , TrailingEffects_SMALL , TrailingEffects_MEDIUM , TrailingEffects_LARGE }
 
enum  ForceType { ForceType_OTHER , ForceType_FRIENDLY , ForceType_OPPOSING , ForceType_NEUTRAL }
 
enum  ParameterTypes {
  ParameterTypes_POSITION = 1 , ParameterTypes_POSITIONRATE = 2 , ParameterTypes_EXTENSION = 3 , ParameterTypes_EXTENSIONRATE = 4 ,
  ParameterTypes_X = 5 , ParameterTypes_XRATE = 6 , ParameterTypes_Y = 7 , ParameterTypes_YRATE = 8 ,
  ParameterTypes_Z = 9 , ParameterTypes_ZRATE = 10 , ParameterTypes_AZIMUTH = 11 , ParameterTypes_AZIMUTHRATE = 12 ,
  ParameterTypes_ELEVATION = 13 , ParameterTypes_ELEVATIONRATE = 14 , ParameterTypes_ROTATION = 15 , ParameterTypes_ROTATIONRATE = 16
}
 
enum  WeaponState { WeaponState_NOWEAPON , WeaponState_STOWED , WeaponState_DEPLOYED , WeaponState_FIREPOSITION }
 
enum  EmbeddedEntityState { EmbeddedEntityState_RECOVERED , EmbeddedEntityState_DEPLOYED_AND_EXTANT , EmbeddedEntityState_DEPLOYED_AND_DELETED , EmbeddedEntityState_UNKNOWN }
 
enum  ComplianceState {
  ComplianceState_NA , ComplianceState_DETAINED , ComplianceState_SURRENDER , ComplianceState_USING_FISTS ,
  ComplianceState_VERBAL_ABUSE1 , ComplianceState_VERBAL_ABUSE2 , ComplianceState_VERBAL_ABUSE3 , ComplianceState_PASSIVE_RESISTANCE1 ,
  ComplianceState_PASSIVE_RESISTANCE2 , ComplianceState_PASSIVE_RESISTANCE3 , ComplianceState_NON_LETHAL_WEAPON1 , ComplianceState_NON_LETHAL_WEAPON2 ,
  ComplianceState_NON_LETHAL_WEAPON3 , ComplianceState_NON_LETHAL_WEAPON4 , ComplianceState_NON_LETHAL_WEAPON5 , ComplianceState_NON_LETHAL_WEAPON6
}
 
enum  LightType {
  LightType_LIGHTS =12 , LightType_HEAD_LIGHTS =12 , LightType_FLASH_LIGHTS =12 , LightType_LANDING_LIGHTS =12 ,
  LightType_RUNNING_LIGHTS =12 , LightType_TAIL_LIGHTS =13 , LightType_NAVIGATION_LIGHTS =13 , LightType_ANTI_COLLISION_LIGHTS =14 ,
  LightType_BRAKE_LIGHTS =14 , LightType_FORMATION_LIGHTS =24 , LightType_BLACK_OUT_LIGHTS =26 , LightType_BLACK_OUT_BRAKE_LIGHTS =27 ,
  LightType_SPOT_LIGHTS =28 , LightType_EXTERIOR_LIGHTS =28 , LightType_EXTERNAL_LIGHTS =28 , LightType_INTERIOR_LIGHTS =29 ,
  LightType_INTERNAL_LIGHTS =29
}
 
enum  DamageState { DamageState_NONE , DamageState_SLIGHT , DamageState_MODERATE , DamageState_DESTROYED }
 
enum  LifeformState {
  LifeformState_NA , LifeformState_STANDING , LifeformState_WALKING , LifeformState_RUNNING ,
  LifeformState_KNEELING , LifeformState_PRONE , LifeformState_CRAWLING , LifeformState_SWIMMING ,
  LifeformState_PARACHUTING , LifeformState_JUMPING , LifeformState_SITTING , LifeformState_SQUATTING ,
  LifeformState_CROUCHING , LifeformState_WADING , LifeformState_SURRENDERED , LifeformState_DETAINED
}
 
enum  HatchState {
  HatchState_NA , HatchState_CLOSED , HatchState_POPPED , HatchState_POPPEDANDPERSON ,
  HatchState_OPEN , HatchState_OPENANDPERSON
}
 
enum  CamoflageType { CamoflageType_DESERT , CamoflageType_WINTER , CamoflageType_FOREST }
 

Public Member Functions

virtual const std::string & type () const override
 
virtual const makVre::DtVreMessageIdmessageId () const override
 
virtual ~SimulationStateMessage () override
 
virtual const DtEntityIdentifier & getId () const
 
virtual void setId (const DtEntityIdentifier &val)
 
virtual const DtEntityType & getType () const
 
virtual void setType (const DtEntityType &val)
 
virtual const std::string & getObjectLabel () const
 
virtual void setObjectLabel (const std::string &val)
 
virtual DamageState getDamageState () const
 
virtual void setDamageState (DamageState val)
 
virtual const DtVector & getWorldPosition () const
 
virtual void setWorldPosition (const DtVector &val)
 
virtual const DtVector32 & getWorldVelocity () const
 
virtual void setWorldVelocity (const DtVector32 &val)
 
virtual const DtVector32 & getWorldAcceleration () const
 
virtual void setWorldAcceleration (const DtVector32 &val)
 
virtual const DtTaitBryan & getWorldOrientation () const
 
virtual void setWorldOrientation (const DtTaitBryan &val)
 
virtual const DtVector32 & getRotationalVelocity () const
 
virtual void setRotationalVelocity (const DtVector32 &val)
 
virtual ForceType getForceType () const
 
virtual void setForceType (ForceType val)
 
virtual unsigned int getAppearanceBits () const
 
virtual void setAppearanceBits (unsigned int val)
 
virtual const std::vector< ArtPart > & getArticulatedParts () const
 
virtual void setArticulatedParts (const std::vector< ArtPart > &val)
 
virtual const DtEntityIdentifier & getHost () const
 
virtual void setHost (const DtEntityIdentifier &val)
 
virtual const DtEntityType & getHostType () const
 
virtual void setHostType (const DtEntityType &val)
 
virtual const std::string & getHostMarking () const
 
virtual void setHostMarking (const std::string &val)
 
virtual const DtVector32 & getRelativeVelocity () const
 
virtual void setRelativeVelocity (const DtVector32 &val)
 
virtual const std::string & getAutopilotMode () const
 
virtual void setAutopilotMode (const std::string &val)
 
virtual const std::string & getDiguyType () const
 
virtual void setDiguyType (const std::string &val)
 
virtual const std::string & getDiguyAppearance () const
 
virtual void setDiguyAppearance (const std::string &val)
 
virtual const std::string & getDiguyItem () const
 
virtual void setDiguyItem (const std::string &val)
 
virtual const std::string & getDiguyAction () const
 
virtual void setDiguyAction (const std::string &val)
 
virtual int getWeaponIndex () const
 
virtual void setWeaponIndex (int val)
 
virtual int getWeaponState () const
 
virtual void setWeaponState (int val)
 
virtual const std::string & getCameraSystemName () const
 
virtual void setCameraSystemName (const std::string &val)
 
virtual const std::vector< DtEntityIdentifier > & getCameraObjectNames () const
 
virtual void setCameraObjectNames (const std::vector< DtEntityIdentifier > &val)
 
virtual const std::vector< DtEntityIdentifier > & getGateObjectNames () const
 
virtual void setGateObjectNames (const std::vector< DtEntityIdentifier > &val)
 
virtual const std::vector< EmbeddedEntity > & getEmbeddedEntities () const
 
virtual void setEmbeddedEntities (const std::vector< EmbeddedEntity > &val)
 
virtual int getAltitudeAgl () const
 
virtual void setAltitudeAgl (int val)
 
virtual const std::vector< std::string > & getDisabledInstruments () const
 
virtual void setDisabledInstruments (const std::vector< std::string > &val)
 
virtual const std::vector< float > & getPidGains () const
 
virtual void setPidGains (const std::vector< float > &val)
 
virtual bool getHideOccupants () const
 
virtual void setHideOccupants (bool val)
 
virtual const std::string & getEmbarkedAsRole () const
 
virtual void setEmbarkedAsRole (const std::string &val)
 
virtual bool getInvisible () const
 
virtual void setInvisible (bool val)
 
virtual const std::vector< EngagedRole > & getEngagedRoles () const
 
virtual void setEngagedRoles (const std::vector< EngagedRole > &val)
 
virtual int messageSize () const override
 
SimulationStateData getData ()
 
SimulationStateData getData () const
 
bool operator== (const SimulationStateMessage &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 SimulationStateMessagecreate ()
 
static SimulationStateMessagecreateFrom (SimulationStateMessage *)
 
static SimulationStateMessagecreateFromData (const SimulationStateData)
 
static const std::string & theType ()
 
static const makVre::DtVreMessageIdtheId ()
 
static UInt64 theVersionNumber ()
 
static makVre::DtVreMessagedecode (char *buffer, int length)
 

Protected Member Functions

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

Protected Attributes

SimulationStateData 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

◆ TrailingEffects

Enumerator
TrailingEffects_NONE 
TrailingEffects_SMALL 
TrailingEffects_MEDIUM 
TrailingEffects_LARGE 

◆ ForceType

Enumerator
ForceType_OTHER 
ForceType_FRIENDLY 
ForceType_OPPOSING 
ForceType_NEUTRAL 

◆ ParameterTypes

Enumerator
ParameterTypes_POSITION 
ParameterTypes_POSITIONRATE 
ParameterTypes_EXTENSION 
ParameterTypes_EXTENSIONRATE 
ParameterTypes_X 
ParameterTypes_XRATE 
ParameterTypes_Y 
ParameterTypes_YRATE 
ParameterTypes_Z 
ParameterTypes_ZRATE 
ParameterTypes_AZIMUTH 
ParameterTypes_AZIMUTHRATE 
ParameterTypes_ELEVATION 
ParameterTypes_ELEVATIONRATE 
ParameterTypes_ROTATION 
ParameterTypes_ROTATIONRATE 

◆ WeaponState

Enumerator
WeaponState_NOWEAPON 
WeaponState_STOWED 
WeaponState_DEPLOYED 
WeaponState_FIREPOSITION 

◆ EmbeddedEntityState

Enumerator
EmbeddedEntityState_RECOVERED 
EmbeddedEntityState_DEPLOYED_AND_EXTANT 
EmbeddedEntityState_DEPLOYED_AND_DELETED 
EmbeddedEntityState_UNKNOWN 

◆ ComplianceState

Enumerator
ComplianceState_NA 
ComplianceState_DETAINED 
ComplianceState_SURRENDER 
ComplianceState_USING_FISTS 
ComplianceState_VERBAL_ABUSE1 
ComplianceState_VERBAL_ABUSE2 
ComplianceState_VERBAL_ABUSE3 
ComplianceState_PASSIVE_RESISTANCE1 
ComplianceState_PASSIVE_RESISTANCE2 
ComplianceState_PASSIVE_RESISTANCE3 
ComplianceState_NON_LETHAL_WEAPON1 
ComplianceState_NON_LETHAL_WEAPON2 
ComplianceState_NON_LETHAL_WEAPON3 
ComplianceState_NON_LETHAL_WEAPON4 
ComplianceState_NON_LETHAL_WEAPON5 
ComplianceState_NON_LETHAL_WEAPON6 

◆ LightType

Enumerator
LightType_LIGHTS 
LightType_HEAD_LIGHTS 
LightType_FLASH_LIGHTS 
LightType_LANDING_LIGHTS 
LightType_RUNNING_LIGHTS 
LightType_TAIL_LIGHTS 
LightType_NAVIGATION_LIGHTS 
LightType_ANTI_COLLISION_LIGHTS 
LightType_BRAKE_LIGHTS 
LightType_FORMATION_LIGHTS 
LightType_BLACK_OUT_LIGHTS 
LightType_BLACK_OUT_BRAKE_LIGHTS 
LightType_SPOT_LIGHTS 
LightType_EXTERIOR_LIGHTS 
LightType_EXTERNAL_LIGHTS 
LightType_INTERIOR_LIGHTS 
LightType_INTERNAL_LIGHTS 

◆ DamageState

Enumerator
DamageState_NONE 
DamageState_SLIGHT 
DamageState_MODERATE 
DamageState_DESTROYED 

◆ LifeformState

Enumerator
LifeformState_NA 
LifeformState_STANDING 
LifeformState_WALKING 
LifeformState_RUNNING 
LifeformState_KNEELING 
LifeformState_PRONE 
LifeformState_CRAWLING 
LifeformState_SWIMMING 
LifeformState_PARACHUTING 
LifeformState_JUMPING 
LifeformState_SITTING 
LifeformState_SQUATTING 
LifeformState_CROUCHING 
LifeformState_WADING 
LifeformState_SURRENDERED 
LifeformState_DETAINED 

◆ HatchState

Enumerator
HatchState_NA 
HatchState_CLOSED 
HatchState_POPPED 
HatchState_POPPEDANDPERSON 
HatchState_OPEN 
HatchState_OPENANDPERSON 

◆ CamoflageType

Enumerator
CamoflageType_DESERT 
CamoflageType_WINTER 
CamoflageType_FOREST 

Constructor & Destructor Documentation

◆ ~SimulationStateMessage()

virtual makVre::SimulationStateMessage::~SimulationStateMessage ( )
overridevirtual

◆ SimulationStateMessage()

makVre::SimulationStateMessage::SimulationStateMessage ( )
protected

Member Function Documentation

◆ create()

static SimulationStateMessage * makVre::SimulationStateMessage::create ( )
static

◆ createFrom()

static SimulationStateMessage * makVre::SimulationStateMessage::createFrom ( SimulationStateMessage * )
static

◆ createFromData()

static SimulationStateMessage * makVre::SimulationStateMessage::createFromData ( const SimulationStateData )
static

◆ theType()

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

◆ theId()

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

◆ theVersionNumber()

static UInt64 makVre::SimulationStateMessage::theVersionNumber ( )
static

◆ type()

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

Get the name of the message type.

Implements makVre::DtVreMessage.

◆ messageId()

virtual const makVre::DtVreMessageId & makVre::SimulationStateMessage::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.

◆ getId()

virtual const DtEntityIdentifier & makVre::SimulationStateMessage::getId ( ) const
virtual

◆ setId()

virtual void makVre::SimulationStateMessage::setId ( const DtEntityIdentifier & val)
virtual

◆ getType()

virtual const DtEntityType & makVre::SimulationStateMessage::getType ( ) const
virtual

◆ setType()

virtual void makVre::SimulationStateMessage::setType ( const DtEntityType & val)
virtual

◆ getObjectLabel()

virtual const std::string & makVre::SimulationStateMessage::getObjectLabel ( ) const
virtual

◆ setObjectLabel()

virtual void makVre::SimulationStateMessage::setObjectLabel ( const std::string & val)
virtual

◆ getDamageState()

virtual DamageState makVre::SimulationStateMessage::getDamageState ( ) const
virtual

◆ setDamageState()

virtual void makVre::SimulationStateMessage::setDamageState ( DamageState val)
virtual

◆ getWorldPosition()

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

◆ setWorldPosition()

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

◆ getWorldVelocity()

virtual const DtVector32 & makVre::SimulationStateMessage::getWorldVelocity ( ) const
virtual

◆ setWorldVelocity()

virtual void makVre::SimulationStateMessage::setWorldVelocity ( const DtVector32 & val)
virtual

◆ getWorldAcceleration()

virtual const DtVector32 & makVre::SimulationStateMessage::getWorldAcceleration ( ) const
virtual

◆ setWorldAcceleration()

virtual void makVre::SimulationStateMessage::setWorldAcceleration ( const DtVector32 & val)
virtual

◆ getWorldOrientation()

virtual const DtTaitBryan & makVre::SimulationStateMessage::getWorldOrientation ( ) const
virtual

◆ setWorldOrientation()

virtual void makVre::SimulationStateMessage::setWorldOrientation ( const DtTaitBryan & val)
virtual

◆ getRotationalVelocity()

virtual const DtVector32 & makVre::SimulationStateMessage::getRotationalVelocity ( ) const
virtual

◆ setRotationalVelocity()

virtual void makVre::SimulationStateMessage::setRotationalVelocity ( const DtVector32 & val)
virtual

◆ getForceType()

virtual ForceType makVre::SimulationStateMessage::getForceType ( ) const
virtual

◆ setForceType()

virtual void makVre::SimulationStateMessage::setForceType ( ForceType val)
virtual

◆ getAppearanceBits()

virtual unsigned int makVre::SimulationStateMessage::getAppearanceBits ( ) const
virtual

◆ setAppearanceBits()

virtual void makVre::SimulationStateMessage::setAppearanceBits ( unsigned int val)
virtual

◆ getArticulatedParts()

virtual const std::vector< ArtPart > & makVre::SimulationStateMessage::getArticulatedParts ( ) const
virtual

◆ setArticulatedParts()

virtual void makVre::SimulationStateMessage::setArticulatedParts ( const std::vector< ArtPart > & val)
virtual

◆ getHost()

virtual const DtEntityIdentifier & makVre::SimulationStateMessage::getHost ( ) const
virtual

◆ setHost()

virtual void makVre::SimulationStateMessage::setHost ( const DtEntityIdentifier & val)
virtual

◆ getHostType()

virtual const DtEntityType & makVre::SimulationStateMessage::getHostType ( ) const
virtual

◆ setHostType()

virtual void makVre::SimulationStateMessage::setHostType ( const DtEntityType & val)
virtual

◆ getHostMarking()

virtual const std::string & makVre::SimulationStateMessage::getHostMarking ( ) const
virtual

◆ setHostMarking()

virtual void makVre::SimulationStateMessage::setHostMarking ( const std::string & val)
virtual

◆ getRelativeVelocity()

virtual const DtVector32 & makVre::SimulationStateMessage::getRelativeVelocity ( ) const
virtual

◆ setRelativeVelocity()

virtual void makVre::SimulationStateMessage::setRelativeVelocity ( const DtVector32 & val)
virtual

◆ getAutopilotMode()

virtual const std::string & makVre::SimulationStateMessage::getAutopilotMode ( ) const
virtual

◆ setAutopilotMode()

virtual void makVre::SimulationStateMessage::setAutopilotMode ( const std::string & val)
virtual

◆ getDiguyType()

virtual const std::string & makVre::SimulationStateMessage::getDiguyType ( ) const
virtual

◆ setDiguyType()

virtual void makVre::SimulationStateMessage::setDiguyType ( const std::string & val)
virtual

◆ getDiguyAppearance()

virtual const std::string & makVre::SimulationStateMessage::getDiguyAppearance ( ) const
virtual

◆ setDiguyAppearance()

virtual void makVre::SimulationStateMessage::setDiguyAppearance ( const std::string & val)
virtual

◆ getDiguyItem()

virtual const std::string & makVre::SimulationStateMessage::getDiguyItem ( ) const
virtual

◆ setDiguyItem()

virtual void makVre::SimulationStateMessage::setDiguyItem ( const std::string & val)
virtual

◆ getDiguyAction()

virtual const std::string & makVre::SimulationStateMessage::getDiguyAction ( ) const
virtual

◆ setDiguyAction()

virtual void makVre::SimulationStateMessage::setDiguyAction ( const std::string & val)
virtual

◆ getWeaponIndex()

virtual int makVre::SimulationStateMessage::getWeaponIndex ( ) const
virtual

◆ setWeaponIndex()

virtual void makVre::SimulationStateMessage::setWeaponIndex ( int val)
virtual

◆ getWeaponState()

virtual int makVre::SimulationStateMessage::getWeaponState ( ) const
virtual

◆ setWeaponState()

virtual void makVre::SimulationStateMessage::setWeaponState ( int val)
virtual

◆ getCameraSystemName()

virtual const std::string & makVre::SimulationStateMessage::getCameraSystemName ( ) const
virtual

◆ setCameraSystemName()

virtual void makVre::SimulationStateMessage::setCameraSystemName ( const std::string & val)
virtual

◆ getCameraObjectNames()

virtual const std::vector< DtEntityIdentifier > & makVre::SimulationStateMessage::getCameraObjectNames ( ) const
virtual

◆ setCameraObjectNames()

virtual void makVre::SimulationStateMessage::setCameraObjectNames ( const std::vector< DtEntityIdentifier > & val)
virtual

◆ getGateObjectNames()

virtual const std::vector< DtEntityIdentifier > & makVre::SimulationStateMessage::getGateObjectNames ( ) const
virtual

◆ setGateObjectNames()

virtual void makVre::SimulationStateMessage::setGateObjectNames ( const std::vector< DtEntityIdentifier > & val)
virtual

◆ getEmbeddedEntities()

virtual const std::vector< EmbeddedEntity > & makVre::SimulationStateMessage::getEmbeddedEntities ( ) const
virtual

◆ setEmbeddedEntities()

virtual void makVre::SimulationStateMessage::setEmbeddedEntities ( const std::vector< EmbeddedEntity > & val)
virtual

◆ getAltitudeAgl()

virtual int makVre::SimulationStateMessage::getAltitudeAgl ( ) const
virtual

◆ setAltitudeAgl()

virtual void makVre::SimulationStateMessage::setAltitudeAgl ( int val)
virtual

◆ getDisabledInstruments()

virtual const std::vector< std::string > & makVre::SimulationStateMessage::getDisabledInstruments ( ) const
virtual

◆ setDisabledInstruments()

virtual void makVre::SimulationStateMessage::setDisabledInstruments ( const std::vector< std::string > & val)
virtual

◆ getPidGains()

virtual const std::vector< float > & makVre::SimulationStateMessage::getPidGains ( ) const
virtual

◆ setPidGains()

virtual void makVre::SimulationStateMessage::setPidGains ( const std::vector< float > & val)
virtual

◆ getHideOccupants()

virtual bool makVre::SimulationStateMessage::getHideOccupants ( ) const
virtual

◆ setHideOccupants()

virtual void makVre::SimulationStateMessage::setHideOccupants ( bool val)
virtual

◆ getEmbarkedAsRole()

virtual const std::string & makVre::SimulationStateMessage::getEmbarkedAsRole ( ) const
virtual

◆ setEmbarkedAsRole()

virtual void makVre::SimulationStateMessage::setEmbarkedAsRole ( const std::string & val)
virtual

◆ getInvisible()

virtual bool makVre::SimulationStateMessage::getInvisible ( ) const
virtual

◆ setInvisible()

virtual void makVre::SimulationStateMessage::setInvisible ( bool val)
virtual

◆ getEngagedRoles()

virtual const std::vector< EngagedRole > & makVre::SimulationStateMessage::getEngagedRoles ( ) const
virtual

◆ setEngagedRoles()

virtual void makVre::SimulationStateMessage::setEngagedRoles ( const std::vector< EngagedRole > & val)
virtual

◆ messageSize()

virtual int makVre::SimulationStateMessage::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);
DtVreMessage()
Default constructor.
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::SimulationStateMessage::decode ( char * buffer,
int length )
static

◆ getData() [1/2]

SimulationStateData makVre::SimulationStateMessage::getData ( )

◆ getData() [2/2]

SimulationStateData makVre::SimulationStateMessage::getData ( ) const

◆ operator==()

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

◆ serialize()

virtual void makVre::SimulationStateMessage::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::SimulationStateMessage::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::SimulationStateMessage::theMessageId
staticprotected

◆ theVersion

UInt64 makVre::SimulationStateMessage::theVersion
staticprotected

◆ myData

SimulationStateData makVre::SimulationStateMessage::myData
protected

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