PeriodicEventReporter is a subclass of ScheduledEventReporter which generates a series of uniformly spaced events at regular intervals.
More...
PeriodicEventReporter is a subclass of ScheduledEventReporter which generates a series of uniformly spaced events at regular intervals.
This allows you to very easily create event reporters with this behavior.
◆ ~PeriodicEventReporter()
SimTK::PeriodicEventReporter::~PeriodicEventReporter |
( |
| ) |
|
◆ PeriodicEventReporter()
SimTK::PeriodicEventReporter::PeriodicEventReporter |
( |
Real |
eventInterval | ) |
|
|
explicit |
◆ getNextEventTime()
Real SimTK::PeriodicEventReporter::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::ScheduledEventReporter.
◆ getEventInterval()
Real SimTK::PeriodicEventReporter::getEventInterval |
( |
| ) |
const |
Get the time interval at which events occur.
◆ setEventInterval()
void SimTK::PeriodicEventReporter::setEventInterval |
( |
Real |
eventInterval | ) |
|
Set the time interval at which events occur.
The documentation for this class was generated from the following file: