#include <WsfSA_EntityMessage.hpp>

Inheritance diagram for WsfSA_EntityMessage:

[legend]

Collaboration diagram for WsfSA_EntityMessage:

[legend]

Public Member Functions
	WsfSA_EntityMessage ()
	WsfSA_EntityMessage (WsfPlatform *aPlatformPtr)
	WsfSA_EntityMessage (WsfPlatform aPlatformPtr, WsfSA_EntityPerception aEntityPtr)
	WsfSA_EntityMessage (const WsfSA_EntityMessage &aSrc)
	Copy constructor (for Clone()).
	WsfSA_EntityMessage (WsfSA_EntityMessage &&)=default
WsfSA_EntityMessage &	operator= (const WsfSA_EntityMessage &aSrc)
WsfSA_EntityMessage &	operator= (WsfSA_EntityMessage &&)=default
	~WsfSA_EntityMessage () override=default
WsfMessage *	Clone () const override
const char *	GetScriptClassName () const override
WsfSA_EntityPerception *	GetEntity () const
void	SetEntity (WsfSA_EntityPerception *aEntityPtr)
bool	CanBeReplacedBy (const WsfMessage &aMessage) const override
template<typename T>
void	Serialize (T &aBuff)
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)
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 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 an asset (WsfSA_EntityPerception) to be transmitted over a communications network.

Constructor & Destructor Documentation

◆ WsfSA_EntityMessage() [1/5]

WsfSA_EntityMessage::WsfSA_EntityMessage ( )

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

Referenced by CanBeReplacedBy(), Clone(), operator=(), operator=(), WsfSA_EntityMessage(), and WsfSA_EntityMessage().

◆ WsfSA_EntityMessage() [2/5]

WsfSA_EntityMessage::WsfSA_EntityMessage ( WsfPlatform * aPlatformPtr )

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

◆ WsfSA_EntityMessage() [3/5]

WsfSA_EntityMessage::WsfSA_EntityMessage	(	WsfPlatform *	aPlatformPtr,
		WsfSA_EntityPerception *	aEntityPtr )

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

◆ WsfSA_EntityMessage() [4/5]

WsfSA_EntityMessage::WsfSA_EntityMessage ( const WsfSA_EntityMessage & aSrc )

Copy constructor (for Clone()).

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

◆ WsfSA_EntityMessage() [5/5]

WsfSA_EntityMessage::WsfSA_EntityMessage ( WsfSA_EntityMessage && )

default

References WsfSA_EntityMessage().

◆ ~WsfSA_EntityMessage()

WsfSA_EntityMessage::~WsfSA_EntityMessage ( )

overridedefault

Member Function Documentation

◆ CanBeReplacedBy()

bool WsfSA_EntityMessage::CanBeReplacedBy ( const WsfMessage & aMessage ) const

overridevirtual

Can this message be replaced by the new message.

This routine can be used by communications devices to determine if a message that is to be sent should replace a message is in the queue for transmission. For example, a new track update message should replace any queued track update message for the same track ID.

Parameters

aMessage The new message.

Returns: 'true' if the supplied message is a replacement for this message.

Note: The default implementation returns 'false' (the message cannot replace the current message).

Reimplemented from WsfMessage.

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

◆ Clone()

WsfMessage * WsfSA_EntityMessage::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 WsfSA_EntityMessage().

◆ CreateScriptClass()

UtScriptClass * WsfSA_EntityMessage::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.

◆ GetEntity()

WsfSA_EntityPerception * WsfSA_EntityMessage::GetEntity ( ) const

inline

Return the pointer to the asset

Returns: a pointer to the asset contained in the message

Note: This pointer is valid only during the processing of the message. If the information is to be saved then the asset must be cloned.

Referenced by WsfSA_Perceive::ProcessMessage().

◆ GetScriptClassName()

const char * WsfSA_EntityMessage::GetScriptClassName ( ) const

override

◆ GetTypeId()

WsfStringId WsfSA_EntityMessage::GetTypeId ( )

static

Referenced by CanBeReplacedBy(), WsfSA_Perceive::ProcessMessage(), WsfSA_EntityMessage(), WsfSA_EntityMessage(), and WsfSA_EntityMessage().

◆ operator=() [1/2]

WsfSA_EntityMessage & WsfSA_EntityMessage::operator= ( const WsfSA_EntityMessage & aSrc )

References WsfSA_EntityMessage().

◆ operator=() [2/2]

WsfSA_EntityMessage & WsfSA_EntityMessage::operator= ( WsfSA_EntityMessage && )

default

References WsfSA_EntityMessage().

◆ Serialize()

template<typename T>

void WsfSA_EntityMessage::Serialize ( T & aBuff )

inline

References WsfMessage::Serialize().

◆ SetEntity()

void WsfSA_EntityMessage::SetEntity ( WsfSA_EntityPerception * aEntityPtr )

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

◆ WsfSA_EntityMessage() [1/5]

◆ WsfSA_EntityMessage() [2/5]

◆ WsfSA_EntityMessage() [3/5]

◆ WsfSA_EntityMessage() [4/5]

◆ WsfSA_EntityMessage() [5/5]

◆ ~WsfSA_EntityMessage()

Member Function Documentation

◆ CanBeReplacedBy()

◆ Clone()

◆ CreateScriptClass()

◆ GetEntity()

◆ GetScriptClassName()

◆ GetTypeId()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Serialize()

◆ SetEntity()