PeriodicEventHandler Class Reference
#include <EventHandler.h>
Inheritance diagram for PeriodicEventHandler:
Detailed Description
PeriodicEventHandler is a subclass of ScheduledEventHandler which generates a series of uniformly spaced events at regular intervals.This allows you to very easily create event handlers with this behavior.
Public Member Functions | |
| ~PeriodicEventHandler () | |
| Real | getNextEventTime (const State &state, bool includeCurrentTime) const |
| Get the next time at which an event will occur. | |
| PeriodicEventHandler (Real eventInterval) | |
| Create a PeriodicEventHandler. | |
| Real | getEventInterval () const |
| Get the time interval at which events occur. | |
| void | setEventInterval (Real eventInterval) |
| Set the time interval at which events occur. | |
Constructor & Destructor Documentation
| ~PeriodicEventHandler | ( | ) |
| PeriodicEventHandler | ( | Real | eventInterval | ) |
Create a PeriodicEventHandler.
- Parameters:
-
eventInterval the time interval at which events should occur.
Member Function Documentation
| Real getNextEventTime | ( | const State & | , | |
| bool | includeCurrentTime | |||
| ) | const [virtual] |
Get the next time at which an event will occur.
- Parameters:
-
state the current state of the system includeCurrentTime if true, return the next event whose time is >= the current time. If false, only return events after (not at) the current time.
Implements ScheduledEventHandler.
| Real getEventInterval | ( | ) | const |
Get the time interval at which events occur.
| void setEventInterval | ( | Real | eventInterval | ) |
Set the time interval at which events occur.
The documentation for this class was generated from the following file:
