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

Detailed Description

This class provides a mechanism for transmitting Tactical Data Link track information between simulation components. It encapsulates track contents and provides methods for network serialization and deserialization.

#include <icVreTdlTrack.h>

Inheritance diagram for ctiTdl::IcVreTdlTrack:
[legend]

Public Member Functions

 IcVreTdlTrack ()
 
virtual ~IcVreTdlTrack () override
 
 IcVreTdlTrack (const IcVreTdlTrack &orig)
 
IcVreTdlTrackoperator= (const IcVreTdlTrack &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 setTrack (const IcVreTdlTrackContents &track)
 
virtual IcVreTdlTrackContents getTrack ()
 

Static Public Member Functions

static DtSimInterfaceContent * creator ()
 

Protected Attributes

DtUUID myUUID
 
DtString sourceTrackNumber
 
IcVreTdlTrackContents trackContents
 

Constructor & Destructor Documentation

◆ IcVreTdlTrack() [1/2]

ctiTdl::IcVreTdlTrack::IcVreTdlTrack ( )

Default constructor.

Initializes an empty TDL track message.

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

◆ ~IcVreTdlTrack()

virtual ctiTdl::IcVreTdlTrack::~IcVreTdlTrack ( )
overridevirtual

Virtual destructor.

◆ IcVreTdlTrack() [2/2]

ctiTdl::IcVreTdlTrack::IcVreTdlTrack ( const IcVreTdlTrack & orig)

Copy constructor.

Parameters
origThe TDL track to copy from

Creates a new TDL track by copying an existing one.

References IcVreTdlTrack().

Member Function Documentation

◆ operator=()

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

Assignment operator.

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

Copies the contents of another TDL track into this one.

References IcVreTdlTrack().

◆ type()

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

Gets the interface message type.

Returns
The message type identifier

◆ clone()

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

Creates a copy of this message.

Returns
Pointer to the new copy

Calls the copy constructor to create a dynamically allocated clone.

◆ creator()

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

Static creator function for factory registration.

Returns
Pointer to a new instance of IcVreTdlTrack

This static function is used for registration with DtInterfaceContentFactory.

◆ netRepSize()

virtual int ctiTdl::IcVreTdlTrack::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::IcVreTdlTrack::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 message from the provided network buffer.

◆ setToNet()

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

Serializes the message for network transmission.

Returns
True if serialization was successful

Fills in the network buffer with the message contents.

◆ printDataToString()

virtual void ctiTdl::IcVreTdlTrack::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 message to the provided string.

◆ setUUID()

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

Sets the UUID for this track.

Parameters
uuidThe UUID to set

◆ getUUID()

virtual DtUUID ctiTdl::IcVreTdlTrack::getUUID ( )
virtual

Gets the UUID of this track.

Returns
The track's UUID

◆ setSourceTrackNumber()

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

Sets the source track number.

Parameters
stnThe source track number to set

◆ getSourceTrackNumber()

virtual DtString ctiTdl::IcVreTdlTrack::getSourceTrackNumber ( )
virtual

Gets the source track number.

Returns
The source track number

◆ setTrack()

virtual void ctiTdl::IcVreTdlTrack::setTrack ( const IcVreTdlTrackContents & track)
virtual

Sets the track contents.

Parameters
trackThe track contents to set

◆ getTrack()

virtual IcVreTdlTrackContents ctiTdl::IcVreTdlTrack::getTrack ( )
virtual

Gets the track contents.

Returns
The track contents

Member Data Documentation

◆ myUUID

DtUUID ctiTdl::IcVreTdlTrack::myUUID
protected

UUID of this track for unique identification.

◆ sourceTrackNumber

DtString ctiTdl::IcVreTdlTrack::sourceTrackNumber
protected

Source track number (used for correlation)

◆ trackContents

IcVreTdlTrackContents ctiTdl::IcVreTdlTrack::trackContents
protected

Detailed track contents/parameters.


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