wsf::comm::Event Class Reference

An event associated with communications (transfer complete, etc). More...

#include <WsfCommEvent.hpp>

Inheritance diagram for wsf::comm::Event:

Collaboration diagram for wsf::comm::Event:

Public Member Functions
	Event (double aSimTime, Comm *aXmtrPtr)
	~Event () override
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	ScheduleDeliverMessageEvent (double aSimTime, Comm *aXmtrPtr, Comm *aRcvrPtr, Message *aCommMessagePtr)

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

Detailed Description

An event associated with communications (transfer complete, etc).

Constructor & Destructor Documentation

Event()

wsf::comm::Event::Event	(	double	aSimTime,
		Comm *	aXmtrPtr )

Create a Comm event.

Parameters

aSimTime	Time at which the event should dispatch.
aXmtrPtr	If aEventType == cDELIVER_MESSAGE, this must be the pointer to the transmitting comm device. For all other events this must be the pointer to the comm device to which the event applies.

References WsfEvent::WsfEvent().

~Event()

wsf::comm::Event::~Event ( )

override

Member Function Documentation

Execute()

WsfEvent::EventDisposition wsf::comm::Event::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, wsf::comm::layer::cUP_NACK_SEND(), WsfSimulation::GetPlatformByIndex(), WsfEvent::GetSimulation(), WsfEvent::GetTime(), and simTime.

ScheduleDeliverMessageEvent()

void wsf::comm::Event::ScheduleDeliverMessageEvent ( double aSimTime, Comm * aXmtrPtr, Comm * aRcvrPtr, Message * aCommMessagePtr )

static

References WsfSimulation::AddEvent(), wsf::comm::Message::Clone(), WsfPlatform::GetIndex(), WsfPlatformPart::GetPlatform(), and WsfPlatformPart::GetSimulation().

---

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

• WsfCommEvent.hpp
• WsfCommEvent.cpp