#include <GenericEventHandler.hpp>
Static Public Member Functions | |
static GenericEventHandler < NUM_EVENTS, CONCRETE > * | Instance () |
static void | Reset () |
static void | BeginEvent (unsigned event) throw (Exception) |
static void | EndEvent (unsigned event) |
static double | GetElapsedTime (unsigned event) |
static void | Report () |
static void | Headings () |
static void | Enable () |
static void | Disable () |
static bool | IsEnabled () |
Protected Member Functions | |
GenericEventHandler () | |
Private Member Functions | |
double | GetWallTime () |
double | ConvertWallTimeToMilliseconds (double wallTime) |
double | ConvertWallTimeToSeconds (double wallTime) |
void | ResetImpl () |
void | BeginEventImpl (unsigned event) throw (Exception) |
void | EndEventImpl (unsigned event) |
double | GetElapsedTimeImpl (unsigned event) |
void | ReportImpl () |
void | HeadingsImpl () |
void | EnableImpl () |
void | DisableImpl () |
bool | IsEnabledImpl () |
Static Private Member Functions | |
static void | MilliSleep (unsigned milliseconds) |
Private Attributes | |
std::vector< double > | mWallTime |
std::vector< bool > | mHasBegun |
bool | mEnabled |
bool | mInUse |
Friends | |
class | TestGenericEventHandler |
class | TestCellBasedEventHandler |
class | TestHeartEventHandler |
Note: this class assume that, for any given concrete class, the last event represents the total time, and thus wraps all other events.
The methods in this class are not implemented separately as then they would not be inline, which could impact performance; we generally want timing routines to be very lightweight.
Definition at line 52 of file GenericEventHandler.hpp.
GenericEventHandler< NUM_EVENTS, CONCRETE >::GenericEventHandler | ( | ) | [inline, protected] |
Default constructor.
Definition at line 202 of file GenericEventHandler.hpp.
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::MilliSleep | ( | unsigned | milliseconds | ) | [inline, static, private] |
Sleep for a specified number of milliseconds Used in testing Ought to be more portable than sleep() or usleep().
milliseconds | minimim number of milliseconds for which to sleep (ought to be a multiple of 10) |
Definition at line 71 of file GenericEventHandler.hpp.
double GenericEventHandler< NUM_EVENTS, CONCRETE >::GetWallTime | ( | ) | [inline, private] |
Helper function - get the current wall clock time
Definition at line 82 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::BeginEventImpl(), GenericEventHandler< 13, HeartEventHandler >::EndEventImpl(), and GenericEventHandler< 13, HeartEventHandler >::GetElapsedTimeImpl().
double GenericEventHandler< NUM_EVENTS, CONCRETE >::ConvertWallTimeToMilliseconds | ( | double | wallTime | ) | [inline, private] |
Convert a wall clock time to milliseconds.
wallTime | the wall time |
Definition at line 92 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::GetElapsedTimeImpl().
double GenericEventHandler< NUM_EVENTS, CONCRETE >::ConvertWallTimeToSeconds | ( | double | wallTime | ) | [inline, private] |
Convert a wall clock time to seconds.
wallTime | the wall time |
Definition at line 102 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::ReportImpl().
static GenericEventHandler<NUM_EVENTS, CONCRETE>* GenericEventHandler< NUM_EVENTS, CONCRETE >::Instance | ( | ) | [inline, static] |
Get the singleton instance of the event handler.
Definition at line 111 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::BeginEvent(), GenericEventHandler< 13, HeartEventHandler >::Disable(), GenericEventHandler< 13, HeartEventHandler >::Enable(), GenericEventHandler< 13, HeartEventHandler >::EndEvent(), GenericEventHandler< 13, HeartEventHandler >::GetElapsedTime(), GenericEventHandler< 13, HeartEventHandler >::Headings(), GenericEventHandler< 13, HeartEventHandler >::IsEnabled(), GenericEventHandler< 13, HeartEventHandler >::Report(), and GenericEventHandler< 13, HeartEventHandler >::Reset().
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::Reset | ( | ) | [inline, static] |
Reset the event handler - set all event durations to zero.
Definition at line 120 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::ReportImpl().
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::BeginEvent | ( | unsigned | event | ) | throw (Exception) [inline, static] |
Record the start of an event.
event | the index of an event (this must be less than NUM_EVENTS) |
Definition at line 130 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::BeginEventImpl().
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::EndEvent | ( | unsigned | event | ) | [inline, static] |
Record the ending of an event.
event | the index of an event (this must be less than NUM_EVENTS) |
Definition at line 140 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::ReportImpl().
static double GenericEventHandler< NUM_EVENTS, CONCRETE >::GetElapsedTime | ( | unsigned | event | ) | [inline, static] |
Get the time (in milliseconds) accounted so far to the given event.
Will automatically determine if the event is currently ongoing or not.
event | the index of an event (this must be less than NUM_EVENTS) |
Definition at line 152 of file GenericEventHandler.hpp.
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::Report | ( | ) | [inline, static] |
Print a report on the timed events and reset the handler.
Assumes all events have ended.
If there is a collection of processes then the report will include an average and maximum over all CPUs.
Definition at line 165 of file GenericEventHandler.hpp.
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::Headings | ( | ) | [inline, static] |
Output the headings for a report.
Definition at line 173 of file GenericEventHandler.hpp.
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::Enable | ( | ) | [inline, static] |
Enable the event handler so that it will record event durations.
Definition at line 181 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::ResetImpl().
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::Disable | ( | ) | [inline, static] |
Disable the event handler, so that event durations are no longer recorded.
Definition at line 187 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::BeginEventImpl().
static bool GenericEventHandler< NUM_EVENTS, CONCRETE >::IsEnabled | ( | ) | [inline, static] |
Check whether the event handler is enabled.
Definition at line 193 of file GenericEventHandler.hpp.
void GenericEventHandler< NUM_EVENTS, CONCRETE >::ResetImpl | ( | ) | [inline, private] |
Reset the event handler - set all event durations to zero.
Definition at line 214 of file GenericEventHandler.hpp.
void GenericEventHandler< NUM_EVENTS, CONCRETE >::BeginEventImpl | ( | unsigned | event | ) | throw (Exception) [inline, private] |
Record the start of an event.
event | the index of an event (this must be less than NUM_EVENTS) |
Definition at line 230 of file GenericEventHandler.hpp.
void GenericEventHandler< NUM_EVENTS, CONCRETE >::EndEventImpl | ( | unsigned | event | ) | [inline, private] |
Record the ending of an event.
event | the index of an event (this must be less than NUM_EVENTS) |
Definition at line 270 of file GenericEventHandler.hpp.
double GenericEventHandler< NUM_EVENTS, CONCRETE >::GetElapsedTimeImpl | ( | unsigned | event | ) | [inline, private] |
Get the time (in milliseconds) accounted so far to the given event.
Will automatically determine if the event is currently ongoing or not.
event | the index of an event (this must be less than NUM_EVENTS) |
Definition at line 300 of file GenericEventHandler.hpp.
void GenericEventHandler< NUM_EVENTS, CONCRETE >::ReportImpl | ( | ) | [inline, private] |
Print a report on the timed events and reset the handler.
Assumes all events have ended.
If there is a collection of processes then the report will include an average and maximum over all CPUs.
Definition at line 327 of file GenericEventHandler.hpp.
void GenericEventHandler< NUM_EVENTS, CONCRETE >::HeadingsImpl | ( | ) | [inline, private] |
Output the headings for a report.
Definition at line 427 of file GenericEventHandler.hpp.
void GenericEventHandler< NUM_EVENTS, CONCRETE >::EnableImpl | ( | ) | [inline, private] |
Enable the event handler so that it will record event durations.
Definition at line 452 of file GenericEventHandler.hpp.
void GenericEventHandler< NUM_EVENTS, CONCRETE >::DisableImpl | ( | ) | [inline, private] |
Disable the event handler, so that event durations are no longer recorded.
Definition at line 458 of file GenericEventHandler.hpp.
bool GenericEventHandler< NUM_EVENTS, CONCRETE >::IsEnabledImpl | ( | ) | [inline, private] |
Check whether the event handler is enabled.
Definition at line 464 of file GenericEventHandler.hpp.
std::vector<double> GenericEventHandler< NUM_EVENTS, CONCRETE >::mWallTime [private] |
Wall time assigned to each event
Definition at line 59 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::BeginEventImpl(), GenericEventHandler< 13, HeartEventHandler >::EndEventImpl(), GenericEventHandler< 13, HeartEventHandler >::GenericEventHandler(), GenericEventHandler< 13, HeartEventHandler >::GetElapsedTimeImpl(), GenericEventHandler< 13, HeartEventHandler >::ReportImpl(), and GenericEventHandler< 13, HeartEventHandler >::ResetImpl().
std::vector<bool> GenericEventHandler< NUM_EVENTS, CONCRETE >::mHasBegun [private] |
Whether each event is in progress
Definition at line 60 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::BeginEventImpl(), GenericEventHandler< 13, HeartEventHandler >::EndEventImpl(), GenericEventHandler< 13, HeartEventHandler >::GenericEventHandler(), GenericEventHandler< 13, HeartEventHandler >::GetElapsedTimeImpl(), GenericEventHandler< 13, HeartEventHandler >::ReportImpl(), and GenericEventHandler< 13, HeartEventHandler >::ResetImpl().
bool GenericEventHandler< NUM_EVENTS, CONCRETE >::mEnabled [private] |
Whether the event handler is recording event times
Definition at line 61 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::BeginEventImpl(), GenericEventHandler< 13, HeartEventHandler >::DisableImpl(), GenericEventHandler< 13, HeartEventHandler >::EnableImpl(), GenericEventHandler< 13, HeartEventHandler >::EndEventImpl(), GenericEventHandler< 13, HeartEventHandler >::GenericEventHandler(), GenericEventHandler< 13, HeartEventHandler >::GetElapsedTimeImpl(), GenericEventHandler< 13, HeartEventHandler >::IsEnabledImpl(), and GenericEventHandler< 13, HeartEventHandler >::ReportImpl().
bool GenericEventHandler< NUM_EVENTS, CONCRETE >::mInUse [private] |
Determines if any of the event have begun
Definition at line 62 of file GenericEventHandler.hpp.
Referenced by GenericEventHandler< 13, HeartEventHandler >::BeginEventImpl(), GenericEventHandler< 13, HeartEventHandler >::GenericEventHandler(), GenericEventHandler< 13, HeartEventHandler >::ReportImpl(), and GenericEventHandler< 13, HeartEventHandler >::ResetImpl().