1 #ifndef SimTK_SimTKCOMMON_EVENT_HANDLER_H_
2 #define SimTK_SimTKCOMMON_EVENT_HANDLER_H_
74 bool& shouldTerminate)
const = 0;
97 bool includeCurrentTime)
const = 0;
111 class TriggeredEventHandlerImpl;
140 TriggeredEventHandlerImpl* impl;
149 class PeriodicEventHandlerImpl;
171 PeriodicEventHandlerImpl* 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 EventHandler is an object that defines an event that can occur within a system.
Definition: EventHandler.h:51
virtual void handleEvent(State &state, Real accuracy, bool &shouldTerminate) 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
PeriodicEventHandler is a subclass of ScheduledEventHandler which generates a series of uniformly spa...
Definition: EventHandler.h:147
Real getNextEventTime(const State &state, bool includeCurrentTime) const override
Get the next time at which an event will occur.
Real getEventInterval() const
Get the time interval at which events occur.
PeriodicEventHandler(Real eventInterval)
Create a PeriodicEventHandler.
void setEventInterval(Real eventInterval)
Set the time interval at which events occur.
ScheduledEventHandler is a subclass of EventHandler for events that occur at a particular time that i...
Definition: EventHandler.h:84
virtual ~ScheduledEventHandler()
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
TriggeredEventHandler is a subclass of EventHandler for events that occur when some condition is sati...
Definition: EventHandler.h:109
EventTriggerInfo & getTriggerInfo()
Get an EventTriggerInfo object which can be used to customize when the event occurs.
TriggeredEventHandler(const TriggeredEventHandler &clone)
virtual Real getValue(const State &) const =0
Get the value of the event trigger function for a State.
Stage getRequiredStage() const
Get the stage at which the trigger function will be evaluated.
TriggeredEventHandler(Stage requiredStage)
Construct a new TriggeredEventHandler.
TriggeredEventHandler & operator=(const TriggeredEventHandler &clone)
virtual ~TriggeredEventHandler()
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