icVreTdlTrackList.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file icVreTdlTrackList.h
//! \ingroup vreVrfMessages
//! \brief Interface class for Tactical Data Link (TDL) track list information
//!
//! This file defines the IcVreTdlTrackList class, which encapsulates a collection of
//! TDL tracks for transmission between simulation components. It provides mechanisms
//! for managing track lists and network serialization/deserialization.
 
#pragma once
 
#include "icVreTdlTrack.h"
 
// 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"
 
#include <list>
 
namespace ctiTdl
{
//! \brief Message type identifier for TDL track list messages
const int IcVreTdlTrackListType = 602;
 
//! \brief Interface message class for a collection of TDL tracks
//!
//! This class encapsulates a collection of TDL tracks for transmission between
//! simulation components. It manages a list of track contents structures and
//! provides methods for serialization and deserialization over the network.
class VRFMESSAGES_DLL IcVreTdlTrackList : public DtSimInterfaceContent
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty TDL track list message.
   IcVreTdlTrackList();
 
   //! \brief Virtual destructor
   //!
   //! Cleans up all resources associated with the track list.
   virtual ~IcVreTdlTrackList() override;
 
   //! \brief Copy constructor
   //! \param orig The TDL track list to copy from
   //!
   //! Creates a new TDL track list by copying an existing one,
   //! including all contained tracks.
   IcVreTdlTrackList(const IcVreTdlTrackList& orig);
 
   //! \brief Assignment operator
   //! \param orig The TDL track list to copy from
   //! \return Reference to this object after assignment
   //!
   //! Copies the contents of another TDL track list into this one,
   //! including all contained tracks.
   IcVreTdlTrackList& operator=(const IcVreTdlTrackList& orig);
 
   //! \brief Gets the interface message type
   //! \return The message type identifier
   //!
   //! Returns IcVreTdlTrackListType.
   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 using the copy constructor.
   virtual DtSimInterfaceContent* clone() const override;
 
   //! \brief Static creator function for factory registration
   //! \return Pointer to a new instance of IcVreTdlTrackList
   //!
   //! 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 track list 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 track list 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 track list to the provided string.
   virtual void printDataToString(DtString& str) override;
 
   //! \brief Sets the UUID for this track list
   //! \param uuid The UUID to set
   virtual void setUUID(DtUUID uuid);
 
   //! \brief Gets the UUID of this track list
   //! \return The track list's UUID
   virtual DtUUID getUUID();
 
   //! \brief Sets the source track number
   //! \param stn The source track number to set
   //!
   //! Sets the track number of the originating Joint Unit (JU).
   virtual void setSourceTrackNumber(const DtString& stn);
 
   //! \brief Gets the source track number
   //! \return The source track number of the originating Joint Unit
   virtual DtString getSourceTrackNumber();
 
   //! \brief Sets the clear all tracks flag
   //! \param clear True to clear all tracks, false otherwise
   //!
   //! When set to true, this flag indicates that all tracks and engagement
   //! status should be deleted/cleared by the receiver.
   virtual void setClearAllTracks(const bool clear);
 
   //! \brief Gets the clear all tracks flag
   //! \return True if all tracks should be cleared, false otherwise
   virtual bool getClearAllTracks();
 
   //! \brief Adds a track to the track list
   //! \param track The track contents to add
   //!
   //! Adds a track to the list of tracks in this message.
   virtual void addTrack(const IcVreTdlTrackContents& track);
 
   //! \brief Gets the list of tracks
   //! \return Reference to the list of track contents
   //!
   //! Returns a reference to the internal list of tracks.
   virtual std::list<IcVreTdlTrackContents>& getTrackList();
 
protected:
   //! \brief UUID of this track list for unique identification
   DtUUID myUUID;
 
   //! \brief Source track number (STN) of originating Joint Unit (JU)
   DtString mySourceTrackNumber;
 
   //! \brief Flag indicating if all tracks should be cleared
   //! When true, all tracks and engagement status should be deleted/cleared
   bool myClearAllTracks;
 
   //! \brief Count of tracks in the list
   //! Maximum of 40 tracks, sorted by distance from ownship
   int myTrackCount;
 
   //! \brief List of track contents structures
   std::list<IcVreTdlTrackContents> myTrackList;
};
} // namespace ctiTdl