makVre::VreCigiViewDefinitionMessage Class Reference

#include <cigiViewDefinition.h>

Inheritance diagram for makVre::VreCigiViewDefinitionMessage:

Classes
struct	VreCigiViewDefinitionData

Public Member Functions
virtual const std::string &	type () const override
virtual const makVre::DtVreMessageId &	messageId () const override
virtual	~VreCigiViewDefinitionMessage () 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 bool	getMirror () const
virtual void	setMirror (bool val)
virtual int	getPixelZoom () const
virtual void	setPixelZoom (int val)
virtual bool	getOrtho () const
virtual void	setOrtho (bool val)
virtual bool	getKeepOnTop () const
virtual void	setKeepOnTop (bool val)
virtual const std::string &	getSensor () const
virtual void	setSensor (const std::string &val)
virtual float	getNear () const
virtual void	setNear (float val)
virtual float	getFar () const
virtual void	setFar (float val)
virtual float	getLeft () const
virtual void	setLeft (float val)
virtual float	getRight () const
virtual void	setRight (float val)
virtual float	getTop () const
virtual void	setTop (float val)
virtual float	getBottom () const
virtual void	setBottom (float val)
virtual float	getMaxViewDistance () const
virtual void	setMaxViewDistance (float val)
virtual float	getMinFovDistance () const
virtual void	setMinFovDistance (float val)
virtual float	getMaxFireFxDistance () const
virtual void	setMaxFireFxDistance (float val)
virtual int	messageSize () const override
VreCigiViewDefinitionData	getData ()
VreCigiViewDefinitionData	getData () const
bool	operator== (const VreCigiViewDefinitionMessage &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 VreCigiViewDefinitionMessage *	create ()
static VreCigiViewDefinitionMessage *	createFrom (VreCigiViewDefinitionMessage *)
static VreCigiViewDefinitionMessage *	createFromData (const VreCigiViewDefinitionData)
static const std::string &	theType ()
static const makVre::DtVreMessageId &	theId ()
static UInt64	theVersionNumber ()
static makVre::DtVreMessage *	decode (char *buffer, int length)

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

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

~VreCigiViewDefinitionMessage()

virtual makVre::VreCigiViewDefinitionMessage::~VreCigiViewDefinitionMessage ( )

overridevirtual

VreCigiViewDefinitionMessage()

makVre::VreCigiViewDefinitionMessage::VreCigiViewDefinitionMessage ( )

protected

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

Member Function Documentation

create()

static VreCigiViewDefinitionMessage * makVre::VreCigiViewDefinitionMessage::create ( )

static

References VreCigiViewDefinitionMessage().

createFrom()

static VreCigiViewDefinitionMessage * makVre::VreCigiViewDefinitionMessage::createFrom ( VreCigiViewDefinitionMessage * )

static

References VreCigiViewDefinitionMessage().

createFromData()

static VreCigiViewDefinitionMessage * makVre::VreCigiViewDefinitionMessage::createFromData ( const VreCigiViewDefinitionData )

static

References VreCigiViewDefinitionMessage().

theType()

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

static

static message identity functions

theId()

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

static

theVersionNumber()

static UInt64 makVre::VreCigiViewDefinitionMessage::theVersionNumber ( )

static

type()

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

overridevirtual

Get the name of the message type.

Implements makVre::DtVreMessage.

messageId()

virtual const makVre::DtVreMessageId & makVre::VreCigiViewDefinitionMessage::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::VreCigiViewDefinitionMessage::getHostSimAddress ( ) const

virtual

setHostSimAddress()

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

virtual

getSessionName()

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

virtual

setSessionName()

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

virtual

getViewId()

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

virtual

setViewId()

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

virtual

getGroupId()

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

virtual

setGroupId()

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

virtual

getMirror()

virtual bool makVre::VreCigiViewDefinitionMessage::getMirror ( ) const

virtual

setMirror()

virtual void makVre::VreCigiViewDefinitionMessage::setMirror ( bool val )

virtual

getPixelZoom()

virtual int makVre::VreCigiViewDefinitionMessage::getPixelZoom ( ) const

virtual

setPixelZoom()

virtual void makVre::VreCigiViewDefinitionMessage::setPixelZoom ( int val )

virtual

getOrtho()

virtual bool makVre::VreCigiViewDefinitionMessage::getOrtho ( ) const

virtual

setOrtho()

virtual void makVre::VreCigiViewDefinitionMessage::setOrtho ( bool val )

virtual

getKeepOnTop()

virtual bool makVre::VreCigiViewDefinitionMessage::getKeepOnTop ( ) const

virtual

setKeepOnTop()

virtual void makVre::VreCigiViewDefinitionMessage::setKeepOnTop ( bool val )

virtual

getSensor()

virtual const std::string & makVre::VreCigiViewDefinitionMessage::getSensor ( ) const

virtual

setSensor()

virtual void makVre::VreCigiViewDefinitionMessage::setSensor ( const std::string & val )

virtual

getNear()

virtual float makVre::VreCigiViewDefinitionMessage::getNear ( ) const

virtual

setNear()

virtual void makVre::VreCigiViewDefinitionMessage::setNear ( float val )

virtual

getFar()

virtual float makVre::VreCigiViewDefinitionMessage::getFar ( ) const

virtual

setFar()

virtual void makVre::VreCigiViewDefinitionMessage::setFar ( float val )

virtual

getLeft()

virtual float makVre::VreCigiViewDefinitionMessage::getLeft ( ) const

virtual

setLeft()

virtual void makVre::VreCigiViewDefinitionMessage::setLeft ( float val )

virtual

getRight()

virtual float makVre::VreCigiViewDefinitionMessage::getRight ( ) const

virtual

setRight()

virtual void makVre::VreCigiViewDefinitionMessage::setRight ( float val )

virtual

getTop()

virtual float makVre::VreCigiViewDefinitionMessage::getTop ( ) const

virtual

setTop()

virtual void makVre::VreCigiViewDefinitionMessage::setTop ( float val )

virtual

getBottom()

virtual float makVre::VreCigiViewDefinitionMessage::getBottom ( ) const

virtual

setBottom()

virtual void makVre::VreCigiViewDefinitionMessage::setBottom ( float val )

virtual

getMaxViewDistance()

virtual float makVre::VreCigiViewDefinitionMessage::getMaxViewDistance ( ) const

virtual

setMaxViewDistance()

virtual void makVre::VreCigiViewDefinitionMessage::setMaxViewDistance ( float val )

virtual

getMinFovDistance()

virtual float makVre::VreCigiViewDefinitionMessage::getMinFovDistance ( ) const

virtual

setMinFovDistance()

virtual void makVre::VreCigiViewDefinitionMessage::setMinFovDistance ( float val )

virtual

getMaxFireFxDistance()

virtual float makVre::VreCigiViewDefinitionMessage::getMaxFireFxDistance ( ) const

virtual

setMaxFireFxDistance()

virtual void makVre::VreCigiViewDefinitionMessage::setMaxFireFxDistance ( float val )

virtual

messageSize()

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

static

getData() [1/2]

VreCigiViewDefinitionData makVre::VreCigiViewDefinitionMessage::getData

(

)

getData() [2/2]

VreCigiViewDefinitionData makVre::VreCigiViewDefinitionMessage::getData

(

)

const

operator==()

bool makVre::VreCigiViewDefinitionMessage::operator==

(

const VreCigiViewDefinitionMessage &

rhs

)

const

References VreCigiViewDefinitionMessage().

serialize()

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

staticprotected

theVersion

UInt64 makVre::VreCigiViewDefinitionMessage::theVersion

staticprotected

myData

VreCigiViewDefinitionData makVre::VreCigiViewDefinitionMessage::myData

protected

---

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

• include/framework/vreMessages/cigiViewDefinition.h