rfxEntityLocationMessage.h

Go to the documentation of this file.

// ******************************************************************************
// ** Copyright (c) 2025 MAK Technologies
// ** All rights reserved.
// ******************************************************************************
 
//! \file rfxEntityLocationMessage.h
//! \brief Defines the request and response messages for entity location queries
//! \ingroup vreRadarFxShared
//!
//! This file contains message classes for requesting the position, orientation,
//! and velocity of specific entities in the simulation
 
#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 entity location information
//!
//! This message requests the current location, orientation, and velocity
//! for a specific entity identified by its entity ID. The server will
//! respond with the requested information or an error if the entity
//! cannot be found.
class RFX_DLL_SHARED DtEntityLocationRequest : public DtBaseMessage
{
public:
   //! \brief Default constructor
   //!
   //! Initializes a new entity location request message with an empty entity ID
   DtEntityLocationRequest();
 
   //! \brief Virtual destructor
   virtual ~DtEntityLocationRequest();
 
   //! \brief Sets the entity ID to query
   //! \param name String identifier of the entity to look up
   //!
   //! Sets the identifier of the entity that this request is querying
   //! the location, orientation, and velocity of.
   virtual void setEntityId(const std::string& name);
 
   //! \brief Gets the entity ID being queried
   //! \return String identifier of the entity
   //!
   //! Returns the identifier of the entity that this request is querying.
   virtual std::string entityId();
 
   //! \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 Entity identifier to query
   std::string myEntityId;
};
 
 
//! \brief Response message containing entity location information
//!
//! This message contains the response to an entity location request, providing
//! the current position, orientation, and velocity of the requested entity.
//! If the entity cannot be found, an error code will be set.
class RFX_DLL_SHARED DtEntityLocationResponse : public DtBaseMessage
{
public:
   //! \brief Error codes for entity location responses
   enum DtEntityLocationError
   {
      ENTITY_LOC_NO_ERROR,   //!< No error, location information is valid
      ENTITY_LOC_NO_ENTITY,  //!< Entity not found in the simulation
      ENTITY_LOC_ERROR_OTHER //!< Other unspecified error
   };
 
   //! \brief Default constructor
   //!
   //! Initializes a new entity location response message with default values
   DtEntityLocationResponse();
 
   //! \brief Virtual destructor
   virtual ~DtEntityLocationResponse();
 
   //! \brief Sets the entity's position
   //! \param location Vector containing the entity's position (latitude, longitude, altitude)
   //!
   //! Sets the location of the entity at the time the request was fulfilled.
   //! Position is in geodetic coordinates (latitude, longitude, altitude).
   virtual void setEntityLocation(DtVector location);
 
   //! \brief Gets the entity's position
   //! \return Vector containing the entity's position (latitude, longitude, altitude)
   //!
   //! Returns the location of the entity at the time the request was fulfilled.
   virtual DtVector entityLocation();
 
   //! \brief Sets the entity's orientation
   //! \param topoOrientation Tait-Bryan angles representing the entity's orientation
   //!
   //! Sets the topographic orientation of the entity at the time the request was fulfilled.
   //! Orientation is expressed as Tait-Bryan angles (heading, pitch, roll).
   virtual void setEntityTopoOrientation(DtTaitBryan topoOrientation);
 
   //! \brief Gets the entity's orientation
   //! \return Tait-Bryan angles representing the entity's orientation
   //!
   //! Returns the topographic orientation of the entity at the time the request was fulfilled.
   virtual DtTaitBryan entityOrientation();
 
   //! \brief Sets the entity's velocity
   //! \param velocity Vector containing the entity's velocity components in m/s
   //!
   //! Sets the velocity vector of the entity at the time the request was fulfilled.
   //! Velocity is in meters per second along each axis.
   virtual void setEntityVelocity(DtVector32 velocity);
 
   //! \brief Gets the entity's velocity
   //! \return Vector containing the entity's velocity components in m/s
   //!
   //! Returns the velocity vector of the entity at the time the request was fulfilled.
   virtual DtVector32 entityVelocity();
 
   //! \brief Sets the error code
   //! \param error The error code to set
   //!
   //! Sets the error status for this entity location response. Use
   //! ENTITY_LOC_NO_ERROR if the location information is valid.
   virtual void setError(DtEntityLocationError error);
 
   //! \brief Gets the error code
   //! \return The current error code
   //!
   //! Returns the error status for this entity location response.
   virtual DtEntityLocationError error();
 
   //! \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 Entity's position in geodetic coordinates
   DtVector myEntityLocation;
 
   //! \brief Entity's orientation as Tait-Bryan angles
   DtTaitBryan myEntityTopoOrientation;
 
   //! \brief Entity's velocity vector in m/s
   DtVector32 myEntityVelocity;
 
   //! \brief Error code for this response
   DtEntityLocationError myError;
};
} // namespace makRadarFx