Simbody
|
00001 #ifndef SimTK_SimTKCOMMON_EVENT_REPORTER_H_ 00002 #define SimTK_SimTKCOMMON_EVENT_REPORTER_H_ 00003 00004 /* -------------------------------------------------------------------------- * 00005 * SimTK Core: SimTKcommon * 00006 * -------------------------------------------------------------------------- * 00007 * This is part of the SimTK Core biosimulation toolkit originating from * 00008 * Simbios, the NIH National Center for Physics-Based Simulation of * 00009 * Biological Structures at Stanford, funded under the NIH Roadmap for * 00010 * Medical Research, grant U54 GM072970. See https://simtk.org. * 00011 * * 00012 * Portions copyright (c) 2007 Stanford University and the Authors. * 00013 * Authors: Peter Eastman * 00014 * Contributors: * 00015 * * 00016 * Permission is hereby granted, free of charge, to any person obtaining a * 00017 * copy of this software and associated documentation files (the "Software"), * 00018 * to deal in the Software without restriction, including without limitation * 00019 * the rights to use, copy, modify, merge, publish, distribute, sublicense, * 00020 * and/or sell copies of the Software, and to permit persons to whom the * 00021 * Software is furnished to do so, subject to the following conditions: * 00022 * * 00023 * The above copyright notice and this permission notice shall be included in * 00024 * all copies or substantial portions of the Software. * 00025 * * 00026 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * 00027 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * 00028 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * 00029 * THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 00030 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 00031 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE * 00032 * USE OR OTHER DEALINGS IN THE SOFTWARE. * 00033 * -------------------------------------------------------------------------- */ 00034 00035 #include "SimTKcommon/basics.h" 00036 #include "SimTKcommon/Simmatrix.h" 00037 #include "SimTKcommon/internal/State.h" 00038 #include "SimTKcommon/internal/System.h" 00039 00040 namespace SimTK { 00041 00061 class SimTK_SimTKCOMMON_EXPORT EventReporter { 00062 public: 00063 virtual ~EventReporter(); 00064 00070 virtual void handleEvent(const State& state) const = 0; 00071 }; 00072 00080 class SimTK_SimTKCOMMON_EXPORT ScheduledEventReporter : public EventReporter { 00081 public: 00082 virtual ~ScheduledEventReporter(); 00083 00092 virtual Real getNextEventTime(const State& state, bool includeCurrentTime) const = 0; 00093 }; 00094 00104 class SimTK_SimTKCOMMON_EXPORT TriggeredEventReporter : public EventReporter { 00105 public: 00106 class TriggeredEventReporterImpl; 00107 TriggeredEventReporter(const TriggeredEventReporter& clone); 00108 TriggeredEventReporter& operator=(const TriggeredEventReporter& clone); 00109 virtual ~TriggeredEventReporter(); 00110 00117 TriggeredEventReporter(Stage requiredStage); 00118 00123 virtual Real getValue(const State&) const = 0; 00124 00129 EventTriggerInfo& getTriggerInfo(); 00130 00135 Stage getRequiredStage() const; 00136 private: 00137 TriggeredEventReporterImpl* impl; 00138 }; 00139 00146 class SimTK_SimTKCOMMON_EXPORT PeriodicEventReporter : public ScheduledEventReporter { 00147 public: 00148 class PeriodicEventReporterImpl; 00149 ~PeriodicEventReporter(); 00150 Real getNextEventTime(const State& state, bool includeCurrentTime) const; 00151 00158 PeriodicEventReporter(Real eventInterval); 00159 00164 Real getEventInterval() const; 00165 00170 void setEventInterval(Real eventInterval); 00171 private: 00172 PeriodicEventReporterImpl* impl; 00173 }; 00174 00175 } // namespace SimTK 00176 00177 #endif // SimTK_SimTKCOMMON_EVENT_REPORTER_H_