PeriodicEventHandler is a subclass of ScheduledEventHandler which generates a series of uniformly spaced events at regular intervals.
More...
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.
◆ ~PeriodicEventHandler()
SimTK::PeriodicEventHandler::~PeriodicEventHandler |
( |
| ) |
|
◆ PeriodicEventHandler()
SimTK::PeriodicEventHandler::PeriodicEventHandler |
( |
Real |
eventInterval | ) |
|
|
explicit |
Create a PeriodicEventHandler.
- Parameters
-
eventInterval | The time interval at which events should occur. |
◆ getNextEventTime()
Real SimTK::PeriodicEventHandler::getNextEventTime |
( |
const State & |
state, |
|
|
bool |
includeCurrentTime |
|
) |
| const |
|
overridevirtual |
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 SimTK::ScheduledEventHandler.
◆ getEventInterval()
Real SimTK::PeriodicEventHandler::getEventInterval |
( |
| ) |
const |
Get the time interval at which events occur.
◆ setEventInterval()
void SimTK::PeriodicEventHandler::setEventInterval |
( |
Real |
eventInterval | ) |
|
Set the time interval at which events occur.
The documentation for this class was generated from the following file: