Profiler Class Reference

#include <Profiler.h>

Collaboration diagram for Profiler:

Collaboration graph
[legend]
List of all members.

Detailed Description

Profile point instance class.

Construct one of these on the stack at the start of a function, in order to record the time consumed within that function. The profiler object should be effectively optimised out if NO_TIMING is defined, so any overhead in a release build should be negligible so long as you remember to define that.

Definition at line 86 of file Profiler.h.

Public Member Functions

 Profiler (const char *name, bool showOnDestruct=false)
 Create a profile point instance that records time consumed against the given profiling point name.
 ~Profiler ()
void update () const

Protected Attributes

const char * m_c
clock_t m_startCPU
RealTime m_startTime
bool m_showOnDestruct


Constructor & Destructor Documentation

Profiler::Profiler ( const char *  name,
bool  showOnDestruct = false 
)

Create a profile point instance that records time consumed against the given profiling point name.

If showOnDestruct is true, the time consumed will be printed to stderr when the object is destroyed; otherwise, only the accumulated, mean and worst-case times will be shown when the program exits or Profiles::dump() is called.

Definition at line 178 of file Profiler.cpp.

References RealTime::fromTimeval(), m_startCPU, and m_startTime.

Profiler::~Profiler (  ) 

Definition at line 203 of file Profiler.cpp.

References Profiles::accumulate(), RealTime::fromTimeval(), Profiles::getInstance(), m_c, m_showOnDestruct, m_startCPU, and m_startTime.


Member Function Documentation

void Profiler::update (  )  const

Definition at line 190 of file Profiler.cpp.

References RealTime::fromTimeval(), m_c, m_startCPU, and m_startTime.


Member Data Documentation

const char* Profiler::m_c [protected]

Definition at line 103 of file Profiler.h.

Referenced by update(), and ~Profiler().

clock_t Profiler::m_startCPU [protected]

Definition at line 104 of file Profiler.h.

Referenced by Profiler(), update(), and ~Profiler().

RealTime Profiler::m_startTime [protected]

Definition at line 105 of file Profiler.h.

Referenced by Profiler(), update(), and ~Profiler().

bool Profiler::m_showOnDestruct [protected]

Definition at line 106 of file Profiler.h.

Referenced by ~Profiler().


The documentation for this class was generated from the following files:
Generated on Wed Feb 20 15:45:35 2008 for SonicVisualiser by  doxygen 1.5.1