1 #ifndef SimTK_SimTKCOMMON_EVENT_H_ 2 #define SimTK_SimTKCOMMON_EVENT_H_ 140 operator Num()
const {
return value;}
193 return Trigger(transition & mask);
218 bool shouldTriggerOnRisingSignTransition()
const;
219 bool shouldTriggerOnFallingSignTransition()
const;
220 Real getRequiredLocalizationTimeWindow()
const;
230 if (shouldTriggerOnRisingSignTransition()) {
233 if (shouldTriggerOnFallingSignTransition()) {
247 assert(!
"impossible event transition situation");
252 class EventTriggerInfoRep;
255 EventTriggerInfoRep* rep;
257 const EventTriggerInfoRep& getRep()
const {assert(rep);
return *rep;}
258 EventTriggerInfoRep& updRep() {assert(rep);
return *rep;}
280 UseInfinityNorm = 0x0002
286 { clear(); setAccuracy(accuracy); }
288 { clear(); setOption(opt); }
294 { optionSet=0; setAccuracyDefaults();
return *
this; }
300 assert(accuracy > 0);
301 requiredAccuracy = accuracy;
308 { optionSet &= ~(unsigned)opt;
return *
this; }
312 { optionSet |= (unsigned)opt;
return *
this; }
323 { optionSet |= opts.optionSet;
return *
this; }
325 { optionSet &= opts.optionSet;
return *
this; }
327 { optionSet &= ~opts.optionSet;
return *
this; }
333 Real requiredAccuracy;
336 void setAccuracyDefaults() {
337 requiredAccuracy = getDefaultAccuracy();
369 m_anyChangeMade =
false;
378 { assert(
isValid());
return m_anyChangeMade; }
380 { assert(
isValid());
return m_lowestModifiedStage; }
382 { assert(
isValid());
return m_message; }
385 { m_exitStatus=status;
return *
this; }
387 { m_anyChangeMade=changeMade;
return *
this; }
389 { m_lowestModifiedStage=stage;
return *
this; }
391 { m_message=message;
return *
this; }
394 bool m_anyChangeMade;
395 Stage m_lowestModifiedStage;
401 #endif // SimTK_SimTKCOMMON_EVENT_H_ #define SimTK_SimTKCOMMON_EXPORT
Definition: SimTKcommon/include/SimTKcommon/internal/common.h:224
Trigger
Triggered Events respond to zero crossings of their associated trigger function.
Definition: Event.h:158
SimTK_DEFINE_UNIQUE_INDEX_TYPE(AssemblyConditionIndex)
Status getExitStatus() const
Definition: Event.h:375
HandleEventsOptions & operator-=(const HandleEventsOptions &opts)
Definition: Event.h:326
This is the top-level SimTK namespace into which all SimTK names are placed to avoid collision with o...
Definition: Assembler.h:37
static std::string eventTriggerString(Trigger)
This is useful for debugging; it translates an Event::Trigger or a mask formed by a union of Event::T...
static Trigger classifyTransition(int before, int after)
Classify a before/after sign transition.
Definition: Event.h:177
This class is basically a glorified enumerated type, type-safe and range checked but permitting conve...
Definition: Stage.h:66
HandleEventsOptions & setAccuracy(Real accuracy)
The norm of the constraint errors must be driven to below this value for a project() to be considered...
Definition: Event.h:299
bool getAnyChangeMade() const
Definition: Event.h:377
HandleEventsResults & setExitStatus(Status status)
Definition: Event.h:384
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:606
HandleEventsOptions & clearOption(Option opt)
Remove a given option from the set.
Definition: Event.h:307
HandleEventsResults & setMessage(const String &message)
Definition: Event.h:390
bool isValid() const
Definition: Event.h:374
HandleEventsOptions & setOption(Option opt)
Select a given option from the set.
Definition: Event.h:311
An Event is "something that happens" during a Study that is advancing through time.
Definition: Event.h:76
Num
Definition: Event.h:128
HandleEventsResults & setAnyChangeMade(bool changeMade)
Definition: Event.h:386
Event::Trigger calcTransitionMask() const
Definition: Event.h:228
These are all the possible causes for events.
Definition: Event.h:126
HandleEventsOptions & operator-=(Option opt)
Definition: Event.h:330
Option
Definition: Event.h:271
HandleEventsOptions & clear()
Restore this object to its default-constructed state (no options selected, default accuracy)...
Definition: Event.h:293
HandleEventsOptions & operator|=(Option opt)
Definition: Event.h:329
HandleEventsOptions & operator|=(const HandleEventsOptions &opts)
Definition: Event.h:322
Cause()
Definition: Event.h:138
HandleEventsOptions()
Definition: Event.h:284
static const char * getCauseName(Cause)
This is useful for debugging; it translates an Event::Cause into a readable string.
bool isValid() const
Definition: Event.h:143
Higher than any legitimate Stage.
Definition: Stage.h:79
const Real Infinity
This is the IEEE positive infinity constant for this implementation of the default-precision Real typ...
HandleEventsResults & clear()
Restore this object to its default-constructed state, with the return status set to Invalid...
Definition: Event.h:367
HandleEventsResults()
Definition: Event.h:347
bool isOptionSet(Option opt) const
Definition: Event.h:317
SimTK::String is a plug-compatible std::string replacement (plus some additional functionality) inten...
Definition: String.h:62
static Trigger maskTransition(Trigger transition, Trigger mask)
Given an observed transition, weed out ignorable ones using the supplied mask.
Definition: Event.h:191
Cause(Num n)
Definition: Event.h:139
Status
Definition: Event.h:349
This class is used to communicate between the System and an Integrator regarding the properties of a ...
Definition: Event.h:209
Real getAccuracy() const
Return the current value for the accuracy option.
Definition: Event.h:315
Results returned by the handleEvent() method.
Definition: Event.h:345
HandleEventsOptions(Option opt)
Definition: Event.h:287
Includes internal headers providing declarations for the basic SimTK Core classes.
const String & getMessage() const
Definition: Event.h:381
HandleEventsOptions(Real accuracy)
Definition: Event.h:285
Stage getLowestModifiedStage() const
Definition: Event.h:379
Cause & operator=(Num n)
Definition: Event.h:141
HandleEventsResults & setLowestModifiedStage(Stage stage)
Definition: Event.h:388
static Real getDefaultAccuracy()
Definition: Event.h:319
Options for the handleEvent() method.
Definition: Event.h:269
This is a class to represent unique IDs for events in a type-safe way.