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...

#include <System.h>

List of all members.

Public Member Functions
	EventTriggerInfo ()
	EventTriggerInfo (EventId eventId)
	~EventTriggerInfo ()
	EventTriggerInfo (const EventTriggerInfo &)
EventTriggerInfo &	operator= (const EventTriggerInfo &)
EventId	getEventId () const
bool	shouldTriggerOnRisingSignTransition () const
bool	shouldTriggerOnFallingSignTransition () const
Real	getRequiredLocalizationTimeWindow () const
EventTriggerInfo &	setEventId (EventId)
EventTriggerInfo &	setTriggerOnRisingSignTransition (bool)
EventTriggerInfo &	setTriggerOnFallingSignTransition (bool)
EventTriggerInfo &	setRequiredLocalizationTimeWindow (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

(

)

EventTriggerInfo

(

EventId

eventId

)

[explicit]

~EventTriggerInfo

(

)

EventTriggerInfo

(

const EventTriggerInfo &

)

---

Member Function Documentation

Event::Trigger calcTransitionMask

(

)

const [inline]

References Event::NegativeToPositive, and Event::PositiveToNegative.

Event::Trigger calcTransitionToReport

(

Event::Trigger

transitionSeen

)

const [inline]

References Event::Falling, Event::NegativeToPositive, Event::NoEventTrigger, Event::PositiveToNegative, and Event::Rising.

EventId getEventId

(

)

const

Real getRequiredLocalizationTimeWindow

(

)

const

EventTriggerInfo& operator=

(

const EventTriggerInfo &

)

EventTriggerInfo& setEventId

(

EventId

)

EventTriggerInfo& setRequiredLocalizationTimeWindow

(

Real

)

EventTriggerInfo& setTriggerOnFallingSignTransition

(

bool

)

EventTriggerInfo& setTriggerOnRisingSignTransition

(

bool

)

bool shouldTriggerOnFallingSignTransition

(

)

const

bool shouldTriggerOnRisingSignTransition

(

)

const

---

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

• System.h