A specialization of WsfMessage that represents the message generated to indicate that a track has been dropped. More...

#include <WsfTrackDropMessage.hpp>

Inheritance diagram for WsfTrackDropMessage:

[legend]

Collaboration diagram for WsfTrackDropMessage:

[legend]

Public Member Functions
	WsfTrackDropMessage ()
	Constructor, for XIO (de)serialization.
	WsfTrackDropMessage (WsfPlatform *aPlatformPtr, double aTime, const WsfTrackId &aTrackId, size_t aPlatformIndex)
	~WsfTrackDropMessage () override=default
WsfMessage *	Clone () const override
const char *	GetScriptClassName () const override
double	GetTime () const
void	SetTime (double aSimTime)
	Set the time at which the track was dropped.
const WsfTrackId &	GetTrackId () const
size_t	GetTargetIndex () const
void	SetTargetIndex (size_t aTargetIndex)
	Set the truth platform index corresponding to the dropped track.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
Public Member Functions inherited from WsfMessage
	WsfMessage (WsfStringId aType)
	Constructor for XIO (de)serialization.
	WsfMessage (WsfStringId aType, const wsf::comm::Address &aSrcAddr, WsfSimulation &aSimulation)
	WsfMessage (WsfPlatform *aPlatformPtr)
	WsfMessage (WsfStringId aType, WsfPlatform *aPlatformPtr)
	WsfMessage (WsfStringId aType, WsfStringId aSubType, WsfPlatform *aPlatformPtr)
	WsfMessage (WsfSimulation &aSimulation)
WsfMessage &	operator= (const WsfMessage &aRhs)=default
	~WsfMessage () override
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
	Get the simulation that owns the message.
void	SetSimulation (WsfSimulation *aSimulationPtr)
WsfStringId	GetOriginator () const
void	SetOriginator (WsfPlatform *aPlatformPtr)
	Set the originator of this message.
size_t	GetOriginatorIndex () const
int	GetSizeBits () const
void	SetSizeBits (int aSizeBits)
int	GetSizeBytes () const
void	SetSizeBytes (int aSizeBytes)
unsigned int	GetSerialNumber () const
void	SetSerialNumber (unsigned int aSerialNumber)
double	GetDataTag () const
void	SetDataTag (double aDataTag)
WsfStringId	GetStaticType () const
WsfStringId	GetType () const
void	SetType (WsfStringId aType)
WsfStringId	GetSubType () const
void	SetSubType (WsfStringId aSubType)
int	GetPriority () const
void	SetPriority (int aPriority)
const wsf::comm::Address &	GetSrcAddr () const
void	SetSrcAddr (const wsf::comm::Address &aSrcAddr)
const wsf::comm::Address &	GetDstAddr () const
void	SetDstAddr (const wsf::comm::Address &aDstAddr)
const wsf::comm::Address &	GetNextHopAddr () const
void	SetNextHopAddr (const wsf::comm::Address &aNextHopAddr)
virtual bool	CanBeReplacedBy (const WsfMessage &aMessage) const
WsfStringId	GetGroup () const
void	SetGroup (WsfStringId aGroup) const
void	PrintDataTagPrecise (std::ostream &aStream, std::streamsize aPrecision) const
template<typename T>
void	Serialize (T &aBuff)
	(De)serializer for XIO
virtual WsfStringId	GetComponentNameId () const
virtual WsfStringId	GetComponentTypeId () const
virtual WsfStringId	GetComponentModeId () const
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Static Public Member Functions
static std::unique_ptr< UtScriptClass >	CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
static WsfStringId	GetTypeId ()
Static Public Member Functions inherited from WsfMessage
static WsfStringId	GetTypeId ()

Additional Inherited Members
Static Public Attributes inherited from WsfMessage
static constexpr size_t	cBITS_IN_BYTE = 8U
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
	WsfMessage (const WsfMessage &aSrc)=default

Detailed Description

A specialization of WsfMessage that represents the message generated to indicate that a track has been dropped.

WsfSensor in an example of a class that generates this type of message.

Constructor & Destructor Documentation

◆ WsfTrackDropMessage() [1/2]

WsfTrackDropMessage::WsfTrackDropMessage ( )

Constructor, for XIO (de)serialization.

References GetTypeId(), and WsfMessage::WsfMessage().

Referenced by Clone().

◆ WsfTrackDropMessage() [2/2]

