icVreTdlEngagementStatus.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file icVreTdlEngagementStatus.h
//! \ingroup vreVrfMessages
//! \brief Interface class for Tactical Data Link (TDL) engagement status information
//!
//! This file defines the IcVreTdlEngagementStatus class, which encapsulates engagement
//! status information between entities within the TDL network. It provides information
//! about which entity is engaging which target and the status of the engagement.
 
#pragma once
 
// VR-Engage includes
#include <vreVrfMessages/export.h>
 
// VR-Forces includes
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vrfutil/rwUUID.h>
 
// VR-Link includes
#include <vlutil/vlString.h>
 
// #include "TDLMessageTypes.h"
 
namespace ctiTdl
{
//! \brief Message type identifier for TDL engagement status messages
const int IcVreTdlEngagementStatusType = 603;
 
//! \brief Interface message class for TDL engagement status information
//!
//! This class encapsulates engagement status information between entities
//! within the TDL network. It defines which entity is engaging which target
//! and the current state of that engagement (e.g., engaged, weapon released).
class VRFMESSAGES_DLL IcVreTdlEngagementStatus : public DtSimInterfaceContent
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty engagement status message.
   IcVreTdlEngagementStatus();
 
   //! \brief Virtual destructor
   //!
   //! Cleans up all resources associated with the engagement status.
   virtual ~IcVreTdlEngagementStatus() override;
 
   //! \brief Copy constructor
   //! \param orig The engagement status to copy from
   //!
   //! Creates a new engagement status by copying an existing one.
   IcVreTdlEngagementStatus(const IcVreTdlEngagementStatus& orig);
 
   //! \brief Assignment operator
   //! \param orig The engagement status to copy from
   //! \return Reference to this object after assignment
   //!
   //! Copies the contents of another engagement status into this one.
   IcVreTdlEngagementStatus& operator=(const IcVreTdlEngagementStatus& orig);
 
   //! \brief Gets the interface message type
   //! \return The message type identifier
   //!
   //! Returns IcVreTdlEngagementStatusType.
   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 Static creator function for factory registration
   //! \return Pointer to a new instance of IcVreTdlEngagementStatus
   //!
   //! This static function is used for registration with DtInterfaceContentFactory.
   static DtSimInterfaceContent* creator();
 
   //! \brief Gets the network representation size
   //! \return Size in bytes of the network representation
   //!
   //! Returns the size of the full network representation padded to an 8-byte boundary.
   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 engagement status 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 engagement status 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 engagement status to the provided string.
   virtual void printDataToString(DtString& str) override;
 
   //! \brief Sets the UUID for this engagement status
   //! \param uuid The UUID to set
   virtual void setUUID(DtUUID uuid);
 
   //! \brief Gets the UUID of this engagement status
   //! \return The engagement status UUID
   virtual DtUUID getUUID();
 
   //! \brief Sets the source track number
   //! \param stn The source track number to set
   //!
   //! Sets the track number (STN) of the engaging platform.
   virtual void setSourceTrackNumber(const DtString& stn);
 
   //! \brief Gets the source track number
   //! \return The source track number of the engaging platform
   virtual DtString getSourceTrackNumber();
 
   //! \brief Sets the objective track number
   //! \param tn The objective track number to set
   //!
   //! Sets the track number (TN) of the objective/target platform.
   virtual void setObjectiveTrackNumber(const DtString& tn);
 
   //! \brief Gets the objective track number
   //! \return The track number of the objective/target platform
   virtual DtString getObjectiveTrackNumber();
 
   //! \brief Sets the engagement status
   //! \param status The engagement status code to set
   //!
   //! Sets the engagement status code as defined in ctiTdl::StatusType.
   virtual void setEngagementStatus(const int status);
 
   //! \brief Gets the engagement status
   //! \return The engagement status code
   //!
   //! Returns the engagement status code as defined in ctiTdl::StatusType.
   virtual int getEngagementStatus();
 
protected:
   //! \brief UUID of this engagement status for unique identification
   DtUUID myUUID;
 
   //! \brief Source track number (STN) of the engaging platform
   DtString mySourceTrackNumber;
 
   //! \brief Track number (TN) of the objective/target platform
   DtString myObjectiveTrackNumber;
 
   //! \brief Current engagement status code
   //! See ctiTdl::StatusType in VreTdlTrackTypes.h for possible values
   int myEngagementStatus;
};
} // namespace ctiTdl