SimTK::TriggeredEventReporter Class Reference

TriggeredEventReporter is a subclass of EventReporter for events that occur when some condition is satisfied within the system. More...

#include <EventReporter.h>

Inheritance diagram for SimTK::TriggeredEventReporter:

List of all members.

Public Member Functions
	TriggeredEventReporter (const TriggeredEventReporter &clone)
TriggeredEventReporter &	operator= (const TriggeredEventReporter &clone)
virtual	~TriggeredEventReporter ()
	TriggeredEventReporter (Stage requiredStage)
	Construct a new TriggeredEventReporter.
virtual Real	getValue (const State &) const =0
	Get the value of the event trigger function for a State.
EventTriggerInfo &	getTriggerInfo ()
	Get an EventTriggerInfo object which can be used to customize when the event occurs.
Stage	getRequiredStage () const
	Get the stage at which the trigger function will be evaluated.

---

Detailed Description

TriggeredEventReporter is a subclass of EventReporter for events that occur when some condition is satisfied within the system.

This is implemented by means of an "event trigger function". For any State, the handler must be able to calculate the value of the function. When it passes through 0, that indicates the event has occurred. You can also customize when the event is triggered, for example to specify that it is only triggered when the function goes from negative to positive, not when it goes from positive to negative.

---

Constructor & Destructor Documentation

SimTK::TriggeredEventReporter::TriggeredEventReporter

(

const TriggeredEventReporter &

clone

)

virtual SimTK::TriggeredEventReporter::~TriggeredEventReporter

(

)

[virtual]

SimTK::TriggeredEventReporter::TriggeredEventReporter

(

Stage

requiredStage

)

Construct a new TriggeredEventReporter.

Parameters:

requiredStage

the stage at which the trigger function will be evaluated

---

Member Function Documentation

TriggeredEventReporter& SimTK::TriggeredEventReporter::operator=

(

const TriggeredEventReporter &

clone

)

virtual Real SimTK::TriggeredEventReporter::getValue

(

const State &

)

const [pure virtual]

Get the value of the event trigger function for a State.

EventTriggerInfo& SimTK::TriggeredEventReporter::getTriggerInfo

(

)

Get an EventTriggerInfo object which can be used to customize when the event occurs.

Stage SimTK::TriggeredEventReporter::getRequiredStage

(

)

const

Get the stage at which the trigger function will be evaluated.

---

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

• EventReporter.h