wsf::comm::ComponentHW::AltFrequencyChangeEvent Class Reference
#include <WsfCommComponentHW.hpp>
Inheritance diagram for wsf::comm::ComponentHW::AltFrequencyChangeEvent:
Collaboration diagram for wsf::comm::ComponentHW::AltFrequencyChangeEvent:
Public Member Functions | |
| AltFrequencyChangeEvent ()=default | |
| AltFrequencyChangeEvent (double aSimTime, Comm *aCommPtr, int aAltFrequencyId=-1) | |
| Alternate frequency selection event that changes a comm devices frequency. | |
| 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. | |
Additional Inherited Members | |
| Public Types inherited from WsfEvent | |
| enum | EventDisposition { cDELETE , cRESCHEDULE } |
Detailed Description
The nested class 'FrequencyChangeEvent' is necessary so that the data necessary for this event is separate from WsfCommEvent.
Constructor & Destructor Documentation
◆ AltFrequencyChangeEvent() [1/2]
|
default |
References AltFrequencyChangeEvent(), and Execute().
Referenced by AltFrequencyChangeEvent().
◆ AltFrequencyChangeEvent() [2/2]
| wsf::comm::ComponentHW::AltFrequencyChangeEvent::AltFrequencyChangeEvent | ( | double | aSimTime, |
| Comm * | aCommPtr, | ||
| int | aAltFrequencyId = -1 ) |
Alternate frequency selection event that changes a comm devices frequency.
References WsfEvent::WsfEvent().
Member Function Documentation
◆ 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::ComponentHW::ComponentHW(), wsf::comm::ComponentHW::Find(), WsfSimulation::GetPlatformByIndex(), wsf::comm::Component::GetSimulation(), WsfEvent::GetTime(), platformPtr, and wsf::comm::ComponentHW::SelectAlternateFrequency().
Referenced by AltFrequencyChangeEvent().
The documentation for this class was generated from the following files: