WSF
wsf::UCI_SetDefaultModeEvent Class Reference

#include <WsfUCI_SensorComponent.hpp>

Inheritance diagram for wsf::UCI_SetDefaultModeEvent:
Collaboration diagram for wsf::UCI_SetDefaultModeEvent:

Public Member Functions

 UCI_SetDefaultModeEvent (WsfSensor *aSensorPtr, double aSimTime, size_t aPlatformIndex, size_t aLowestModeIndex)
 ~UCI_SetDefaultModeEvent () override=default
WsfEvent::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.
WsfEventoperator= (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)
WsfSimulationGetSimulation () const
void AddedToEventQueue (WsfSimulation &aSimulation)
 Called when the event is added to the event queue of the specified simulation.

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ UCI_SetDefaultModeEvent()

wsf::UCI_SetDefaultModeEvent::UCI_SetDefaultModeEvent ( WsfSensor * aSensorPtr,
double aSimTime,
size_t aPlatformIndex,
size_t aLowestModeIndex )
inline

References WsfEvent::WsfEvent().

◆ ~UCI_SetDefaultModeEvent()

wsf::UCI_SetDefaultModeEvent::~UCI_SetDefaultModeEvent ( )
overridedefault

Member Function Documentation

◆ Execute()

WsfEvent::EventDisposition wsf::UCI_SetDefaultModeEvent::Execute ( )
overridevirtual

Resets the sensor to its default mode if the corresponding platform still exists in the simulation.

Implements WsfEvent.

References WsfEvent::cDELETE, WsfEvent::GetSimulation(), and WsfEvent::GetTime().


The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved