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

#include <cigiViewControl.h>

Inheritance diagram for makVre::VreCigiViewControlMessage:
[legend]

Classes

struct  VreCigiViewControlData
 

Public Member Functions

virtual const std::string & type () const override
 
virtual const makVre::DtVreMessageId & messageId () const override
 
virtual ~VreCigiViewControlMessage () override
 
virtual const DtSimulationAddress & getHostSimAddress () const
 
virtual void setHostSimAddress (const DtSimulationAddress &val)
 
virtual const std::string & getSessionName () const
 
virtual void setSessionName (const std::string &val)
 
virtual int getViewId () const
 
virtual void setViewId (int val)
 
virtual int getGroupId () const
 
virtual void setGroupId (int val)
 
virtual const DtEntityIdentifier & getAttachTo () const
 
virtual void setAttachTo (const DtEntityIdentifier &val)
 
virtual const DtVector32 & getPositionOffset () const
 
virtual void setPositionOffset (const DtVector32 &val)
 
virtual const DtVector32 & getRotationOffset () const
 
virtual void setRotationOffset (const DtVector32 &val)
 
virtual int getAttachToPart () const
 
virtual void setAttachToPart (int val)
 
virtual int getAttachType () const
 
virtual void setAttachType (int val)
 
virtual int messageSize () const override
 
VreCigiViewControlData getData ()
 
VreCigiViewControlData getData () const
 
bool operator== (const VreCigiViewControlMessage &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 VreCigiViewControlMessage * create ()
 
static VreCigiViewControlMessage * createFrom (VreCigiViewControlMessage *)
 
static VreCigiViewControlMessage * createFromData (const VreCigiViewControlData)
 
static const std::string & theType ()
 
static const makVre::DtVreMessageId & theId ()
 
static UInt64 theVersionNumber ()
 
static makVre::DtVreMessage * decode (char *buffer, int length)
 

Protected Member Functions

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

Protected Attributes

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

Static Protected Attributes

static makVre::DtVreMessageId theMessageId
 
static UInt64 theVersion
 

Constructor & Destructor Documentation

◆ ~VreCigiViewControlMessage()

virtual makVre::VreCigiViewControlMessage::~VreCigiViewControlMessage ( )
overridevirtual

◆ VreCigiViewControlMessage()

makVre::VreCigiViewControlMessage::VreCigiViewControlMessage ( )
protected

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

Member Function Documentation

◆ create()

static VreCigiViewControlMessage * makVre::VreCigiViewControlMessage::create ( )
static

References VreCigiViewControlMessage().

◆ createFrom()

static VreCigiViewControlMessage * makVre::VreCigiViewControlMessage::createFrom ( VreCigiViewControlMessage * )
static

References VreCigiViewControlMessage().

◆ createFromData()

static VreCigiViewControlMessage * makVre::VreCigiViewControlMessage::createFromData ( const VreCigiViewControlData )
static

References VreCigiViewControlMessage().

◆ theType()

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

static message identity functions

◆ theId()

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

◆ theVersionNumber()

static UInt64 makVre::VreCigiViewControlMessage::theVersionNumber ( )
static

◆ type()

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

Get the name of the message type.

Implements makVre::DtVreMessage.

◆ messageId()

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

◆ getHostSimAddress()

virtual const DtSimulationAddress & makVre::VreCigiViewControlMessage::getHostSimAddress ( ) const
virtual

◆ setHostSimAddress()

virtual void makVre::VreCigiViewControlMessage::setHostSimAddress ( const DtSimulationAddress & val)
virtual

◆ getSessionName()

virtual const std::string & makVre::VreCigiViewControlMessage::getSessionName ( ) const
virtual

◆ setSessionName()

virtual void makVre::VreCigiViewControlMessage::setSessionName ( const std::string & val)
virtual

◆ getViewId()

virtual int makVre::VreCigiViewControlMessage::getViewId ( ) const
virtual

◆ setViewId()

virtual void makVre::VreCigiViewControlMessage::setViewId ( int val)
virtual

◆ getGroupId()

virtual int makVre::VreCigiViewControlMessage::getGroupId ( ) const
virtual

◆ setGroupId()

virtual void makVre::VreCigiViewControlMessage::setGroupId ( int val)
virtual

◆ getAttachTo()

virtual const DtEntityIdentifier & makVre::VreCigiViewControlMessage::getAttachTo ( ) const
virtual

◆ setAttachTo()

virtual void makVre::VreCigiViewControlMessage::setAttachTo ( const DtEntityIdentifier & val)
virtual

◆ getPositionOffset()

virtual const DtVector32 & makVre::VreCigiViewControlMessage::getPositionOffset ( ) const
virtual

◆ setPositionOffset()

virtual void makVre::VreCigiViewControlMessage::setPositionOffset ( const DtVector32 & val)
virtual

◆ getRotationOffset()

virtual const DtVector32 & makVre::VreCigiViewControlMessage::getRotationOffset ( ) const
virtual

◆ setRotationOffset()

virtual void makVre::VreCigiViewControlMessage::setRotationOffset ( const DtVector32 & val)
virtual

◆ getAttachToPart()

virtual int makVre::VreCigiViewControlMessage::getAttachToPart ( ) const
virtual

◆ setAttachToPart()

virtual void makVre::VreCigiViewControlMessage::setAttachToPart ( int val)
virtual

◆ getAttachType()

virtual int makVre::VreCigiViewControlMessage::getAttachType ( ) const
virtual

◆ setAttachType()

virtual void makVre::VreCigiViewControlMessage::setAttachType ( int val)
virtual

◆ messageSize()

virtual int makVre::VreCigiViewControlMessage::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::VreCigiViewControlMessage::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::VreCigiViewControlMessage::decode ( char * buffer,
int length )
static

◆ getData() [1/2]

VreCigiViewControlData makVre::VreCigiViewControlMessage::getData ( )

◆ getData() [2/2]

VreCigiViewControlData makVre::VreCigiViewControlMessage::getData ( ) const

◆ operator==()

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

References VreCigiViewControlMessage().

◆ serialize()

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

◆ theVersion

UInt64 makVre::VreCigiViewControlMessage::theVersion
staticprotected

◆ myData

VreCigiViewControlData makVre::VreCigiViewControlMessage::myData
protected
The documentation for this class was generated from the following file: