1 #ifndef SimTK_SimTKCOMMON_EVENT_REPORTER_H_
2 #define SimTK_SimTKCOMMON_EVENT_REPORTER_H_
98 class TriggeredEventReporterImpl;
129 TriggeredEventReporterImpl* impl;
140 class PeriodicEventReporterImpl;
163 PeriodicEventReporterImpl* impl;
#define SimTK_SimTKCOMMON_EXPORT
Definition: SimTKcommon/include/SimTKcommon/internal/common.h:224
This is the header which should be included in user programs that would like to make use of all the S...
Declares the user-visible part of a SimTK::State, the implementation is done in a separate internal c...
Includes internal headers providing declarations for the basic SimTK Core classes.
An EventReporter is an object that defines an event that can occur within a system.
Definition: EventReporter.h:53
virtual void handleEvent(const State &state) const =0
This method is invoked to handle the event.
This class is used to communicate between the System and an Integrator regarding the properties of a ...
Definition: Event.h:209
PeriodicEventReporter is a subclass of ScheduledEventReporter which generates a series of uniformly s...
Definition: EventReporter.h:138
Real getEventInterval() const
Get the time interval at which events occur.
Real getNextEventTime(const State &state, bool includeCurrentTime) const override
Get the next time at which an event will occur.
PeriodicEventReporter(Real eventInterval)
Create a PeriodicEventReporter.
void setEventInterval(Real eventInterval)
Set the time interval at which events occur.
ScheduledEventReporter is a subclass of EventReporter for events that occur at a particular time that...
Definition: EventReporter.h:72
virtual ~ScheduledEventReporter()
virtual Real getNextEventTime(const State &state, bool includeCurrentTime) const =0
Get the next time at which an event will occur.
This class is basically a glorified enumerated type, type-safe and range checked but permitting conve...
Definition: Stage.h:66
This object is intended to contain all state information for a SimTK::System, except topological info...
Definition: State.h:280
TriggeredEventReporter is a subclass of EventReporter for events that occur when some condition is sa...
Definition: EventReporter.h:96
virtual ~TriggeredEventReporter()
TriggeredEventReporter(Stage requiredStage)
Construct a new TriggeredEventReporter.
TriggeredEventReporter(const TriggeredEventReporter &clone)
Stage getRequiredStage() const
Get the stage at which the trigger function will be evaluated.
virtual Real getValue(const State &) const =0
Get the value of the event trigger function for a State.
EventTriggerInfo & getTriggerInfo()
Get an EventTriggerInfo object which can be used to customize when the event occurs.
TriggeredEventReporter & operator=(const TriggeredEventReporter &clone)
This is the top-level SimTK namespace into which all SimTK names are placed to avoid collision with o...
Definition: Assembler.h:37
SimTK_Real Real
This is the default compiled-in floating point type for SimTK, either float or double.
Definition: SimTKcommon/include/SimTKcommon/internal/common.h:607