Simbody  3.8
EventReporter.h
Go to the documentation of this file.
1 #ifndef SimTK_SimTKCOMMON_EVENT_REPORTER_H_
2 #define SimTK_SimTKCOMMON_EVENT_REPORTER_H_
3 
4 /* -------------------------------------------------------------------------- *
5  * Simbody(tm): SimTKcommon *
6  * -------------------------------------------------------------------------- *
7  * This is part of the SimTK biosimulation toolkit originating from *
8  * Simbios, the NIH National Center for Physics-Based Simulation of *
9  * Biological Structures at Stanford, funded under the NIH Roadmap for *
10  * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody. *
11  * *
12  * Portions copyright (c) 2007-12 Stanford University and the Authors. *
13  * Authors: Peter Eastman *
14  * Contributors: *
15  * *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may *
17  * not use this file except in compliance with the License. You may obtain a *
18  * copy of the License at http://www.apache.org/licenses/LICENSE-2.0. *
19  * *
20  * Unless required by applicable law or agreed to in writing, software *
21  * distributed under the License is distributed on an "AS IS" BASIS, *
22  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
23  * See the License for the specific language governing permissions and *
24  * limitations under the License. *
25  * -------------------------------------------------------------------------- */
26 
27 #include "SimTKcommon/basics.h"
28 #include "SimTKcommon/Simmatrix.h"
31 
32 namespace SimTK {
33 
54 public:
55  virtual ~EventReporter();
56 
62  virtual void handleEvent(const State& state) const = 0;
63 };
64 
73 public:
75 
84  virtual Real getNextEventTime(const State& state, bool includeCurrentTime) const = 0;
85 };
86 
97 public:
98  class TriggeredEventReporterImpl;
102 
109  explicit TriggeredEventReporter(Stage requiredStage);
110 
115  virtual Real getValue(const State&) const = 0;
116 
122 
128 private:
129  TriggeredEventReporterImpl* impl;
130 };
131 
139 public:
140  class PeriodicEventReporterImpl;
142  Real getNextEventTime(const State& state, bool includeCurrentTime) const override;
143 
149  explicit PeriodicEventReporter(Real eventInterval);
150 
156 
161  void setEventInterval(Real eventInterval);
162 private:
163  PeriodicEventReporterImpl* impl;
164 };
165 
166 } // namespace SimTK
167 
168 #endif // SimTK_SimTKCOMMON_EVENT_REPORTER_H_
#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 ~EventReporter()
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 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
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