ifRadarStateRequest.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file ifRadarStateRequest.h
//! \ingroup vreVrfMessages
//! \brief Interface message class for requesting radar state data
//!
//! This file defines the DtIfRadarStateRequest class, which is used to request
//! radar state information from a DtVreRadarObjectSensor. It allows for both
//! one-time requests and subscription-based continuous updates.
 
//! The DtIfRadarStateRequest class provides a mechanism for requesting radar
//! state data from a radar object sensor in the simulation system.
 
#pragma once
 
#include "vreVrfMessages/export.h"
 
#include <vlutil/vlString.h>
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vrfutil/rwUUID.h>
 
 
//! \brief Interface message for requesting radar state data
//!
//! This class is used to request radar state data messages to be sent from a
//! DtVreRadarObjectSensor. Two types of requests are supported:
//!
//! - If subscribe is true, the request indicates that a new radar state data
//!   message should be sent every time the radar state changes, until a
//!   DtRadarStateUnsubscribe message is sent to cancel the subscription.
//!
//! - If subscribe is false, the request is for just one message containing the
//!   current radar state to be sent.
class VRFMESSAGES_DLL DtIfRadarStateRequest : public DtSimInterfaceContent
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty radar state request message.
   DtIfRadarStateRequest();
 
   //! \brief Copy constructor
   //! \param orig The radar state request to copy from
   //!
   //! Creates a new radar state request message by copying an existing one.
   DtIfRadarStateRequest(const DtIfRadarStateRequest& orig);
 
   //! \brief Assignment operator
   //! \param orig The radar state request to copy from
   //! \return Reference to this object after assignment
   //!
   //! Copies the contents of another radar state request message into this one.
   const DtIfRadarStateRequest& operator=(const DtIfRadarStateRequest& orig);
 
   //! \brief Virtual destructor
   virtual ~DtIfRadarStateRequest() override;
 
   //! \brief Gets the interface message type
   //! \return The message type identifier
   //!
   //! Returns DtRadarStateRequestMessageType as defined in vreVrfMessageTypes.h.
   virtual int type() const override;
 
   //! \brief Creates a copy of this message
   //! \return Pointer to the new copy
   //!
   //! Creates a dynamically allocated copy of this message.
   virtual DtSimInterfaceContent* clone() const override;
 
   //! \brief Sets the subscription flag
   //! \param value True for continuous updates, false for a one-time request
   //!
   //! When set to true, radar state data will be sent every time the data changes.
   //! When set to false, only a single radar state update will be sent.
   virtual void setSubscribe(bool value);
 
   //! \brief Gets the subscription flag
   //! \return True if requesting continuous updates, false for a one-time request
   virtual bool subscribe() const;
 
   //! \brief Sets the UUID of the entity whose radar state is being requested
   //! \param uuid The entity UUID to set
   //!
   //! Sets the UUID of the entity whose radar state data is being requested.
   //! This identifies the specific radar system in the simulation.
   virtual void setUUID(const DtUUID& uuid);
 
   //! \brief Gets the UUID of the entity whose radar state is being requested
   //! \return The entity UUID
   virtual const DtUUID& uuid() const;
 
   //! \brief Gets the network representation size
   //! \return Size in bytes of the network representation
   //!
   //! Returns the size of the network buffer needed to store this message.
   virtual int netRepSize() const override;
 
   //! \brief Deserializes the message from a network buffer
   //! \param contentBuffer Pointer to the network buffer
   //! \param contentSize Size of the buffer in bytes
   //! \return True if deserialization was successful
   //!
   //! Fills the message from the provided network buffer.
   virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;
 
   //! \brief Serializes the message for network transmission
   //! \return True if serialization was successful
   //!
   //! Prepares the message for network transmission.
   virtual bool setToNet() override;
 
   //! \brief Formats the message data as a string
   //! \param str String to store the formatted message data
   //!
   //! Appends a human-readable representation of the message to the provided string.
   virtual void printDataToString(DtString& str) override;
 
   //! \brief Static creator function for factory registration
   //! \return Pointer to a new instance of DtIfRadarStateRequest
   //!
   //! This static function is used for registration with DtInterfaceContentFactory.
   static DtSimInterfaceContent* creator();
 
protected:
   //! \brief UUID of the entity whose radar state is being requested
   DtUUID myUUID;
 
   //! \brief Flag indicating whether continuous updates are requested
   //! When true, data will be sent each time it changes. When false, only a single update is sent.
   bool mySubscribe;
};