makRadarFx::DtSensorListResponse Class Reference

Detailed Description

This class encapsulates the response to a sensor list request, providing a list of all radar sensor configurations available on the RadarFX server. Each sensor configuration has a unique name that can be used when requesting radar imagery to specify which sensor characteristics should be used.

#include <rfxSensorListMessage.h>

Inheritance diagram for makRadarFx::DtSensorListResponse:

Public Member Functions
	DtSensorListResponse ()
virtual	~DtSensorListResponse ()
virtual void	setSensorList (std::vector< std::string > sensors)
virtual std::vector< std::string >	sensorList ()
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
std::vector< std::string >	mySensors
Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int	myMessageType
std::string	myRequestorId
int	myRequestId

Constructor & Destructor Documentation

DtSensorListResponse()

makRadarFx::DtSensorListResponse::DtSensorListResponse

(

)

Default constructor.

Initializes a new sensor list response message with an empty sensor list

~DtSensorListResponse()

virtual makRadarFx::DtSensorListResponse::~DtSensorListResponse ( )

virtual

Virtual destructor.

Member Function Documentation

setSensorList()

virtual void makRadarFx::DtSensorListResponse::setSensorList ( std::vector< std::string > sensors )

virtual

Sets the list of available sensor configurations.

Parameters

sensors

Vector of sensor configuration names

Sets the list of all radar sensor configurations available on the server. Each name in the list corresponds to a unique sensor configuration that can be used when requesting radar imagery.

sensorList()

virtual std::vector< std::string > makRadarFx::DtSensorListResponse::sensorList ( )

virtual

Gets the list of available sensor configurations.

Returns

Vector of sensor configuration names

Returns the list of all radar sensor configurations available on the server. This list will be empty if there are no sensors available or if there was an error retrieving the list.

messageSize()

virtual int makRadarFx::DtSensorListResponse::messageSize ( )

virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

decode()

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

static

decode a message. Used by the factory

References makRadarFx::DtBaseMessage::DtBaseMessage().

clone()

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

virtual

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

Implements makRadarFx::DtBaseMessage.

References makRadarFx::DtBaseMessage::DtBaseMessage().

serialize()

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

protectedvirtual

Serializes the message data to a stream writer.

Parameters

writer

Reference to the stream writer to write the data to

Writes the message data to the provided stream writer. This includes the list of sensor names contained in this response.

Reimplemented from makRadarFx::DtBaseMessage.

deserialize()

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

protectedvirtual

Deserializes message data from a stream reader.

Parameters

reader

Reference to the stream reader to read the data from

Reads the message data from the provided stream reader, populating the list of sensor names contained in this response.

Reimplemented from makRadarFx::DtBaseMessage.

Member Data Documentation

mySensors

std::vector<std::string> makRadarFx::DtSensorListResponse::mySensors

protected

List of available sensor configuration names.

---

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

• include/vrvExtensions/vreRadarFxShared/rfxSensorListMessage.h