ctiTdl::IcVreTdlEngagementStatus Class Reference

Detailed Description

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).

#include <icVreTdlEngagementStatus.h>

Inheritance diagram for ctiTdl::IcVreTdlEngagementStatus:

Public Member Functions
	IcVreTdlEngagementStatus ()
virtual	~IcVreTdlEngagementStatus () override
	IcVreTdlEngagementStatus (const IcVreTdlEngagementStatus &orig)
IcVreTdlEngagementStatus &	operator= (const IcVreTdlEngagementStatus &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	setObjectiveTrackNumber (const DtString &tn)
virtual DtString	getObjectiveTrackNumber ()
virtual void	setEngagementStatus (const int status)
virtual int	getEngagementStatus ()

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Protected Attributes
DtUUID	myUUID
DtString	mySourceTrackNumber
DtString	myObjectiveTrackNumber
int	myEngagementStatus

Constructor & Destructor Documentation

IcVreTdlEngagementStatus() [1/2]

ctiTdl::IcVreTdlEngagementStatus::IcVreTdlEngagementStatus

(

)

Default constructor.

Initializes an empty engagement status message.

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

~IcVreTdlEngagementStatus()

virtual ctiTdl::IcVreTdlEngagementStatus::~IcVreTdlEngagementStatus ( )

overridevirtual

Virtual destructor.

Cleans up all resources associated with the engagement status.

IcVreTdlEngagementStatus() [2/2]

ctiTdl::IcVreTdlEngagementStatus::IcVreTdlEngagementStatus

(

const IcVreTdlEngagementStatus &

orig

)

Copy constructor.

Parameters

orig	The engagement status to copy from

Creates a new engagement status by copying an existing one.

References IcVreTdlEngagementStatus().

Member Function Documentation

operator=()

IcVreTdlEngagementStatus & ctiTdl::IcVreTdlEngagementStatus::operator=

(

const IcVreTdlEngagementStatus &

orig

)

Assignment operator.

Parameters

orig	The engagement status to copy from

Returns

Reference to this object after assignment

Copies the contents of another engagement status into this one.

References IcVreTdlEngagementStatus().

type()

virtual int ctiTdl::IcVreTdlEngagementStatus::type ( ) const

overridevirtual

Gets the interface message type.

Returns

The message type identifier

Returns IcVreTdlEngagementStatusType.

clone()

virtual DtSimInterfaceContent * ctiTdl::IcVreTdlEngagementStatus::clone ( ) const

overridevirtual

Creates a copy of this message.

Returns

Pointer to the new copy

Creates a dynamically allocated copy of this message.

creator()

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

static

Static creator function for factory registration.

Returns

Pointer to a new instance of IcVreTdlEngagementStatus

This static function is used for registration with DtInterfaceContentFactory.

netRepSize()

virtual int ctiTdl::IcVreTdlEngagementStatus::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::IcVreTdlEngagementStatus::setFromNet ( const char * contentBuffer, unsigned contentSize )

overridevirtual

Deserializes the message from a network buffer.

Parameters

contentBuffer	Pointer to the network buffer
contentSize	Size of the buffer in bytes

Returns

True if deserialization was successful

Fills the engagement status from the provided network buffer.

setToNet()

virtual bool ctiTdl::IcVreTdlEngagementStatus::setToNet ( )

overridevirtual

Serializes the message for network transmission.

Returns

True if serialization was successful

Prepares the engagement status for network transmission.

printDataToString()

virtual void ctiTdl::IcVreTdlEngagementStatus::printDataToString ( DtString & str )

overridevirtual

Formats the message data as a string.

Parameters

str	String to store the formatted message data

Appends a human-readable representation of the engagement status to the provided string.

setUUID()

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

virtual

Sets the UUID for this engagement status.

Parameters

uuid	The UUID to set

getUUID()

virtual DtUUID ctiTdl::IcVreTdlEngagementStatus::getUUID ( )

virtual

Gets the UUID of this engagement status.

Returns

The engagement status UUID

setSourceTrackNumber()

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

virtual

Sets the source track number.

Parameters

stn	The source track number to set

Sets the track number (STN) of the engaging platform.

getSourceTrackNumber()

virtual DtString ctiTdl::IcVreTdlEngagementStatus::getSourceTrackNumber ( )

virtual

Gets the source track number.

Returns

The source track number of the engaging platform

setObjectiveTrackNumber()

virtual void ctiTdl::IcVreTdlEngagementStatus::setObjectiveTrackNumber ( const DtString & tn )

virtual

Sets the objective track number.

Parameters

tn	The objective track number to set

Sets the track number (TN) of the objective/target platform.

getObjectiveTrackNumber()

virtual DtString ctiTdl::IcVreTdlEngagementStatus::getObjectiveTrackNumber ( )

virtual

Gets the objective track number.

Returns

The track number of the objective/target platform

setEngagementStatus()

virtual void ctiTdl::IcVreTdlEngagementStatus::setEngagementStatus ( const int status )

virtual

Sets the engagement status.

Parameters

status

The engagement status code to set

Sets the engagement status code as defined in ctiTdl::StatusType.

getEngagementStatus()

virtual int ctiTdl::IcVreTdlEngagementStatus::getEngagementStatus ( )

virtual

Gets the engagement status.

Returns

The engagement status code

Returns the engagement status code as defined in ctiTdl::StatusType.

Member Data Documentation

myUUID

DtUUID ctiTdl::IcVreTdlEngagementStatus::myUUID

protected

UUID of this engagement status for unique identification.

mySourceTrackNumber

DtString ctiTdl::IcVreTdlEngagementStatus::mySourceTrackNumber

protected

Source track number (STN) of the engaging platform.

myObjectiveTrackNumber

DtString ctiTdl::IcVreTdlEngagementStatus::myObjectiveTrackNumber

protected

Track number (TN) of the objective/target platform.

myEngagementStatus

int ctiTdl::IcVreTdlEngagementStatus::myEngagementStatus

protected

Current engagement status code See ctiTdl::StatusType in VreTdlTrackTypes.h for possible values.

---

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

• include/vrfExtensions/vreVrfMessages/icVreTdlEngagementStatus.h