makVre::SarRequestMessage Class Reference

#include <sarRequest.h>

Inheritance diagram for makVre::SarRequestMessage:

Classes
struct	SarRequestData

Public Member Functions
virtual const std::string &	type () const override
virtual const makVre::DtVreMessageId &	messageId () const override
virtual	~SarRequestMessage () override
virtual const std::string &	getOwnshipName () const
virtual void	setOwnshipName (const std::string &val)
virtual const std::string &	getTargetName () const
virtual void	setTargetName (const std::string &val)
virtual const DtVector &	getOwnshipLocation () const
virtual void	setOwnshipLocation (const DtVector &val)
virtual const DtVector &	getTargetLocation () const
virtual void	setTargetLocation (const DtVector &val)
virtual const DtVector &	getRadarOffsetLocation () const
virtual void	setRadarOffsetLocation (const DtVector &val)
virtual const std::string &	getRadarName () const
virtual void	setRadarName (const std::string &val)
virtual double	getCrossrange () const
virtual void	setCrossrange (double val)
virtual double	getDownrange () const
virtual void	setDownrange (double val)
virtual bool	getAgcPowerEnabled () const
virtual void	setAgcPowerEnabled (bool val)
virtual float	getOwnshipSpeed () const
virtual void	setOwnshipSpeed (float val)
virtual double	getPower () const
virtual void	setPower (double val)
virtual int	getImageSizeX () const
virtual void	setImageSizeX (int val)
virtual int	getImageSizeY () const
virtual void	setImageSizeY (int val)
virtual int	getImageFormat () const
virtual void	setImageFormat (int val)
virtual int	getImageDataType () const
virtual void	setImageDataType (int val)
virtual int	getImageRotation () const
virtual void	setImageRotation (int val)
virtual int	getReturnMethod () const
virtual void	setReturnMethod (int val)
virtual const std::string &	getImageSavePath () const
virtual void	setImageSavePath (const std::string &val)
virtual const std::string &	getImageFilename () const
virtual void	setImageFilename (const std::string &val)
virtual int	messageSize () const override
SarRequestData	getData ()
SarRequestData	getData () const
bool	operator== (const SarRequestMessage &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 SarRequestMessage *	create ()
static SarRequestMessage *	createFrom (SarRequestMessage *)
static SarRequestMessage *	createFromData (const SarRequestData)
static const std::string &	theType ()
static const makVre::DtVreMessageId &	theId ()
static UInt64	theVersionNumber ()
static makVre::DtVreMessage *	decode (char *buffer, int length)

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

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

~SarRequestMessage()

virtual makVre::SarRequestMessage::~SarRequestMessage ( )

overridevirtual

SarRequestMessage()

makVre::SarRequestMessage::SarRequestMessage ( )

protected

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

Member Function Documentation

create()

static SarRequestMessage * makVre::SarRequestMessage::create ( )

static

References SarRequestMessage().

createFrom()

static SarRequestMessage * makVre::SarRequestMessage::createFrom ( SarRequestMessage * )

static

References SarRequestMessage().

createFromData()

static SarRequestMessage * makVre::SarRequestMessage::createFromData ( const SarRequestData )

static

References SarRequestMessage().

theType()

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

static

static message identity functions

theId()

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

static

theVersionNumber()

static UInt64 makVre::SarRequestMessage::theVersionNumber ( )

static

type()

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

overridevirtual

Get the name of the message type.

Implements makVre::DtVreMessage.

messageId()

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

getOwnshipName()

virtual const std::string & makVre::SarRequestMessage::getOwnshipName ( ) const

virtual

setOwnshipName()

virtual void makVre::SarRequestMessage::setOwnshipName ( const std::string & val )

virtual

getTargetName()

virtual const std::string & makVre::SarRequestMessage::getTargetName ( ) const

virtual

setTargetName()

virtual void makVre::SarRequestMessage::setTargetName ( const std::string & val )

virtual

getOwnshipLocation()

virtual const DtVector & makVre::SarRequestMessage::getOwnshipLocation ( ) const

virtual

setOwnshipLocation()

virtual void makVre::SarRequestMessage::setOwnshipLocation ( const DtVector & val )

virtual

getTargetLocation()

virtual const DtVector & makVre::SarRequestMessage::getTargetLocation ( ) const

virtual

setTargetLocation()

virtual void makVre::SarRequestMessage::setTargetLocation ( const DtVector & val )

virtual

getRadarOffsetLocation()

virtual const DtVector & makVre::SarRequestMessage::getRadarOffsetLocation ( ) const

virtual

setRadarOffsetLocation()

virtual void makVre::SarRequestMessage::setRadarOffsetLocation ( const DtVector & val )

virtual

getRadarName()

virtual const std::string & makVre::SarRequestMessage::getRadarName ( ) const

virtual

setRadarName()

virtual void makVre::SarRequestMessage::setRadarName ( const std::string & val )

virtual

getCrossrange()

virtual double makVre::SarRequestMessage::getCrossrange ( ) const

virtual

setCrossrange()

virtual void makVre::SarRequestMessage::setCrossrange ( double val )

virtual

getDownrange()

virtual double makVre::SarRequestMessage::getDownrange ( ) const

virtual

setDownrange()

virtual void makVre::SarRequestMessage::setDownrange ( double val )

virtual

getAgcPowerEnabled()

virtual bool makVre::SarRequestMessage::getAgcPowerEnabled ( ) const

virtual

setAgcPowerEnabled()

virtual void makVre::SarRequestMessage::setAgcPowerEnabled ( bool val )

virtual

getOwnshipSpeed()

virtual float makVre::SarRequestMessage::getOwnshipSpeed ( ) const

virtual

setOwnshipSpeed()

virtual void makVre::SarRequestMessage::setOwnshipSpeed ( float val )

virtual

getPower()

virtual double makVre::SarRequestMessage::getPower ( ) const

virtual

setPower()

virtual void makVre::SarRequestMessage::setPower ( double val )

virtual

getImageSizeX()

virtual int makVre::SarRequestMessage::getImageSizeX ( ) const

virtual

setImageSizeX()

virtual void makVre::SarRequestMessage::setImageSizeX ( int val )

virtual

getImageSizeY()

virtual int makVre::SarRequestMessage::getImageSizeY ( ) const

virtual

setImageSizeY()

virtual void makVre::SarRequestMessage::setImageSizeY ( int val )

virtual

getImageFormat()

virtual int makVre::SarRequestMessage::getImageFormat ( ) const

virtual

setImageFormat()

virtual void makVre::SarRequestMessage::setImageFormat ( int val )

virtual

getImageDataType()

virtual int makVre::SarRequestMessage::getImageDataType ( ) const

virtual

setImageDataType()

virtual void makVre::SarRequestMessage::setImageDataType ( int val )

virtual

getImageRotation()

virtual int makVre::SarRequestMessage::getImageRotation ( ) const

virtual

setImageRotation()

virtual void makVre::SarRequestMessage::setImageRotation ( int val )

virtual

getReturnMethod()

virtual int makVre::SarRequestMessage::getReturnMethod ( ) const

virtual

setReturnMethod()

virtual void makVre::SarRequestMessage::setReturnMethod ( int val )

virtual

getImageSavePath()

virtual const std::string & makVre::SarRequestMessage::getImageSavePath ( ) const

virtual

setImageSavePath()

virtual void makVre::SarRequestMessage::setImageSavePath ( const std::string & val )

virtual

getImageFilename()

virtual const std::string & makVre::SarRequestMessage::getImageFilename ( ) const

virtual

setImageFilename()

virtual void makVre::SarRequestMessage::setImageFilename ( const std::string & val )

virtual

messageSize()

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

static

getData() [1/2]

SarRequestData makVre::SarRequestMessage::getData

(

)

getData() [2/2]

SarRequestData makVre::SarRequestMessage::getData

(

)

const

operator==()

bool makVre::SarRequestMessage::operator==

(

const SarRequestMessage &

rhs

)

const

References SarRequestMessage().

serialize()

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

staticprotected

theVersion

UInt64 makVre::SarRequestMessage::theVersion

staticprotected

myData

SarRequestData makVre::SarRequestMessage::myData

protected

---

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

• include/framework/vreMessages/sarRequest.h