ifRadarStateUnsubscribe.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file ifRadarStateUnsubscribe.h
//! \ingroup vreVrfMessages
//! \brief Interface message class for canceling radar state subscriptions
//!
//! This file defines the DtIfRadarStateUnsubscribe class, which is used to
//! cancel an active subscription to radar state updates from a specific entity.
 
//! The DtIfRadarStateUnsubscribe class provides a mechanism for canceling
//! existing radar state subscriptions to stop receiving updates.
#pragma once
 
#include "vreVrfMessages/export.h"
 
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vrfutil/rwUUID.h>
 
//! \brief Interface message for canceling radar state subscriptions
//!
//! This class is used to indicate that any previous radar state subscription
//! from the originating simulation address should be canceled, and radar state
//! messages should no longer be sent. This is the counterpart to a subscription
//! request with the subscribe flag set to true.
class VRFMESSAGES_DLL DtIfRadarStateUnsubscribe : public DtSimInterfaceContent
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty radar state unsubscribe message.
   DtIfRadarStateUnsubscribe();
 
   //! \brief Copy constructor
   //! \param orig The radar state unsubscribe message to copy from
   //!
   //! Creates a new radar state unsubscribe message by copying an existing one.
   DtIfRadarStateUnsubscribe(const DtIfRadarStateUnsubscribe& orig);
 
   //! \brief Assignment operator
   //! \param orig The radar state unsubscribe message to copy from
   //! \return Reference to this object after assignment
   //!
   //! Copies the contents of another radar state unsubscribe message into this one.
   const DtIfRadarStateUnsubscribe& operator=(const DtIfRadarStateUnsubscribe& orig);
 
   //! \brief Virtual destructor
   virtual ~DtIfRadarStateUnsubscribe() override;
 
   //! \brief Gets the interface message type
   //! \return The message type identifier
   //!
   //! Returns DtRadarStateUnsubscribeMessageType 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 UUID of the entity to unsubscribe from
   //! \param name The entity UUID to set
   //!
   //! Sets the UUID of the entity whose radar state updates should no longer be received.
   //! This identifies the specific radar system subscription to cancel.
   virtual void setUUID(const DtUUID& name);
 
   //! \brief Gets the UUID of the entity being unsubscribed from
   //! \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 DtIfRadarStateUnsubscribe
   //!
   //! This static function is used for registration with DtInterfaceContentFactory.
   static DtSimInterfaceContent* creator();
 
protected:
   //! \brief UUID of the entity whose radar state is being unsubscribed from
   DtUUID myUUID;
};