Simbody  3.7
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

◆ EventTriggerInfo() [1/3]

SimTK::EventTriggerInfo::EventTriggerInfo ( )

◆ EventTriggerInfo() [2/3]

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

◆ ~EventTriggerInfo()

SimTK::EventTriggerInfo::~EventTriggerInfo ( )

◆ EventTriggerInfo() [3/3]

SimTK::EventTriggerInfo::EventTriggerInfo ( const EventTriggerInfo )

Member Function Documentation

◆ operator=()

EventTriggerInfo& SimTK::EventTriggerInfo::operator= ( const EventTriggerInfo )

◆ getEventId()

EventId SimTK::EventTriggerInfo::getEventId ( ) const

◆ shouldTriggerOnRisingSignTransition()

bool SimTK::EventTriggerInfo::shouldTriggerOnRisingSignTransition ( ) const

◆ shouldTriggerOnFallingSignTransition()

bool SimTK::EventTriggerInfo::shouldTriggerOnFallingSignTransition ( ) const

◆ getRequiredLocalizationTimeWindow()

Real SimTK::EventTriggerInfo::getRequiredLocalizationTimeWindow ( ) const

◆ setEventId()

EventTriggerInfo& SimTK::EventTriggerInfo::setEventId ( EventId  )

◆ setTriggerOnRisingSignTransition()

EventTriggerInfo& SimTK::EventTriggerInfo::setTriggerOnRisingSignTransition ( bool  )

◆ setTriggerOnFallingSignTransition()

EventTriggerInfo& SimTK::EventTriggerInfo::setTriggerOnFallingSignTransition ( bool  )

◆ setRequiredLocalizationTimeWindow()

EventTriggerInfo& SimTK::EventTriggerInfo::setRequiredLocalizationTimeWindow ( Real  )

◆ calcTransitionMask()

Event::Trigger SimTK::EventTriggerInfo::calcTransitionMask ( ) const
inline

◆ calcTransitionToReport()

Event::Trigger SimTK::EventTriggerInfo::calcTransitionToReport ( Event::Trigger  transitionSeen) const
inline

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