SimTK::ScheduledEventReporter Class Reference

ScheduledEventReporter is a subclass of EventReporter for events that occur at a particular time that is known in advance. More...

#include <EventReporter.h>

Inheritance diagram for SimTK::ScheduledEventReporter:

List of all members.

Public Member Functions
virtual	~ScheduledEventReporter ()
virtual Real	getNextEventTime (const State &state, bool includeCurrentTime) const =0
	Get the next time at which an event will occur.

---

Detailed Description

ScheduledEventReporter is a subclass of EventReporter for events that occur at a particular time that is known in advance.

This includes events that occur multiple times. The only requirement is that, at any time, it must be able to report the next time at which an event will occur.

---

Constructor & Destructor Documentation

virtual SimTK::ScheduledEventReporter::~ScheduledEventReporter

(

)

[virtual]

---

Member Function Documentation

virtual Real SimTK::ScheduledEventReporter::getNextEventTime	(	const State &	state,
		bool	includeCurrentTime
	)		const [pure virtual]

Get the next time at which an event will occur.

Parameters:

state	the current state of the system
includeCurrentTime	if true, return the next event whose time is >= the current time. If false, only return events after (not at) the current time.

Implemented in SimTK::PeriodicEventReporter.

---

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

• EventReporter.h