ifRadarStateData.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file ifRadarStateData.h
//! \ingroup vreVrfMessages
//! \brief Interface message class for radar state data
//!
//! This file defines the DtIfRadarStateData class, which encapsulates
//! the current internal state of a radar system. It is used to send
//! radar state information between simulation components.
//! \ingroup mfsUtil
 
//! This class encapsulates the current internal state of a radar system.
#pragma once
 
#include "vreVrfMessages/export.h"
#include "vreVrfMessages/rwRadarStateInfo.h"
 
#include <vlutil/vlString.h>
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vrfutil/rwUUID.h>
 
//! \brief Interface message for radar state data
//!
//! This class encapsulates the current internal state of a radar system,
//! including source entity ID, radar name, and detailed state information.
class VRFMESSAGES_DLL DtIfRadarStateData : public DtSimInterfaceContent
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty radar state data message.
   DtIfRadarStateData();
 
   //! \brief Copy constructor
   //! \param orig The radar state data to copy from
   //!
   //! Creates a new radar state data object by copying an existing one.
   DtIfRadarStateData(const DtIfRadarStateData& orig);
 
   //! \brief Assignment operator
   //! \param orig The radar state data to copy from
   //! \return Reference to this object after assignment
   //!
   //! Copies the contents of another radar state data object into this one.
   const DtIfRadarStateData& operator=(const DtIfRadarStateData& orig);
 
   //! \brief Virtual destructor
   virtual ~DtIfRadarStateData() override;
 
   //! \brief Gets the interface message type
   //! \return The message type identifier
   //!
   //! Returns DtRadarStateDataMessageType 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 Gets the name of the radar
   //! \return The radar name
   virtual DtString radarName() const;
 
   //! \brief Sets the name of the radar
   //! \param val The radar name to set
   virtual void setRadarName(const DtString& val);
 
   //! \brief Sets the source entity UUID
   //! \param val The UUID of the source entity
   //!
   //! Sets the UUID of the entity that owns the radar system.
   virtual void setSourceEntity(const DtUUID& val);
 
   //! \brief Gets the source entity UUID
   //! \return The UUID of the source entity
   //!
   //! Returns the UUID of the entity that owns the radar system.
   virtual const DtUUID& sourceEntity() const;
 
   //! \brief Gets the radar state information
   //! \return The radar state information structure
   virtual DtRwRadarStateInfo radarStateInfo() const;
 
   //! \brief Sets the radar state information
   //! \param val The radar state information to set
   virtual void setRadarStateInfo(const DtRwRadarStateInfo& val);
 
   //! \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 DtIfRadarStateData
   //!
   //! This static function is used for registration with DtInterfaceContentFactory.
   static DtSimInterfaceContent* creator();
 
protected:
   //! \brief UUID of the entity that owns the radar
   DtUUID mySourceEntity;
 
   //! \brief Name of the radar system
   DtString myRadarName;
 
   //! \brief Detailed radar state information
   DtRwRadarStateInfo myRadarStateInfo;
};