makVre::WindowOperationMessage Class Reference

#include <windowOperation.h>

Inheritance diagram for makVre::WindowOperationMessage:

Classes
struct	WindowOperationData

Public Types
enum	OperationType { OperationType_Create , OperationType_Modify , OperationType_Destroy }
enum	WindowType {   WindowType_Gimbal , WindowType_PVD , WindowType_Stealth , WindowType_InstrumentPanel ,   WindowType_Any }

Public Member Functions
virtual const std::string &	type () const override
virtual const makVre::DtVreMessageId &	messageId () const override
virtual	~WindowOperationMessage () override
virtual const std::string &	getMarking () const
virtual void	setMarking (const std::string &val)
virtual const DtEntityIdentifier &	getOwnshipEntityId () const
virtual void	setOwnshipEntityId (const DtEntityIdentifier &val)
virtual const DtEntityIdentifier &	getPanelHostEntityId () const
virtual void	setPanelHostEntityId (const DtEntityIdentifier &val)
virtual OperationType	getOperation () const
virtual void	setOperation (OperationType val)
virtual WindowType	getWindowType () const
virtual void	setWindowType (WindowType val)
virtual const std::string &	getSensorMode () const
virtual void	setSensorMode (const std::string &val)
virtual const std::string &	getModelDefinition () const
virtual void	setModelDefinition (const std::string &val)
virtual const DtVector &	getWindowPosition () const
virtual void	setWindowPosition (const DtVector &val)
virtual const DtVector &	getWindowSize () const
virtual void	setWindowSize (const DtVector &val)
virtual int	getScreen () const
virtual void	setScreen (int val)
virtual bool	getIsFullScreen () const
virtual void	setIsFullScreen (bool val)
virtual const DtEntityIdentifier &	getModifyAttachedId () const
virtual void	setModifyAttachedId (const DtEntityIdentifier &val)
virtual const std::string &	getModifyAttachedMarkingText () const
virtual void	setModifyAttachedMarkingText (const std::string &val)
virtual const DtVector &	getModifyAttachedOffset () const
virtual void	setModifyAttachedOffset (const DtVector &val)
virtual const std::string &	getChannelName () const
virtual void	setChannelName (const std::string &val)
virtual double	getZoomLevel () const
virtual void	setZoomLevel (double val)
virtual double	getViewportLeft () const
virtual void	setViewportLeft (double val)
virtual double	getViewportRight () const
virtual void	setViewportRight (double val)
virtual double	getViewportBottom () const
virtual void	setViewportBottom (double val)
virtual double	getViewportTop () const
virtual void	setViewportTop (double val)
virtual bool	getRtt () const
virtual void	setRtt (bool val)
virtual const std::string &	getReplaceTexture () const
virtual void	setReplaceTexture (const std::string &val)
virtual bool	getHasTransparency () const
virtual void	setHasTransparency (bool val)
virtual double	getZNear () const
virtual void	setZNear (double val)
virtual double	getZFar () const
virtual void	setZFar (double val)
virtual double	getFov () const
virtual void	setFov (double val)
virtual bool	getAttachStealthAsGimbal () const
virtual void	setAttachStealthAsGimbal (bool val)
virtual const std::string &	getStealthObserverMode () const
virtual void	setStealthObserverMode (const std::string &val)
virtual int	getInitialScale () const
virtual void	setInitialScale (int val)
virtual const std::vector< std::string > &	getAdditionalChannelKeywords () const
virtual void	setAdditionalChannelKeywords (const std::vector< std::string > &val)
virtual const std::string &	getPanelId () const
virtual void	setPanelId (const std::string &val)
virtual bool	getCockpitOnly () const
virtual void	setCockpitOnly (bool val)
virtual const DtVector &	getLocationTrackAttachment () const
virtual void	setLocationTrackAttachment (const DtVector &val)
virtual const std::string &	getObjectTrackAttachment () const
virtual void	setObjectTrackAttachment (const std::string &val)
virtual int	messageSize () const override
WindowOperationData	getData ()
WindowOperationData	getData () const
bool	operator== (const WindowOperationMessage &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 WindowOperationMessage *	create ()
static WindowOperationMessage *	createFrom (WindowOperationMessage *)
static WindowOperationMessage *	createFromData (const WindowOperationData)
static const std::string &	theType ()
static const makVre::DtVreMessageId &	theId ()
static UInt64	theVersionNumber ()
static makVre::DtVreMessage *	decode (char *buffer, int length)

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

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

OperationType

enum makVre::WindowOperationMessage::OperationType

Enumerator
OperationType_Create
OperationType_Modify
OperationType_Destroy

WindowType

enum makVre::WindowOperationMessage::WindowType

Enumerator
WindowType_Gimbal
WindowType_PVD
WindowType_Stealth
WindowType_InstrumentPanel
WindowType_Any

Constructor & Destructor Documentation

~WindowOperationMessage()

virtual makVre::WindowOperationMessage::~WindowOperationMessage ( )

overridevirtual

WindowOperationMessage()

makVre::WindowOperationMessage::WindowOperationMessage ( )

protected

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

Member Function Documentation

create()

static WindowOperationMessage * makVre::WindowOperationMessage::create ( )

static

References WindowOperationMessage().

Referenced by makVre::createGimbalView(), makVre::createPlanView(), makVre::destroyGimbalView(), makVre::destroyPlanView(), and makVre::modifyGimbalView().

createFrom()

static WindowOperationMessage * makVre::WindowOperationMessage::createFrom ( WindowOperationMessage * )

static

References WindowOperationMessage().

createFromData()

static WindowOperationMessage * makVre::WindowOperationMessage::createFromData ( const WindowOperationData )

static

References WindowOperationMessage().

theType()

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

static

static message identity functions

theId()

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

static

theVersionNumber()

static UInt64 makVre::WindowOperationMessage::theVersionNumber ( )

static

type()

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

overridevirtual

Get the name of the message type.

Implements makVre::DtVreMessage.

messageId()

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

getMarking()

virtual const std::string & makVre::WindowOperationMessage::getMarking ( ) const

virtual

setMarking()

virtual void makVre::WindowOperationMessage::setMarking ( const std::string & val )

virtual

getOwnshipEntityId()

virtual const DtEntityIdentifier & makVre::WindowOperationMessage::getOwnshipEntityId ( ) const

virtual

setOwnshipEntityId()

virtual void makVre::WindowOperationMessage::setOwnshipEntityId ( const DtEntityIdentifier & val )

virtual

Referenced by makVre::createGimbalView(), makVre::createPlanView(), makVre::destroyGimbalView(), makVre::destroyPlanView(), and makVre::modifyGimbalView().

getPanelHostEntityId()

virtual const DtEntityIdentifier & makVre::WindowOperationMessage::getPanelHostEntityId ( ) const

virtual

setPanelHostEntityId()

virtual void makVre::WindowOperationMessage::setPanelHostEntityId ( const DtEntityIdentifier & val )

virtual

getOperation()

virtual OperationType makVre::WindowOperationMessage::getOperation ( ) const

virtual

setOperation()

virtual void makVre::WindowOperationMessage::setOperation ( OperationType val )

virtual

Referenced by makVre::createGimbalView(), makVre::createPlanView(), makVre::destroyGimbalView(), makVre::destroyPlanView(), and makVre::modifyGimbalView().

getWindowType()

virtual WindowType makVre::WindowOperationMessage::getWindowType ( ) const

virtual

setWindowType()

virtual void makVre::WindowOperationMessage::setWindowType ( WindowType val )

virtual

Referenced by makVre::createGimbalView(), makVre::createPlanView(), makVre::destroyGimbalView(), makVre::destroyPlanView(), and makVre::modifyGimbalView().

getSensorMode()

virtual const std::string & makVre::WindowOperationMessage::getSensorMode ( ) const

virtual

setSensorMode()

virtual void makVre::WindowOperationMessage::setSensorMode ( const std::string & val )

virtual

Referenced by makVre::createGimbalView(), and makVre::modifyGimbalView().

getModelDefinition()

virtual const std::string & makVre::WindowOperationMessage::getModelDefinition ( ) const

virtual

setModelDefinition()

virtual void makVre::WindowOperationMessage::setModelDefinition ( const std::string & val )

virtual

getWindowPosition()

virtual const DtVector & makVre::WindowOperationMessage::getWindowPosition ( ) const

virtual

setWindowPosition()

virtual void makVre::WindowOperationMessage::setWindowPosition ( const DtVector & val )

virtual

Referenced by makVre::createGimbalView(), and makVre::createPlanView().

getWindowSize()

virtual const DtVector & makVre::WindowOperationMessage::getWindowSize ( ) const

virtual

setWindowSize()

virtual void makVre::WindowOperationMessage::setWindowSize ( const DtVector & val )

virtual

Referenced by makVre::createGimbalView(), and makVre::createPlanView().

getScreen()

virtual int makVre::WindowOperationMessage::getScreen ( ) const

virtual

setScreen()

virtual void makVre::WindowOperationMessage::setScreen ( int val )

virtual

Referenced by makVre::createGimbalView(), and makVre::createPlanView().

getIsFullScreen()

virtual bool makVre::WindowOperationMessage::getIsFullScreen ( ) const

virtual

setIsFullScreen()

virtual void makVre::WindowOperationMessage::setIsFullScreen ( bool val )

virtual

Referenced by makVre::createGimbalView(), and makVre::createPlanView().

getModifyAttachedId()

virtual const DtEntityIdentifier & makVre::WindowOperationMessage::getModifyAttachedId ( ) const

virtual

setModifyAttachedId()

virtual void makVre::WindowOperationMessage::setModifyAttachedId ( const DtEntityIdentifier & val )

virtual

getModifyAttachedMarkingText()

virtual const std::string & makVre::WindowOperationMessage::getModifyAttachedMarkingText ( ) const

virtual

setModifyAttachedMarkingText()

virtual void makVre::WindowOperationMessage::setModifyAttachedMarkingText ( const std::string & val )

virtual

getModifyAttachedOffset()

virtual const DtVector & makVre::WindowOperationMessage::getModifyAttachedOffset ( ) const

virtual

setModifyAttachedOffset()

virtual void makVre::WindowOperationMessage::setModifyAttachedOffset ( const DtVector & val )

virtual

getChannelName()

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

virtual

setChannelName()

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

virtual

getZoomLevel()

virtual double makVre::WindowOperationMessage::getZoomLevel ( ) const

virtual

setZoomLevel()

virtual void makVre::WindowOperationMessage::setZoomLevel ( double val )

virtual

getViewportLeft()

virtual double makVre::WindowOperationMessage::getViewportLeft ( ) const

virtual

setViewportLeft()

virtual void makVre::WindowOperationMessage::setViewportLeft ( double val )

virtual

getViewportRight()

virtual double makVre::WindowOperationMessage::getViewportRight ( ) const

virtual

setViewportRight()

virtual void makVre::WindowOperationMessage::setViewportRight ( double val )

virtual

getViewportBottom()

virtual double makVre::WindowOperationMessage::getViewportBottom ( ) const

virtual

setViewportBottom()

virtual void makVre::WindowOperationMessage::setViewportBottom ( double val )

virtual

getViewportTop()

virtual double makVre::WindowOperationMessage::getViewportTop ( ) const

virtual

setViewportTop()

virtual void makVre::WindowOperationMessage::setViewportTop ( double val )

virtual

getRtt()

virtual bool makVre::WindowOperationMessage::getRtt ( ) const

virtual

setRtt()

virtual void makVre::WindowOperationMessage::setRtt ( bool val )

virtual

getReplaceTexture()

virtual const std::string & makVre::WindowOperationMessage::getReplaceTexture ( ) const

virtual

setReplaceTexture()

virtual void makVre::WindowOperationMessage::setReplaceTexture ( const std::string & val )

virtual

getHasTransparency()

virtual bool makVre::WindowOperationMessage::getHasTransparency ( ) const

virtual

setHasTransparency()

virtual void makVre::WindowOperationMessage::setHasTransparency ( bool val )

virtual

getZNear()

virtual double makVre::WindowOperationMessage::getZNear ( ) const

virtual

setZNear()

virtual void makVre::WindowOperationMessage::setZNear ( double val )

virtual

getZFar()

virtual double makVre::WindowOperationMessage::getZFar ( ) const

virtual

setZFar()

virtual void makVre::WindowOperationMessage::setZFar ( double val )

virtual

getFov()

virtual double makVre::WindowOperationMessage::getFov ( ) const

virtual

setFov()

virtual void makVre::WindowOperationMessage::setFov ( double val )

virtual

getAttachStealthAsGimbal()

virtual bool makVre::WindowOperationMessage::getAttachStealthAsGimbal ( ) const

virtual

setAttachStealthAsGimbal()

virtual void makVre::WindowOperationMessage::setAttachStealthAsGimbal ( bool val )

virtual

getStealthObserverMode()

virtual const std::string & makVre::WindowOperationMessage::getStealthObserverMode ( ) const

virtual

setStealthObserverMode()

virtual void makVre::WindowOperationMessage::setStealthObserverMode ( const std::string & val )

virtual

getInitialScale()

virtual int makVre::WindowOperationMessage::getInitialScale ( ) const

virtual

setInitialScale()

virtual void makVre::WindowOperationMessage::setInitialScale ( int val )

virtual

getAdditionalChannelKeywords()

virtual const std::vector< std::string > & makVre::WindowOperationMessage::getAdditionalChannelKeywords ( ) const

virtual

setAdditionalChannelKeywords()

virtual void makVre::WindowOperationMessage::setAdditionalChannelKeywords ( const std::vector< std::string > & val )

virtual

getPanelId()

virtual const std::string & makVre::WindowOperationMessage::getPanelId ( ) const

virtual

setPanelId()

virtual void makVre::WindowOperationMessage::setPanelId ( const std::string & val )

virtual

getCockpitOnly()

virtual bool makVre::WindowOperationMessage::getCockpitOnly ( ) const

virtual

setCockpitOnly()

virtual void makVre::WindowOperationMessage::setCockpitOnly ( bool val )

virtual

getLocationTrackAttachment()

virtual const DtVector & makVre::WindowOperationMessage::getLocationTrackAttachment ( ) const

virtual

setLocationTrackAttachment()

virtual void makVre::WindowOperationMessage::setLocationTrackAttachment ( const DtVector & val )

virtual

getObjectTrackAttachment()

virtual const std::string & makVre::WindowOperationMessage::getObjectTrackAttachment ( ) const

virtual

setObjectTrackAttachment()

virtual void makVre::WindowOperationMessage::setObjectTrackAttachment ( const std::string & val )

virtual

messageSize()

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

static

getData() [1/2]

WindowOperationData makVre::WindowOperationMessage::getData

(

)

getData() [2/2]

WindowOperationData makVre::WindowOperationMessage::getData

(

)

const

operator==()

bool makVre::WindowOperationMessage::operator==

(

const WindowOperationMessage &

rhs

)

const

References WindowOperationMessage().

serialize()

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

staticprotected

theVersion

UInt64 makVre::WindowOperationMessage::theVersion

staticprotected

myData

WindowOperationData makVre::WindowOperationMessage::myData

protected

---

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

• include/framework/vreMessages/windowOperation.h