rfxEntityListMessage.h

Go to the documentation of this file.

// ******************************************************************************
// ** Copyright (c) 2025 MAK Technologies
// ** All rights reserved.
// ******************************************************************************
 
//! \file rfxEntityListMessage.h
//! \brief Defines the request and response messages for entity list queries
//! \ingroup vreRadarFxShared
//!
//! This file contains message classes for requesting the list of entities
//! in the simulation and receiving the entity data
 
#pragma once
 
#include "export.h"
#include "rfxMessage.h"
 
#include <vlutil/vlString.h>
#include <matrix/vlVector.h>
 
#include <vector>
#include <string>
 
 
namespace makRadarFx
{
//! \brief Entity description data structure
//!
//! Contains information about an entity in the simulation,
//! including its identifier, marking text, and entity type
struct RFX_DLL_SHARED DtEntityDescription
{
   //! \brief Entity's unique simulation identifier
   std::string myId;
 
   //! \brief Entity's marking text (e.g., callsign or designation)
   std::string myMarkingText;
 
   //! \brief Entity's type classification
   std::string myEntityType;
};
 
//! \brief Request message for entity list information
//!
//! This message requests the list of all entities currently present
//! in the simulation. The response provides descriptive information
//! about each entity.
class RFX_DLL_SHARED DtEntityListRequest : public DtBaseMessage
{
public:
   //! \brief Default constructor
   //!
   //! Initializes a new entity list request message
   DtEntityListRequest();
 
   //! \brief Virtual destructor
   virtual ~DtEntityListRequest();
 
   //! \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 entities in the simulation
//!
//! This message contains the response to an entity list request, providing
//! descriptive information about all entities currently present in the simulation.
//! If there are no entities, the list will be empty.
class RFX_DLL_SHARED DtEntityListResponse : public DtBaseMessage
{
public:
   //! \brief Default constructor
   //!
   //! Initializes a new entity list response message with an empty entity list
   DtEntityListResponse();
 
   //! \brief Virtual destructor
   virtual ~DtEntityListResponse();
 
   //! \brief Sets the list of entities
   //! \param entities Vector of entity descriptions to set
   //!
   //! Sets the list of all entities currently in the simulation.
   //! This list will be empty if there are no entities within the simulation.
   virtual void setEntityList(std::vector<DtEntityDescription> entities);
 
   //! \brief Gets the list of entities
   //! \return Vector of entity descriptions
   //!
   //! Returns the list of all entities currently in the simulation.
   //! This list will be empty if there are no entities within the simulation.
   virtual std::vector<DtEntityDescription> entityList();
 
   //! \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
   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
   virtual void deserialize(DtStreamReader& reader);
 
   //! \brief List of entity descriptions in the simulation
   std::vector<DtEntityDescription> myEntities;
};
} // namespace makRadarFx