ScheduledEventReporter Class Reference

#include <EventReporter.h>

Inheritance diagram for ScheduledEventReporter:

EventReporter PeriodicEventReporter List of all members.

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.


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.


Constructor & Destructor Documentation

virtual ~ScheduledEventReporter (  )  [virtual]


Member Function Documentation

virtual Real 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 PeriodicEventReporter.


The documentation for this class was generated from the following file:
Generated on Thu Feb 28 01:34:36 2008 for SimTKcommon by  doxygen 1.4.7