rfxSensorListMessage.h

Go to the documentation of this file.

// ******************************************************************************
// ** Copyright (c) 2025 MAK Technologies
// ** All rights reserved.
// ******************************************************************************
 
//! \file rfxSensorListMessage.h
//! \brief Defines the request and response messages for radar sensor configuration queries
//! \ingroup vreRadarFxShared
//!
//! This file contains message classes for requesting the list of configured radar
//! sensors available on the RadarFX server, and receiving the sensor list response.
//! Applications use these messages to discover what radar systems are available for
//! generating radar imagery.
 
 
#pragma once
 
#include "export.h"
#include "rfxMessage.h"
 
#include <vlutil/vlString.h>
#include <matrix/vlVector.h>
 
#include <vector>
#include <string>
 
 
namespace makRadarFx
{
//! \brief Request message for radar sensor configuration list
//!
//! This class encapsulates a request for the list of radar sensor configurations
//! that are available on the RadarFX server. Different sensor configurations have
//! different characteristics such as frequencies, resolutions, and capabilities.
//! Applications need to know what sensor systems are available before requesting
//! radar imagery.
class RFX_DLL_SHARED DtSensorListRequest : public DtBaseMessage
{
public:
   //! \brief Default constructor
   //!
   //! Initializes a new sensor list request message
   DtSensorListRequest();
 
   //! \brief Virtual destructor
   virtual ~DtSensorListRequest();
 
   //! \brief size of the message
   virtual int messageSize();
   //! \brief decode a message.  Used by the factory
   static DtBaseMessage* decode(unsigned char* buffer, int length);
   //! \brief clone a message.  Caller of function is responsible managing this memory
   virtual DtBaseMessage* clone();
 
protected:
   virtual void serialize(DtStreamWriter& writer);
   virtual void deserialize(DtStreamReader& reader);
};
 
 
//! \brief Response message containing the list of available radar sensor configurations
//!
//! 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.
class RFX_DLL_SHARED DtSensorListResponse : public DtBaseMessage
{
public:
   //! \brief Default constructor
   //!
   //! Initializes a new sensor list response message with an empty sensor list
   DtSensorListResponse();
 
   //! \brief Virtual destructor
   virtual ~DtSensorListResponse();
 
   //! \brief Sets the list of available sensor configurations
   //! \param 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.
   virtual void setSensorList(std::vector<std::string> sensors);
 
   //! \brief Gets the list of available sensor configurations
   //! \return 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.
   virtual std::vector<std::string> sensorList();
 
   //! \brief size of the message
   virtual int messageSize();
   //! \brief decode a message.  Used by the factory
   static DtBaseMessage* decode(unsigned char* buffer, int length);
   //! \brief clone a message.  Caller of function is responsible managing this memory
   virtual DtBaseMessage* clone();
 
protected:
   //! \brief Serializes the message data to a stream writer
   //! \param 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.
   virtual void serialize(DtStreamWriter& writer);
 
   //! \brief Deserializes message data from a stream reader
   //! \param 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.
   virtual void deserialize(DtStreamReader& reader);
 
   //! \brief List of available sensor configuration names
   std::vector<std::string> mySensors;
};
} // namespace makRadarFx