RadarFX API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
makRadarFx::DtMmwResponse Class Reference

DtMmwResponse is the returned image data by the server. More...

Inheritance diagram for makRadarFx::DtMmwResponse:
Inheritance graph
[legend]

Public Member Functions

 DtMmwResponse ()
 CTOR/DTOR.
virtual ~DtMmwResponse ()
virtual void setError (DtImageError error)
 Error value if there is one.
virtual DtImageError error ()
virtual void setWarning (DtImageWarning error)
 Warning value if there is one.
virtual DtImageWarning warning ()
virtual void setReturnMethod (unsigned int method)
 Image return method that is used.
virtual unsigned int returnMethod ()
virtual void setImageFormat (DtImageFormat format)
 Image return format.
virtual DtImageFormat imageFormat ()
virtual void setImageSize (const DtImageSize &size)
 Size of the image returned by the server.
virtual DtImageSize imageSize ()
virtual void setImageDataType (DtImageDataType type)
 Image data type Only available for RAW/NITF image types.
virtual DtImageDataType imageDataType ()
virtual void setFilename (const std::string &filename)
 filename of saved image if it was saved on the server
virtual std::string filename ()
virtual int dataLength ()
 Size of data for the returned image.
virtual void setData (unsigned char *buffer, int length)
 Image data returned by the server. This message class will manage this memory.
virtual unsigned char * data ()
virtual int messageSize ()
 size of the message
virtual DtBaseMessageclone ()
 clone a message. Caller of function is responsible managing this memory
- Public Member Functions inherited from makRadarFx::DtImageResponse
 DtImageResponse ()
 CTOR/DTOR.
virtual ~DtImageResponse ()
- Public Member Functions inherited from makRadarFx::DtBaseMessage
 DtBaseMessage ()
 CTOR/DTOR.
virtual ~DtBaseMessage ()
virtual unsigned int messageType () const
 Get the name of the message type.
virtual unsigned char * encode ()
 Encode the message as an array of bytes and return the bytes the receiver is responsible for calling delete [] on these bytes.
virtual void setRequestorId (const std::string &requestor)
 Assigns the requestor name of this message.
virtual std::string requestorId ()
virtual void setRequestId (int id)
 Assigns the request id of this message.
virtual int requestId ()

Static Public Member Functions

static DtBaseMessagedecode (unsigned char *buffer, int length)
 decode a message. Used by the factory

Protected Member Functions

virtual void serialize (DtStreamWriter &writer)
virtual void deserialize (DtStreamReader &reader)

Protected Attributes

DtImageError myError
DtImageWarning myWarning
DtImageSize myImageSize
unsigned int myReturnMethod
DtImageFormat myImageFormat
DtImageDataType myImageDataType
std::string myFilename
int myDataLength
unsigned char * myData

Detailed Description

DtMmwResponse is the returned image data by the server.

Constructor & Destructor Documentation

makRadarFx::DtMmwResponse::DtMmwResponse ( )

CTOR/DTOR.

virtual makRadarFx::DtMmwResponse::~DtMmwResponse ( )
virtual

Member Function Documentation

virtual void makRadarFx::DtMmwResponse::setError ( DtImageError  error)
virtual

Error value if there is one.

virtual DtImageError makRadarFx::DtMmwResponse::error ( )
virtual
virtual void makRadarFx::DtMmwResponse::setWarning ( DtImageWarning  error)
virtual

Warning value if there is one.

virtual DtImageWarning makRadarFx::DtMmwResponse::warning ( )
virtual
virtual void makRadarFx::DtMmwResponse::setReturnMethod ( unsigned int  method)
virtual

Image return method that is used.

virtual unsigned int makRadarFx::DtMmwResponse::returnMethod ( )
virtual
virtual void makRadarFx::DtMmwResponse::setImageFormat ( DtImageFormat  format)
virtual

Image return format.

virtual DtImageFormat makRadarFx::DtMmwResponse::imageFormat ( )
virtual
virtual void makRadarFx::DtMmwResponse::setImageSize ( const DtImageSize size)
virtual

Size of the image returned by the server.

virtual DtImageSize makRadarFx::DtMmwResponse::imageSize ( )
virtual
virtual void makRadarFx::DtMmwResponse::setImageDataType ( DtImageDataType  type)
virtual

Image data type Only available for RAW/NITF image types.

virtual DtImageDataType makRadarFx::DtMmwResponse::imageDataType ( )
virtual
virtual void makRadarFx::DtMmwResponse::setFilename ( const std::string &  filename)
virtual

filename of saved image if it was saved on the server

virtual std::string makRadarFx::DtMmwResponse::filename ( )
virtual
virtual int makRadarFx::DtMmwResponse::dataLength ( )
virtual

Size of data for the returned image.

virtual void makRadarFx::DtMmwResponse::setData ( unsigned char *  buffer,
int  length 
)
virtual

Image data returned by the server. This message class will manage this memory.

virtual unsigned char* makRadarFx::DtMmwResponse::data ( )
virtual
virtual int makRadarFx::DtMmwResponse::messageSize ( )
virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

static DtBaseMessage* makRadarFx::DtMmwResponse::decode ( unsigned char *  buffer,
int  length 
)
static

decode a message. Used by the factory

virtual DtBaseMessage* makRadarFx::DtMmwResponse::clone ( )
virtual

clone a message. Caller of function is responsible managing this memory

Implements makRadarFx::DtBaseMessage.

virtual void makRadarFx::DtMmwResponse::serialize ( DtStreamWriter writer)
protectedvirtual

Reimplemented from makRadarFx::DtBaseMessage.

virtual void makRadarFx::DtMmwResponse::deserialize ( DtStreamReader reader)
protectedvirtual

Reimplemented from makRadarFx::DtBaseMessage.

Member Data Documentation

DtImageError makRadarFx::DtMmwResponse::myError
protected
DtImageWarning makRadarFx::DtMmwResponse::myWarning
protected
DtImageSize makRadarFx::DtMmwResponse::myImageSize
protected
unsigned int makRadarFx::DtMmwResponse::myReturnMethod
protected
DtImageFormat makRadarFx::DtMmwResponse::myImageFormat
protected
DtImageDataType makRadarFx::DtMmwResponse::myImageDataType
protected
std::string makRadarFx::DtMmwResponse::myFilename
protected
int makRadarFx::DtMmwResponse::myDataLength
protected
unsigned char* makRadarFx::DtMmwResponse::myData
protected

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

Document ID: 1.0
Copyright © 2015 VT MÄK Inc. All Rights Reserved (www.mak.com)