WsfPlatformPartEvent Class Reference

#include <WsfPlatformPartEvent.hpp>

Inheritance diagram for WsfPlatformPartEvent:

Collaboration diagram for WsfPlatformPartEvent:

Public Types
enum	EventType { cUPDATE , cTURN_OFF , cTURN_ON }
Public Types inherited from WsfEvent
enum	EventDisposition { cDELETE , cRESCHEDULE }

Public Member Functions
	WsfPlatformPartEvent ()=delete
	WsfPlatformPartEvent (double aSimTime, EventType aEventType, WsfPlatformPart *aPartPtr)
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.

Detailed Description

An event to process part updates and requests to turn a part on or off.

This event is queued by WsfEventStepSimulation (or anything that wants to behave like it).

Member Enumeration Documentation

EventType

enum WsfPlatformPartEvent::EventType

Enumerator
cUPDATE	Call the sensors Update() method.
cTURN_OFF	Turn the sensor off.
cTURN_ON	Turn the sensor on.

Constructor & Destructor Documentation

WsfPlatformPartEvent() [1/2]

WsfPlatformPartEvent::WsfPlatformPartEvent ( )

delete

References WsfPlatformPartEvent().

Referenced by WsfPlatformPartEvent().

WsfPlatformPartEvent() [2/2]

WsfPlatformPartEvent::WsfPlatformPartEvent	(	double	aSimTime,
		EventType	aEventType,
		WsfPlatformPart *	aPartPtr )

References platformPtr, and WsfEvent::WsfEvent().

Member Function Documentation

Execute()

WsfEvent::EventDisposition WsfPlatformPartEvent::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 WsfSimulation::AddEvent(), WsfEvent::cDELETE, WsfEvent::cRESCHEDULE, cTURN_OFF, cTURN_ON, cUPDATE, WsfSimulation::GetMultiThreadManager(), WsfPlatformPart::GetPartType(), WsfEvent::GetSimulation(), WsfEvent::GetTime(), WsfPlatformPart::GetUpdateEventEpoch(), WsfPlatformPart::GetUpdateInterval(), WsfPlatformPart::IncrementUpdateEventEpoch(), WsfPlatformPart::IsExternallyControlled(), WsfSensor::IsSlave(), WsfEvent::SetTime(), WsfPlatformPart::SetUpdateEventActive(), simTime, WsfPlatformPart::TurnOff(), WsfPlatformPart::TurnOn(), WsfMultiThreadManager::TurnSensorOff(), WsfMultiThreadManager::TurnSensorOn(), and WsfPlatformPart::Update().

---

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

• WsfPlatformPartEvent.hpp
• WsfPlatformPartEvent.cpp