GenericEventHandler< NUM_EVENTS, CONCRETE > Class Template Reference

#include <GenericEventHandler.hpp>

Collaboration diagram for GenericEventHandler< NUM_EVENTS, CONCRETE >:
Collaboration graph
[legend]

List of all members.

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

Detailed Description

template<unsigned NUM_EVENTS, class CONCRETE>
class GenericEventHandler< NUM_EVENTS, CONCRETE >

A generic base class providing the functionality for timing various events. Subclasses provide the event codes and names; see HeartEventHandler for an example.

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 58 of file GenericEventHandler.hpp.

Constructor & Destructor Documentation

template<unsigned NUM_EVENTS, class CONCRETE>
GenericEventHandler< NUM_EVENTS, CONCRETE >::GenericEventHandler (  )  [inline, protected]

Default constructor.

Definition at line 215 of file GenericEventHandler.hpp.

Member Function Documentation

template<unsigned NUM_EVENTS, class CONCRETE>
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::BeginEvent ( unsigned  event  )  throw (Exception) [inline, static]

Record the start of an event.

Parameters:
event the index of an event (this must be less than NUM_EVENTS)

Definition at line 140 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::BeginEventImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
void GenericEventHandler< NUM_EVENTS, CONCRETE >::BeginEventImpl ( unsigned  event  )  throw (Exception) [inline, private]

Record the start of an event.

Parameters:
event the index of an event (this must be less than NUM_EVENTS)

Definition at line 244 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
double GenericEventHandler< NUM_EVENTS, CONCRETE >::ConvertWallTimeToMilliseconds ( double  wallTime  )  [inline, private]

Convert a wall clock time to milliseconds.

Parameters:
wallTime the wall time
Returns:
time in milliseconds.

Definition at line 100 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::GetElapsedTimeImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
double GenericEventHandler< NUM_EVENTS, CONCRETE >::ConvertWallTimeToSeconds ( double  wallTime  )  [inline, private]

Convert a wall clock time to seconds. (Identity function in this implementation.)

Parameters:
wallTime the wall time
Returns:
Time in seconds

Definition at line 111 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::ReportImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::Disable (  )  [inline, static]

Disable the event handler, so that event durations are no longer recorded.

Definition at line 197 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::BeginEventImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
void GenericEventHandler< NUM_EVENTS, CONCRETE >::DisableImpl (  )  [inline, private]

Disable the event handler, so that event durations are no longer recorded.

Definition at line 468 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::Enable (  )  [inline, static]

Enable the event handler so that it will record event durations.

Definition at line 191 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::ResetImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
void GenericEventHandler< NUM_EVENTS, CONCRETE >::EnableImpl (  )  [inline, private]

Enable the event handler so that it will record event durations.

Definition at line 462 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::EndEvent ( unsigned  event  )  [inline, static]

Record the ending of an event.

Parameters:
event the index of an event (this must be less than NUM_EVENTS)

Definition at line 150 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::ReportImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
void GenericEventHandler< NUM_EVENTS, CONCRETE >::EndEventImpl ( unsigned  event  )  [inline, private]

Record the ending of an event.

Parameters:
event the index of an event (this must be less than NUM_EVENTS)

Definition at line 284 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
static double GenericEventHandler< NUM_EVENTS, CONCRETE >::GetElapsedTime ( unsigned  event  )  [inline, static]
Returns:
The time (in milliseconds) accounted so far to the given event.

Will automatically determine if the event is currently ongoing or not.

Parameters:
event the index of an event (this must be less than NUM_EVENTS)

Definition at line 162 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
double GenericEventHandler< NUM_EVENTS, CONCRETE >::GetElapsedTimeImpl ( unsigned  event  )  [inline, private]
Returns:
The time (in milliseconds) accounted so far to the given event.

Will automatically determine if the event is currently ongoing or not.

Parameters:
event the index of an event (this must be less than NUM_EVENTS)

Definition at line 314 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
double GenericEventHandler< NUM_EVENTS, CONCRETE >::GetWallTime (  )  [inline, private]

Helper function -

Returns:
the current wall clock time.

Definition at line 89 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::BeginEventImpl(), GenericEventHandler< 11, MeshEventHandler >::EndEventImpl(), and GenericEventHandler< 11, MeshEventHandler >::GetElapsedTimeImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::Headings (  )  [inline, static]

Output the headings for a report.

Definition at line 183 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
void GenericEventHandler< NUM_EVENTS, CONCRETE >::HeadingsImpl (  )  [inline, private]

Output the headings for a report.

