wsf::comm::medium::MessageStatus Class Reference

#include <WsfCommMediumMessageStatus.hpp>

Inheritance diagram for wsf::comm::medium::MessageStatus:

Collaboration diagram for wsf::comm::medium::MessageStatus:

Public Member Functions
	MessageStatus (double aSimTime, Message &aMessage, size_t aMode)
	~MessageStatus () override=default
	MessageStatus (const MessageStatus &aSrc)=default
const char *	GetScriptClassName () const override
void	SetMessage (const Message &aMessage)
void	SetMode (size_t aMode)
void	SetLayer (Layer *aLayerPtr)
void	SetIsTransmitting (bool aIsTransmitting)
void	SetIsScheduledDelivery (bool aIsScheduledDelivery)
void	SetTimeStart (double aSimTime)
void	SetTimeTransmissionEnd (double aSimTime)
void	SetTimeDelivery (double aSimTime)
void	SetAbortDelivery (bool aAbort)
void	SetTimeLastXmtrStatusChange (double aSimTime)
void	SetStatusIssued (bool aIssued)
const Message &	GetMessage () const
Message &	GetMessage ()
size_t	GetMode () const
Layer *	GetLayer () const
bool	IsTransmitting () const
bool	IsScheduledDelivery () const
double	GetTimeStart () const
double	GetTimeTransmissionEnd () const
double	GetTimeDelivery () const
bool	AbortDelivery () const
double	GetTimeLastXmtrStatusChange () const
bool	IsStatusIssued () 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

Additional Inherited Members
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed

Detailed Description

The message status class is a container object used for storing data related to message state when being transmitted over a medium. The container may contain aux data for customization.

Constructor & Destructor Documentation

MessageStatus() [1/2]

wsf::comm::medium::MessageStatus::MessageStatus ( double aSimTime, Message & aMessage, size_t aMode )

inline

Referenced by MessageStatus().

~MessageStatus()

wsf::comm::medium::MessageStatus::~MessageStatus ( )

overridedefault

MessageStatus() [2/2]

wsf::comm::medium::MessageStatus::MessageStatus ( const MessageStatus & aSrc )

default

References MessageStatus().

Member Function Documentation

AbortDelivery()

bool wsf::comm::medium::MessageStatus::AbortDelivery ( ) const

inline

Referenced by wsf::comm::medium::Guided::EndPropagation(), wsf::comm::medium::Unguided::EndPropagation(), wsf::comm::medium::Guided::EndTransmission(), and wsf::comm::medium::Unguided::EndTransmission().

GetLayer()

Layer * wsf::comm::medium::MessageStatus::GetLayer ( ) const

inline

Referenced by wsf::comm::medium::Unguided::EndPropagation(), wsf::comm::medium::Guided::EndTransmission(), and wsf::comm::medium::Unguided::EndTransmission().

GetMessage() [1/2]

Message & wsf::comm::medium::MessageStatus::GetMessage ( )

inline

GetMessage() [2/2]

const Message & wsf::comm::medium::MessageStatus::GetMessage ( ) const

inline

Referenced by wsf::comm::medium::Guided::EndPropagation(), wsf::comm::medium::Unguided::EndPropagation(), wsf::comm::medium::Guided::EndTransmission(), wsf::comm::medium::Unguided::EndTransmission(), and wsf::comm::medium::Guided::PropagateMessage().

GetMode()

size_t wsf::comm::medium::MessageStatus::GetMode ( ) const

inline

GetScriptClassName()

const char * wsf::comm::medium::MessageStatus::GetScriptClassName ( ) const

inlineoverride

GetTimeDelivery()

double wsf::comm::medium::MessageStatus::GetTimeDelivery ( ) const

inline

Referenced by wsf::comm::medium::Guided::PropagateMessage().

GetTimeLastXmtrStatusChange()

double wsf::comm::medium::MessageStatus::GetTimeLastXmtrStatusChange ( ) const

inline

Referenced by wsf::comm::medium::Guided::EndTransmission(), and wsf::comm::medium::Unguided::EndTransmission().

GetTimeStart()

double wsf::comm::medium::MessageStatus::GetTimeStart ( ) const

inline

GetTimeTransmissionEnd()

double wsf::comm::medium::MessageStatus::GetTimeTransmissionEnd ( ) const

inline

IsScheduledDelivery()

bool wsf::comm::medium::MessageStatus::IsScheduledDelivery ( ) const

inline

IsStatusIssued()

bool wsf::comm::medium::MessageStatus::IsStatusIssued ( ) const

inline

Referenced by wsf::comm::medium::Unguided::EndPropagation(), wsf::comm::medium::Guided::EndTransmission(), and wsf::comm::medium::Unguided::EndTransmission().

IsTransmitting()

bool wsf::comm::medium::MessageStatus::IsTransmitting ( ) const

inline

SetAbortDelivery()

void wsf::comm::medium::MessageStatus::SetAbortDelivery ( bool aAbort )

inline

Referenced by wsf::comm::medium::Guided::EndTransmission(), wsf::comm::medium::Unguided::EndTransmission(), wsf::comm::medium::Guided::TransmitMessage(), and wsf::comm::medium::Unguided::TransmitMessage().

SetIsScheduledDelivery()

void wsf::comm::medium::MessageStatus::SetIsScheduledDelivery ( bool aIsScheduledDelivery )

inline

SetIsTransmitting()

void wsf::comm::medium::MessageStatus::SetIsTransmitting ( bool aIsTransmitting )

inline

Referenced by wsf::comm::medium::Guided::EndTransmission(), and wsf::comm::medium::Unguided::EndTransmission().

SetLayer()

void wsf::comm::medium::MessageStatus::SetLayer ( Layer * aLayerPtr )

inline

Referenced by wsf::comm::medium::Guided::TransmitMessage(), and wsf::comm::medium::Unguided::TransmitMessage().

SetMessage()

void wsf::comm::medium::MessageStatus::SetMessage ( const Message & aMessage )

inline

SetMode()

void wsf::comm::medium::MessageStatus::SetMode ( size_t aMode )

inline

SetStatusIssued()

void wsf::comm::medium::MessageStatus::SetStatusIssued ( bool aIssued )

inline

Referenced by wsf::comm::medium::Guided::EndTransmission().

SetTimeDelivery()

void wsf::comm::medium::MessageStatus::SetTimeDelivery ( double aSimTime )

inline

Referenced by wsf::comm::medium::Guided::TransmitMessage(), and wsf::comm::medium::Unguided::TransmitMessage().

SetTimeLastXmtrStatusChange()

void wsf::comm::medium::MessageStatus::SetTimeLastXmtrStatusChange ( double aSimTime )

inline

Referenced by wsf::comm::medium::Guided::TransmitMessage(), and wsf::comm::medium::Unguided::TransmitMessage().

SetTimeStart()

void wsf::comm::medium::MessageStatus::SetTimeStart ( double aSimTime )

inline

SetTimeTransmissionEnd()

void wsf::comm::medium::MessageStatus::SetTimeTransmissionEnd ( double aSimTime )

inline

Referenced by wsf::comm::medium::Guided::TransmitMessage(), and wsf::comm::medium::Unguided::TransmitMessage().

---

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

• WsfCommMediumMessageStatus.hpp