ifRwrData.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file ifRwrData.h
//! \ingroup vreVrfMessages
//! \brief Interface message class for RWR (Radar Warning Receiver) data
//!
//! This file defines the DtIfRwrData class, which encapsulates the current
//! internal state of a radar warning receiver (RWR). It includes information
//! about the entity owning the RWR, the RWR name, and a list of detected
//! radar emitter contacts.
 
//! The DtIfRwrData class provides a complete snapshot of an RWR's current state.
//! It is used to communicate RWR information between simulation components.
#pragma once
#include "vreVrfMessages/export.h"
#include "vreVrfMessages/rwRwrContactInfo.h"
 
#include <vlutil/vlString.h>
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vrfutil/rwUUID.h>
 
//! \brief Interface message for RWR data
//!
//! This class encapsulates the current internal state of a single radar warning
//! receiver (RWR). It contains information about the entity that owns the RWR,
//! the RWR's name, and a list of currently detected radar emitter contacts.
 
class VRFMESSAGES_DLL DtIfRwrData : public DtSimInterfaceContent
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty RWR data message.
   DtIfRwrData();
 
   //! \brief Copy constructor
   //! \param orig The RWR data to copy from
   //!
   //! Creates a new RWR data object by copying an existing one.
   DtIfRwrData(const DtIfRwrData& orig);
 
   //! \brief Assignment operator
   //! \param orig The RWR data to copy from
   //! \return Reference to this object after assignment
   //!
   //! Copies the contents of another RWR data object into this one.
   const DtIfRwrData& operator=(const DtIfRwrData& orig);
 
   //! \brief Virtual destructor
   virtual ~DtIfRwrData() override;
 
   //! \brief Gets the interface message type
   //! \return The message type identifier
   //!
   //! Returns DtRwrDataMessageType 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 RWR
   //! \return The RWR name
   virtual DtString rwrName() const;
 
   //! \brief Sets the name of the RWR
   //! \param name The RWR name to set
   virtual void setRwrName(const DtString& name);
 
   //! \brief Sets the source entity UUID
   //! \param entity The UUID of the source entity
   //!
   //! Sets the UUID of the entity that owns the RWR system.
   virtual void setSourceEntity(const DtUUID& entity);
 
   //! \brief Gets the source entity UUID
   //! \return The UUID of the source entity
   //!
   //! Returns the UUID of the entity that owns the RWR system.
   virtual const DtUUID& sourceEntity() const;
 
   //! \brief Gets the list of RWR contacts (const version)
   //! \return Const reference to the list of RWR contacts
   //!
   //! Returns a constant reference to the list of radar contacts detected by the RWR.
   virtual const DtRwRwrContactInfoList& rwrContactList() const;
 
   //! \brief Gets the list of RWR contacts (non-const version)
   //! \return Reference to the list of RWR contacts
   //!
   //! Returns a modifiable reference to the list of radar contacts detected by the RWR.
   virtual DtRwRwrContactInfoList& rwrContactList();
 
   //! \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 DtIfRwrData
   //!
   //! This static function is used for registration with DtInterfaceContentFactory.
   static DtSimInterfaceContent* creator();
 
protected:
   //! \brief UUID of the entity that owns the RWR
   DtUUID mySourceEntity;
 
   //! \brief Name of the RWR system
   DtString myRwrName;
 
   //! \brief List of radar contacts detected by the RWR
   DtRwRwrContactInfoList myRwrContactInfoList;
};