VR-Engage  2.2
Loading...
Searching...
No Matches
ctiTdl::IcVreTdlTrackList Class Reference

Detailed Description

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.

#include <icVreTdlTrackList.h>

Inheritance diagram for ctiTdl::IcVreTdlTrackList:
[legend]

Public Member Functions

 IcVreTdlTrackList ()
 
virtual ~IcVreTdlTrackList () override
 
 IcVreTdlTrackList (const IcVreTdlTrackList &orig)
 
IcVreTdlTrackListoperator= (const IcVreTdlTrackList &orig)
 
virtual int type () const override
 
virtual DtSimInterfaceContent * clone () const override
 
virtual int netRepSize () const override
 
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize) override
 
virtual bool setToNet () override
 
virtual void printDataToString (DtString &str) override
 
virtual void setUUID (DtUUID uuid)
 
virtual DtUUID getUUID ()
 
virtual void setSourceTrackNumber (const DtString &stn)
 
virtual DtString getSourceTrackNumber ()
 
virtual void setClearAllTracks (const bool clear)
 
virtual bool getClearAllTracks ()
 
virtual void addTrack (const IcVreTdlTrackContents &track)
 
virtual std::list< IcVreTdlTrackContents > & getTrackList ()
 

Static Public Member Functions

static DtSimInterfaceContent * creator ()
 

Protected Attributes

DtUUID myUUID
 
DtString mySourceTrackNumber
 
bool myClearAllTracks
 
int myTrackCount
 
std::list< IcVreTdlTrackContentsmyTrackList
 

Constructor & Destructor Documentation

◆ IcVreTdlTrackList() [1/2]

ctiTdl::IcVreTdlTrackList::IcVreTdlTrackList ( )

Default constructor.

Initializes an empty TDL track list message.

Referenced by IcVreTdlTrackList(), and operator=().

◆ ~IcVreTdlTrackList()

virtual ctiTdl::IcVreTdlTrackList::~IcVreTdlTrackList ( )
overridevirtual

Virtual destructor.

Cleans up all resources associated with the track list.

◆ IcVreTdlTrackList() [2/2]

ctiTdl::IcVreTdlTrackList::IcVreTdlTrackList ( const IcVreTdlTrackList & orig)

Copy constructor.

Parameters
origThe TDL track list to copy from

Creates a new TDL track list by copying an existing one, including all contained tracks.

References IcVreTdlTrackList().

Member Function Documentation

◆ operator=()

IcVreTdlTrackList & ctiTdl::IcVreTdlTrackList::operator= ( const IcVreTdlTrackList & orig)

Assignment operator.

Parameters
origThe TDL track list to copy from
Returns
Reference to this object after assignment

Copies the contents of another TDL track list into this one, including all contained tracks.

References IcVreTdlTrackList().

◆ type()

virtual int ctiTdl::IcVreTdlTrackList::type ( ) const
overridevirtual

Gets the interface message type.

Returns
The message type identifier

Returns IcVreTdlTrackListType.

◆ clone()

virtual DtSimInterfaceContent * ctiTdl::IcVreTdlTrackList::clone ( ) const
overridevirtual

Creates a copy of this message.

Returns
Pointer to the new copy

Creates a dynamically allocated copy of this message using the copy constructor.

◆ creator()

static DtSimInterfaceContent * ctiTdl::IcVreTdlTrackList::creator ( )
static

Static creator function for factory registration.

Returns
Pointer to a new instance of IcVreTdlTrackList

This static function is used for registration with DtInterfaceContentFactory.

◆ netRepSize()

virtual int ctiTdl::IcVreTdlTrackList::netRepSize ( ) const
overridevirtual

Gets the network representation size.

Returns
Size in bytes of the network representation

Returns the size of the full network representation padded to an 8-byte boundary.

◆ setFromNet()

virtual bool ctiTdl::IcVreTdlTrackList::setFromNet ( const char * contentBuffer,
unsigned contentSize )
overridevirtual

Deserializes the message from a network buffer.

Parameters
contentBufferPointer to the network buffer
contentSizeSize of the buffer in bytes
Returns
True if deserialization was successful

Fills the track list from the provided network buffer.

◆ setToNet()

virtual bool ctiTdl::IcVreTdlTrackList::setToNet ( )
overridevirtual

Serializes the message for network transmission.

Returns
True if serialization was successful

Prepares the track list for network transmission.

◆ printDataToString()

virtual void ctiTdl::IcVreTdlTrackList::printDataToString ( DtString & str)
overridevirtual

Formats the message data as a string.

Parameters
strString to store the formatted message data

Appends a human-readable representation of the track list to the provided string.

◆ setUUID()

virtual void ctiTdl::IcVreTdlTrackList::setUUID ( DtUUID uuid)
virtual

Sets the UUID for this track list.

Parameters
uuidThe UUID to set

◆ getUUID()

virtual DtUUID ctiTdl::IcVreTdlTrackList::getUUID ( )
virtual

Gets the UUID of this track list.

Returns
The track list's UUID

◆ setSourceTrackNumber()

virtual void ctiTdl::IcVreTdlTrackList::setSourceTrackNumber ( const DtString & stn)
virtual

Sets the source track number.

Parameters
stnThe source track number to set

Sets the track number of the originating Joint Unit (JU).

◆ getSourceTrackNumber()

virtual DtString ctiTdl::IcVreTdlTrackList::getSourceTrackNumber ( )
virtual

Gets the source track number.

Returns
The source track number of the originating Joint Unit

◆ setClearAllTracks()

virtual void ctiTdl::IcVreTdlTrackList::setClearAllTracks ( const bool clear)
virtual

Sets the clear all tracks flag.

Parameters
clearTrue 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.

◆ getClearAllTracks()

virtual bool ctiTdl::IcVreTdlTrackList::getClearAllTracks ( )
virtual

Gets the clear all tracks flag.

Returns
True if all tracks should be cleared, false otherwise

◆ addTrack()

virtual void ctiTdl::IcVreTdlTrackList::addTrack ( const IcVreTdlTrackContents & track)
virtual

Adds a track to the track list.

Parameters
trackThe track contents to add

Adds a track to the list of tracks in this message.

◆ getTrackList()

virtual std::list< IcVreTdlTrackContents > & ctiTdl::IcVreTdlTrackList::getTrackList ( )
virtual

Gets the list of tracks.

Returns
Reference to the list of track contents

Returns a reference to the internal list of tracks.

Member Data Documentation

◆ myUUID

DtUUID ctiTdl::IcVreTdlTrackList::myUUID
protected

UUID of this track list for unique identification.

◆ mySourceTrackNumber

DtString ctiTdl::IcVreTdlTrackList::mySourceTrackNumber
protected

Source track number (STN) of originating Joint Unit (JU)

◆ myClearAllTracks

bool ctiTdl::IcVreTdlTrackList::myClearAllTracks
protected

Flag indicating if all tracks should be cleared When true, all tracks and engagement status should be deleted/cleared.

◆ myTrackCount

int ctiTdl::IcVreTdlTrackList::myTrackCount
protected

Count of tracks in the list Maximum of 40 tracks, sorted by distance from ownship.

◆ myTrackList

std::list<IcVreTdlTrackContents> ctiTdl::IcVreTdlTrackList::myTrackList
protected

List of track contents structures.


The documentation for this class was generated from the following file: