WsfL16::JMessage Class Reference

#include <JMessage.hpp>

Inheritance diagram for WsfL16::JMessage:

Collaboration diagram for WsfL16::JMessage:

Public Types
typedef std::shared_ptr< const Messages::InitialBase >	MessagePtr

Public Member Functions
	JMessage (MessagePtr aMessage, WsfPlatform *aPlatformPtr)
	JMessage (const JMessage &aSrc)
	~JMessage () override
WsfMessage *	Clone () const override
JMessage &	operator= (JMessage &aMsg)
MessagePtr	Get ()
	Returns the message.
const MessagePtr	Get () const
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 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

Passes J-Messages across WSF. Uses a SharedPtr to avoid copying the message

Member Typedef Documentation

MessagePtr

typedef std::shared_ptr<const Messages::InitialBase> WsfL16::JMessage::MessagePtr

Constructor & Destructor Documentation

JMessage() [1/2]

WsfL16::JMessage::JMessage	(	MessagePtr	aMessage,
		WsfPlatform *	aPlatformPtr )

Initialize the message. JMessage will handle deletion of aMessage.

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

Referenced by Clone(), JMessage(), and operator=().

JMessage() [2/2]

WsfL16::JMessage::JMessage

(

const JMessage &

aSrc

)

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

~JMessage()

WsfL16::JMessage::~JMessage ( )

override

Member Function Documentation

Clone()

WsfMessage * WsfL16::JMessage::Clone ( ) const

overridevirtual

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 JMessage(), and WsfMessage::WsfMessage().

Get() [1/2]

MessagePtr WsfL16::JMessage::Get ( )

inline

Returns the message.

Referenced by WsfL16::ComputerProcessor::ProcessMessage(), and WsfL16::ComputerProcessor::SentJMessage().

Get() [2/2]

const MessagePtr WsfL16::JMessage::Get ( ) const

inline

GetTypeId()

WsfStringId WsfL16::JMessage::GetTypeId ( )

static

Referenced by JMessage().

operator=()

JMessage & WsfL16::JMessage::operator=

(

JMessage &

aMsg

)

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

---

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

• JMessage.hpp
• JMessage.cpp