Simbody  3.5
SimTK::EventTriggerInfo Class Reference

This class is used to communicate between the System and an Integrator regarding the properties of a particular event trigger function. More...

Public Member Functions

 EventTriggerInfo ()
 
 EventTriggerInfo (EventId eventId)
 
 ~EventTriggerInfo ()
 
 EventTriggerInfo (const EventTriggerInfo &)
 
EventTriggerInfooperator= (const EventTriggerInfo &)
 
EventId getEventId () const
 
bool shouldTriggerOnRisingSignTransition () const
 
bool shouldTriggerOnFallingSignTransition () const
 
Real getRequiredLocalizationTimeWindow () const
 
EventTriggerInfosetEventId (EventId)
 
EventTriggerInfosetTriggerOnRisingSignTransition (bool)
 
EventTriggerInfosetTriggerOnFallingSignTransition (bool)
 
EventTriggerInfosetRequiredLocalizationTimeWindow (Real)
 
Event::Trigger calcTransitionMask () const
 
Event::Trigger calcTransitionToReport (Event::Trigger transitionSeen) const
 

Detailed Description

This class is used to communicate between the System and an Integrator regarding the properties of a particular event trigger function.

Currently these are:

  • Whether to watch for rising sign transitions, falling, or both. [BOTH]
  • Whether to watch for transitions to and from zero. [NO]
  • The localization window in units of the System's timescale. [10%] (That is then the "unit" window which is reduced by the accuracy setting.)

The default values are shown in brackets above.

Constructor & Destructor Documentation

SimTK::EventTriggerInfo::EventTriggerInfo ( )
SimTK::EventTriggerInfo::EventTriggerInfo ( EventId  eventId)
explicit
SimTK::EventTriggerInfo::~EventTriggerInfo ( )
SimTK::EventTriggerInfo::EventTriggerInfo ( const EventTriggerInfo )

Member Function Documentation

EventTriggerInfo& SimTK::EventTriggerInfo::operator= ( const EventTriggerInfo )
EventId SimTK::EventTriggerInfo::getEventId ( ) const
bool SimTK::EventTriggerInfo::shouldTriggerOnRisingSignTransition ( ) const
bool SimTK::EventTriggerInfo::shouldTriggerOnFallingSignTransition ( ) const
Real SimTK::EventTriggerInfo::getRequiredLocalizationTimeWindow ( ) const
EventTriggerInfo& SimTK::EventTriggerInfo::setEventId ( EventId  )
EventTriggerInfo& SimTK::EventTriggerInfo::setTriggerOnRisingSignTransition ( bool  )
EventTriggerInfo& SimTK::EventTriggerInfo::setTriggerOnFallingSignTransition ( bool  )
EventTriggerInfo& SimTK::EventTriggerInfo::setRequiredLocalizationTimeWindow ( Real  )
Event::Trigger SimTK::EventTriggerInfo::calcTransitionMask ( ) const
inline
Event::Trigger SimTK::EventTriggerInfo::calcTransitionToReport ( Event::Trigger  transitionSeen) const
inline

The documentation for this class was generated from the following file: