makRadarFx::DtElevationResponse Class Reference

Detailed Description

This message contains the response to an elevation request, providing the terrain elevation at the requested location and any error information if the elevation could not be determined. The response may include an error if there is no line of sight from the sensor position to the target location.

#include <rfxElevationMessage.h>

Inheritance diagram for makRadarFx::DtElevationResponse:

Public Types
enum	DtElevationError { ELEVATION_NO_ERROR , ELEVATION_ERROR_OCCLUDED , ELEVATION_ERROR_OTHER }

Public Member Functions
	DtElevationResponse ()
virtual	~DtElevationResponse ()
virtual void	setElevation (float elevation)
virtual float	elevation ()
virtual void	setError (DtElevationError error)
virtual DtElevationError	error ()
virtual int	messageSize ()
virtual DtBaseMessage *	clone ()
Public Member Functions inherited from makRadarFx::DtBaseMessage
	DtBaseMessage ()
virtual	~DtBaseMessage ()
virtual unsigned int	messageType () const
virtual unsigned char *	encode ()
virtual void	setRequestorId (const std::string &requestor)
virtual std::string	requestorId ()
virtual void	setRequestId (int id)
virtual int	requestId ()

Static Public Member Functions
static DtBaseMessage *	decode (unsigned char *buffer, int length)

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

Member Enumeration Documentation

DtElevationError

enum makRadarFx::DtElevationResponse::DtElevationError

Error codes for elevation responses.

Enumerator
ELEVATION_NO_ERROR	No error, elevation is valid.
ELEVATION_ERROR_OCCLUDED	Error due to occlusion (no line of sight)
ELEVATION_ERROR_OTHER	Other unspecified error.

Constructor & Destructor Documentation

DtElevationResponse()

makRadarFx::DtElevationResponse::DtElevationResponse

(

)

Default constructor.

Initializes a new elevation response message with default settings

~DtElevationResponse()

virtual makRadarFx::DtElevationResponse::~DtElevationResponse ( )

virtual

Virtual destructor.

Member Function Documentation

setElevation()

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

virtual

Sets the elevation result.

Parameters

elevation

The elevation value in meters

Sets the elevation at the requested location. A value of NaN indicates that the request could not be completed due to line of sight being blocked from the sensing platform to the requested target or another error.

References elevation().

elevation()

virtual float makRadarFx::DtElevationResponse::elevation ( )

virtual

Gets the elevation result.

Returns

The elevation value in meters, or NaN if unavailable

Returns the terrain elevation at the requested location.

Referenced by setElevation().

setError()

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

virtual

Sets the error code.

Parameters

error

The error code to set

Sets the error status for this elevation response. Use ELEVATION_NO_ERROR if the elevation value is valid.

References error().

error()

virtual DtElevationError makRadarFx::DtElevationResponse::error ( )

virtual

Gets the error code.

Returns

The current error code

Returns the error status for this elevation response.

Referenced by setError().

messageSize()

virtual int makRadarFx::DtElevationResponse::messageSize ( )

virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

decode()

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

static

decode a message. Used by the factory

References makRadarFx::DtBaseMessage::DtBaseMessage().

clone()

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

virtual

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

Implements makRadarFx::DtBaseMessage.

References makRadarFx::DtBaseMessage::DtBaseMessage().

serialize()

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

protectedvirtual

Serializes the message data to a stream writer.

Parameters

writer

Reference to the stream writer to write the data to

Reimplemented from makRadarFx::DtBaseMessage.

deserialize()

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

protectedvirtual

Deserializes message data from a stream reader.

Parameters

reader

Reference to the stream reader to read the data from

Reimplemented from makRadarFx::DtBaseMessage.

Member Data Documentation

myElevation

float makRadarFx::DtElevationResponse::myElevation

protected

The elevation value in meters.

myError

DtElevationError makRadarFx::DtElevationResponse::myError

protected

The error code for this response.

---

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

• include/vrvExtensions/vreRadarFxShared/rfxElevationMessage.h