Definition at line 439 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
static GenericEventHandler<NUM_EVENTS, CONCRETE>* GenericEventHandler< NUM_EVENTS, CONCRETE >::Instance (  )  [inline, static]
Returns:
Get the singleton instance of the event handler.

Definition at line 121 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::BeginEvent(), GenericEventHandler< 11, MeshEventHandler >::Disable(), GenericEventHandler< 11, MeshEventHandler >::Enable(), GenericEventHandler< 11, MeshEventHandler >::EndEvent(), GenericEventHandler< 11, MeshEventHandler >::GetElapsedTime(), GenericEventHandler< 11, MeshEventHandler >::Headings(), GenericEventHandler< 11, MeshEventHandler >::IsEnabled(), GenericEventHandler< 11, MeshEventHandler >::Report(), and GenericEventHandler< 11, MeshEventHandler >::Reset().

template<unsigned NUM_EVENTS, class CONCRETE>
static bool GenericEventHandler< NUM_EVENTS, CONCRETE >::IsEnabled (  )  [inline, static]

Check whether the event handler is enabled.

Returns:
true if enabled

Definition at line 205 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
bool GenericEventHandler< NUM_EVENTS, CONCRETE >::IsEnabledImpl (  )  [inline, private]

Check whether the event handler is enabled.

Returns:
true if enabled

Definition at line 476 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
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().

Parameters:
milliseconds minimim number of milliseconds for which to sleep (ought to be a multiple of 10)

Definition at line 78 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
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 175 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
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 341 of file GenericEventHandler.hpp.

template<unsigned NUM_EVENTS, class CONCRETE>
static void GenericEventHandler< NUM_EVENTS, CONCRETE >::Reset (  )  [inline, static]

Reset the event handler - set all event durations to zero.

Definition at line 130 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::ReportImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
void GenericEventHandler< NUM_EVENTS, CONCRETE >::ResetImpl (  )  [inline, private]

Reset the event handler - set all event durations to zero.

Definition at line 228 of file GenericEventHandler.hpp.

Member Data Documentation

template<unsigned NUM_EVENTS, class CONCRETE>
bool GenericEventHandler< NUM_EVENTS, CONCRETE >::mEnabled [private]

Whether the event handler is recording event times

Definition at line 68 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::BeginEventImpl(), GenericEventHandler< 11, MeshEventHandler >::DisableImpl(), GenericEventHandler< 11, MeshEventHandler >::EnableImpl(), GenericEventHandler< 11, MeshEventHandler >::EndEventImpl(), GenericEventHandler< 11, MeshEventHandler >::GenericEventHandler(), GenericEventHandler< 11, MeshEventHandler >::GetElapsedTimeImpl(), GenericEventHandler< 11, MeshEventHandler >::IsEnabledImpl(), and GenericEventHandler< 11, MeshEventHandler >::ReportImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
std::vector<bool> GenericEventHandler< NUM_EVENTS, CONCRETE >::mHasBegun [private]

Whether each event is in progress

Definition at line 67 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::BeginEventImpl(), GenericEventHandler< 11, MeshEventHandler >::EndEventImpl(), GenericEventHandler< 11, MeshEventHandler >::GenericEventHandler(), GenericEventHandler< 11, MeshEventHandler >::GetElapsedTimeImpl(), GenericEventHandler< 11, MeshEventHandler >::ReportImpl(), and GenericEventHandler< 11, MeshEventHandler >::ResetImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
bool GenericEventHandler< NUM_EVENTS, CONCRETE >::mInUse [private]

Determines if any of the event have begun

Definition at line 69 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::BeginEventImpl(), GenericEventHandler< 11, MeshEventHandler >::GenericEventHandler(), GenericEventHandler< 11, MeshEventHandler >::ReportImpl(), and GenericEventHandler< 11, MeshEventHandler >::ResetImpl().

template<unsigned NUM_EVENTS, class CONCRETE>
std::vector<double> GenericEventHandler< NUM_EVENTS, CONCRETE >::mWallTime [private]

Wall time assigned to each event

Definition at line 66 of file GenericEventHandler.hpp.

Referenced by GenericEventHandler< 11, MeshEventHandler >::BeginEventImpl(), GenericEventHandler< 11, MeshEventHandler >::EndEventImpl(), GenericEventHandler< 11, MeshEventHandler >::GenericEventHandler(), GenericEventHandler< 11, MeshEventHandler >::GetElapsedTimeImpl(), GenericEventHandler< 11, MeshEventHandler >::ReportImpl(), and GenericEventHandler< 11, MeshEventHandler >::ResetImpl().

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2