#include <WsfCommLayerEvent.hpp>

Inheritance diagram for wsf::comm::LayerEvent:

Collaboration diagram for wsf::comm::LayerEvent:

[legend]

Public Member Functions
	LayerEvent (double aSimTime, size_t aLayerIndex, Comm aXmtrPtr, layer::Message aMessage, Message aCommMessagePtr)
	~LayerEvent () override=default
EventDisposition	Execute () override
Public Member Functions inherited from WsfEvent
	WsfEvent ()=default
	WsfEvent (double aSimTime, int aPriority=0)
	WsfEvent (const WsfEvent &aSrc)=delete
	Copy constructor and copy assignment deleted to prevent copying.
WsfEvent &	operator= (const WsfEvent &aRhs)=delete
virtual	~WsfEvent ()=default
double	GetTime () const
int	GetPriority () const
bool	ShouldExecute () const
void	SetTime (double aSimTime)
void	SetPriority (int aPriority)
void	SetShouldExecute (bool aExecute)
WsfSimulation *	GetSimulation () const
void	AddedToEventQueue (WsfSimulation &aSimulation)
	Called when the event is added to the event queue of the specified simulation.

Static Public Member Functions
static void	ScheduleCommLayerEvent (double aSimTime, size_t aLayerIndex, Comm aXmtrPtr, layer::Message aMessage, Message aCommMessagePtr=nullptr)
	This message is just a wrapper for a generic event, to avoid.

Public Attributes
size_t	mCommLayerIndex
size_t	mXmtrPlatformIndex
Comm *	mXmtrPtr
layer::Message	mLayerMessage
std::unique_ptr< Message >	mCommMessagePtr

Additional Inherited Members
Public Types inherited from WsfEvent
enum	EventDisposition { cDELETE , cRESCHEDULE }

Constructor & Destructor Documentation

◆ LayerEvent()

wsf::comm::LayerEvent::LayerEvent	(	double	aSimTime,
		size_t	aLayerIndex,
		Comm *	aXmtrPtr,
		layer::Message	aMessage,
		Message *	aCommMessagePtr )

Note: The message is cloned in a layer event, as these objects may be scheduled beyond the lifetime of the passed message object. As a smart pointer object, they are automatically deallocated when the protocol event being fired is completed. If the passed message object requires an extended lifetime, it must be cloned or moved from the event object.

References mCommLayerIndex, mCommMessagePtr, mLayerMessage, mXmtrPlatformIndex, mXmtrPtr, and WsfEvent::WsfEvent().

◆ ~LayerEvent()

wsf::comm::LayerEvent::~LayerEvent ( )

overridedefault

Member Function Documentation

◆ Execute()

WsfEvent::EventDisposition wsf::comm::LayerEvent::Execute ( )

overridevirtual

Execute the specified event.

Returns: The disposition of the event. This indicates to the event manager what should be done with the event. If cRESCHEDULE then Execute should have called SetTime to set the time for which the event manager should reschedule the event.

Implements WsfEvent.

References WsfEvent::cDELETE, WsfSimulation::GetPlatformByIndex(), WsfEvent::GetSimulation(), WsfEvent::GetTime(), mCommLayerIndex, mCommMessagePtr, mLayerMessage, mXmtrPlatformIndex, and mXmtrPtr.

◆ ScheduleCommLayerEvent()

void wsf::comm::LayerEvent::ScheduleCommLayerEvent	(	double	aSimTime,
		size_t	aLayerIndex,
		Comm *	aXmtrPtr,
		layer::Message	aMessage,
		Message *	aCommMessagePtr = nullptr )