WsfTrackDropMessage::WsfTrackDropMessage	(	WsfPlatform *	aPlatformPtr,
		double	aTime,
		const WsfTrackId &	aTrackId,
		size_t	aPlatformIndex )

Constructor.

Parameters

aPlatformPtr	The originator of the message.
aTime	The simulation time at which the track was dropped.
aTrackId	The platforms track ID corresponding to the dropped track.
aPlatformIndex	the (truth) platform index corresponding to the dropped track.

References GetTypeId(), and WsfMessage::WsfMessage().

◆ ~WsfTrackDropMessage()

WsfTrackDropMessage::~WsfTrackDropMessage ( )

overridedefault

Member Function Documentation

◆ Clone()

WsfMessage * WsfTrackDropMessage::Clone ( ) const

inlineoverridevirtual

Clone this object by creating an identical copy and returning a pointer to it.

Returns: A pointer to the cloned object.

Reimplemented from WsfMessage.

References WsfMessage::WsfMessage(), and WsfTrackDropMessage().

◆ CreateScriptClass()

std::unique_ptr< UtScriptClass > WsfTrackDropMessage::CreateScriptClass	(	const std::string &	aClassName,
		UtScriptTypes *	aScriptTypesPtr )

static

Create the 'class' object for the script system. This is invoked once by WsfScriptManager to create the 'class' object that defines the interface to instances of this class from the script system.

Referenced by WsfScriptManager::RegisterTypes().

◆ GetScriptClassName()

const char * WsfTrackDropMessage::GetScriptClassName ( ) const

override

◆ GetTargetIndex()

size_t WsfTrackDropMessage::GetTargetIndex ( ) const

inline

Get the truth platform index corresponding to the dropped track.

Returns: The platform index corresponding to the dropped track.

Referenced by WsfCompositeSensor::ProcessMessage(), WsfRF_Jammer::ProcessMessage(), WsfTrackProcessor::ProcessMessage(), and WsfXIO_AutoDisMapping::TranslateTrackDropMessage().

◆ GetTime()

double WsfTrackDropMessage::GetTime ( ) const

inline

Get the time at which the track was dropped.

Returns: The simulation time at which the track was dropped.

Referenced by WsfXIO_AutoDisMapping::TranslateTrackDropMessage().

◆ GetTrackId()

const WsfTrackId & WsfTrackDropMessage::GetTrackId ( ) const

inline

Get the ID of the track being dropped.

Returns: The ID of the dropped track.

Referenced by WsfCompositeSensor::ProcessMessage(), WsfRF_Jammer::ProcessMessage(), WsfTrackProcessor::ProcessMessage(), WsfWeaponTrackProcessor::ProcessMessage(), WsfTaskManager::ProcessTrackDropMessage(), and WsfXIO_AutoDisMapping::TranslateTrackDropMessage().

◆ GetTypeId()

WsfStringId WsfTrackDropMessage::GetTypeId ( )

static

Get the message type ID for messages of this class.

Returns: The integer message type ID for messages of this type.

Referenced by WsfXIO_MessageService::HandleMessage(), WsfXIO_AutoDisMapping::Initialize(), WsfDefaultAssetManagerImpl::on_message(), WsfCompositeSensor::ProcessMessage(), WsfRF_Jammer::ProcessMessage(), WsfTrackProcessor::ProcessMessage(), WsfWeaponTrackProcessor::ProcessMessage(), WsfTrackDropMessage(), and WsfTrackDropMessage().

◆ Serialize()

template<typename T>

void WsfTrackDropMessage::Serialize ( T & aBuff )

inline

For XIO (de)serialization.

References WsfMessage::Serialize().

◆ SetTargetIndex()

void WsfTrackDropMessage::SetTargetIndex ( size_t aTargetIndex )

inline

Set the truth platform index corresponding to the dropped track.

Referenced by WsfXIO_AutoDisMapping::TranslateTrackDropMessage().

◆ SetTime()

void WsfTrackDropMessage::SetTime ( double aSimTime )

inline

Set the time at which the track was dropped.

Referenced by WsfXIO_AutoDisMapping::TranslateTrackDropMessage().

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfTrackDropMessage() [1/2]

◆ WsfTrackDropMessage() [2/2]

◆ ~WsfTrackDropMessage()

Member Function Documentation

◆ Clone()

◆ CreateScriptClass()

◆ GetScriptClassName()

◆ GetTargetIndex()

◆ GetTime()

◆ GetTrackId()

◆ GetTypeId()

◆ Serialize()

◆ SetTargetIndex()

◆ SetTime()