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

The DtElevationResponse encapsulates a response from the RadarFX Server for a given elevation request. More...

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

Public Types

enum  DtElevationError { ELEVATION_NO_ERROR, ELEVATION_ERROR_OCCLUDED, ELEVATION_ERROR_OTHER }

Public Member Functions

 DtElevationResponse ()
 CTOR/DTOR.
virtual ~DtElevationResponse ()
virtual void setElevation (float elevation)
 The elevation at a given point.
virtual float elevation ()
virtual void setError (DtElevationError error)
 Error value if there is one.
virtual DtElevationError error ()
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::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

float myElevation
DtElevationError myError
- Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int myMessageType
std::string myRequestorId
int myRequestId

Detailed Description

The DtElevationResponse encapsulates a response from the RadarFX Server for a given elevation request.

Member Enumeration Documentation

Enumerator:
ELEVATION_NO_ERROR 
ELEVATION_ERROR_OCCLUDED 
ELEVATION_ERROR_OTHER 

Constructor & Destructor Documentation

makRadarFx::DtElevationResponse::DtElevationResponse ( )

CTOR/DTOR.

virtual makRadarFx::DtElevationResponse::~DtElevationResponse ( )
virtual

Member Function Documentation

virtual void makRadarFx::DtElevationResponse::setElevation ( float  elevation)
virtual

The elevation at a given point.

A value of NaN represents that the request could not be completed due to line of sight being blocked from the sensing platform to the requested target

virtual float makRadarFx::DtElevationResponse::elevation ( )
virtual
virtual void makRadarFx::DtElevationResponse::setError ( DtElevationError  error)
virtual

Error value if there is one.

virtual DtElevationError makRadarFx::DtElevationResponse::error ( )
virtual
virtual int makRadarFx::DtElevationResponse::messageSize ( )
virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

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

decode a message. Used by the factory

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

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

Implements makRadarFx::DtBaseMessage.

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

Reimplemented from makRadarFx::DtBaseMessage.

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

Reimplemented from makRadarFx::DtBaseMessage.

Member Data Documentation

float makRadarFx::DtElevationResponse::myElevation
protected
DtElevationError makRadarFx::DtElevationResponse::myError
protected

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

Document ID: 1.0
Copyright © 2017 VT MAK Inc. All Rights Reserved (www.mak.com)