#include <EventReporter.h>
This is implemented by means of an "event trigger function". For any State, the handler must be able to calculate the value of the function. When it passes through 0, that indicates the event has occurred. You can also customize when the event is triggered, for example to specify that it is only triggered when the function goes from negative to positive, not when it goes from positive to negative.
Public Member Functions | |
TriggeredEventReporter (const TriggeredEventReporter &clone) | |
TriggeredEventReporter & | operator= (const TriggeredEventReporter &clone) |
virtual | ~TriggeredEventReporter () |
TriggeredEventReporter (Stage requiredStage) | |
Construct a new TriggeredEventReporter. | |
virtual Real | getValue (const State &) const =0 |
Get the value of the event trigger function for a State. | |
System::EventTriggerInfo & | getTriggerInfo () |
Get an EventTriggerInfo object which can be used to customize when the event occurs. | |
Stage | getRequiredStage () const |
Get the stage at which the trigger function will be evaluated. |
TriggeredEventReporter | ( | const TriggeredEventReporter & | clone | ) |
virtual ~TriggeredEventReporter | ( | ) | [virtual] |
TriggeredEventReporter | ( | Stage | requiredStage | ) |
Construct a new TriggeredEventReporter.
requiredStage | the stage at which the trigger function will be evaluated |
TriggeredEventReporter& operator= | ( | const TriggeredEventReporter & | clone | ) |
virtual Real getValue | ( | const State & | ) | const [pure virtual] |
Get the value of the event trigger function for a State.
System::EventTriggerInfo& getTriggerInfo | ( | ) |
Get an EventTriggerInfo object which can be used to customize when the event occurs.
Stage getRequiredStage | ( | ) | const |
Get the stage at which the trigger function will be evaluated.