makVre::ToggleMouseControlMessage Class Reference

#include <toggleMouseControl.h>

Inheritance diagram for makVre::ToggleMouseControlMessage:

Classes
struct	ToggleMouseControlData

Public Member Functions
virtual const std::string &	type () const override
virtual const makVre::DtVreMessageId &	messageId () const override
virtual	~ToggleMouseControlMessage () override
virtual const std::string &	getWindowName () const
virtual void	setWindowName (const std::string &val)
virtual const std::string &	getChannelName () const
virtual void	setChannelName (const std::string &val)
virtual bool	getState () const
virtual void	setState (bool val)
virtual int	messageSize () const override
ToggleMouseControlData	getData ()
ToggleMouseControlData	getData () const
bool	operator== (const ToggleMouseControlMessage &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 ToggleMouseControlMessage *	create ()
static ToggleMouseControlMessage *	createFrom (ToggleMouseControlMessage *)
static ToggleMouseControlMessage *	createFromData (const ToggleMouseControlData)
static const std::string &	theType ()
static const makVre::DtVreMessageId &	theId ()
static UInt64	theVersionNumber ()
static makVre::DtVreMessage *	decode (char *buffer, int length)

Protected Member Functions
	ToggleMouseControlMessage ()
virtual void	serialize (DtStreamWriter &writer) const override
virtual void	deserialize (DtStreamReader &reader) override

Protected Attributes
ToggleMouseControlData	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

~ToggleMouseControlMessage()

virtual makVre::ToggleMouseControlMessage::~ToggleMouseControlMessage ( )

overridevirtual

ToggleMouseControlMessage()

makVre::ToggleMouseControlMessage::ToggleMouseControlMessage ( )

protected

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

Member Function Documentation

create()

static ToggleMouseControlMessage * makVre::ToggleMouseControlMessage::create ( )

static

References ToggleMouseControlMessage().

createFrom()

static ToggleMouseControlMessage * makVre::ToggleMouseControlMessage::createFrom ( ToggleMouseControlMessage * )

static

References ToggleMouseControlMessage().

createFromData()

static ToggleMouseControlMessage * makVre::ToggleMouseControlMessage::createFromData ( const ToggleMouseControlData )

static

References ToggleMouseControlMessage().

theType()

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

static

static message identity functions

theId()

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

static

theVersionNumber()

static UInt64 makVre::ToggleMouseControlMessage::theVersionNumber ( )

static

type()

virtual const std::string & makVre::ToggleMouseControlMessage::type ( ) const

overridevirtual

Get the name of the message type.

Implements makVre::DtVreMessage.

messageId()

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

getWindowName()

virtual const std::string & makVre::ToggleMouseControlMessage::getWindowName ( ) const

virtual

setWindowName()

virtual void makVre::ToggleMouseControlMessage::setWindowName ( const std::string & val )

virtual

getChannelName()

virtual const std::string & makVre::ToggleMouseControlMessage::getChannelName ( ) const

virtual

setChannelName()

virtual void makVre::ToggleMouseControlMessage::setChannelName ( const std::string & val )

virtual

getState()

virtual bool makVre::ToggleMouseControlMessage::getState ( ) const

virtual

setState()

virtual void makVre::ToggleMouseControlMessage::setState ( bool val )

virtual

messageSize()

virtual int makVre::ToggleMouseControlMessage::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);

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::ToggleMouseControlMessage::decode ( char * buffer, int length )

static

getData() [1/2]

ToggleMouseControlData makVre::ToggleMouseControlMessage::getData

(

)

getData() [2/2]

ToggleMouseControlData makVre::ToggleMouseControlMessage::getData

(

)

const

operator==()

bool makVre::ToggleMouseControlMessage::operator==

(

const ToggleMouseControlMessage &

rhs

)

const

References ToggleMouseControlMessage().

serialize()

virtual void makVre::ToggleMouseControlMessage::serialize ( DtStreamWriter & writer ) const

overrideprotectedvirtual

Serializes the message to a stream writer.

Parameters

writer

Reference 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::ToggleMouseControlMessage::deserialize ( DtStreamReader & reader )

overrideprotectedvirtual

Deserializes the message from a stream reader.

Parameters

reader

Reference 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::ToggleMouseControlMessage::theMessageId

staticprotected

theVersion

UInt64 makVre::ToggleMouseControlMessage::theVersion

staticprotected

myData

ToggleMouseControlData makVre::ToggleMouseControlMessage::myData

protected

---

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

• include/framework/vreMessages/toggleMouseControl.h