ifRadarContactData.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file ifRadarContactData.h
//! \ingroup vreVrfMessages
//! \brief Interface message class for radar contact data
//!
//! This file defines the DtIfRadarContactData class, which encapsulates information
//! about radar contacts detected by a radar system. It includes data about the
//! entity owning the radar, the radar name, and a list of detected contacts.
 
//! The DtIfRadarContactData class provides a complete representation of
//! all contacts detected by a radar system at a specific point in time.
#pragma once
 
#include "vreVrfMessages/export.h"
#include "vreVrfMessages/rwRadarContactInfo.h"
 
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vrfmsgs/sensorDataEntry.h>
#include <vrfutil/rwUUID.h>
 
//! \brief Interface message for radar contact data
//!
//! This class encapsulates the current internal state of a radar system's
//! contact detection capability. It contains information about the entity that
//! owns the radar, the radar's name, and a list of currently detected contacts
//! with their respective properties.
class VRFMESSAGES_DLL DtIfRadarContactData : public DtSimInterfaceContent
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty radar contact data message.
   DtIfRadarContactData();
 
   //! \brief Copy constructor
   //! \param orig The radar contact data to copy from
   //!
   //! Creates a new radar contact data object by copying an existing one.
   DtIfRadarContactData(const DtIfRadarContactData& orig);
 
   //! \brief Assignment operator
   //! \param orig The radar contact data to copy from
   //! \return Reference to this object after assignment
   //!
   //! Copies the contents of another radar contact data object into this one.
   const DtIfRadarContactData& operator=(const DtIfRadarContactData& orig);
 
   //! \brief Virtual destructor
   virtual ~DtIfRadarContactData() override;
 
   //! \brief Gets the interface message type
   //! \return The message type identifier
   //!
   //! Returns DtRadarContactDataMessageType 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 source entity UUID
   //! \param entity The UUID of the source entity
   //!
   //! Sets the UUID of the entity that owns the radar 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 radar system.
   virtual const DtUUID& sourceEntity() const;
 
   //! \brief Sets the radar sensor name
   //! \param sensorName The name of the radar sensor
   //!
   //! Sets the name of the radar sensor that detected these contacts.
   virtual void setSensorName(const DtString& sensorName);
 
   //! \brief Gets the radar sensor name
   //! \return The name of the radar sensor
   virtual DtString sensorName() const;
 
   //! \brief Gets the list of radar contacts (const version)
   //! \return Const reference to the list of radar contacts
   //!
   //! Returns a constant reference to the list of contacts detected by the radar.
   virtual const DtRadarDataEntryList& radarDataEntryList() const;
 
   //! \brief Gets the list of radar contacts (non-const version)
   //! \return Reference to the list of radar contacts
   //!
   //! Returns a modifiable reference to the list of contacts detected by the radar.
   virtual DtRadarDataEntryList& radarDataEntryList();
 
   //! \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 DtIfRadarContactData
   //!
   //! This static function is used for registration with DtInterfaceContentFactory.
   static DtSimInterfaceContent* creator();
 
protected:
   //! \brief UUID of the entity that owns the radar system
   DtUUID mySourceEntity;
 
   //! \brief Name of the radar sensor
   DtString mySensorName;
 
   //! \brief List of radar contacts detected by the radar
   DtRadarDataEntryList myRadarContactDataList;
};