Auxilliary class. More...

#include <src/components/TimerForSequencer.h>

Collaboration diagram for TimerForSequencer:

Public Member Functions
	TimerForSequencer (std::string name, unsigned int size, double factor)
	Constructor. More...

	~TimerForSequencer ()=default

void	start ()
	Start a time measurement. More...

double	stop ()
	Stop time measurement and return the last elapsed time. More...

const std::string &	name () const
	returns the name More...

double	lastTime () const
	returns the last measured time More...

double	lastCpu () const
	returns the last measured time More...

double	elapsedTotal () const
	returns the total elapsed time More...

double	cpuTotal () const
	returns the total cpu time More...

double	count () const
	Returns the number run count. More...

MsgStream &	fillStream (MsgStream &s) const
	Write measured time into the message stream. More...

Static Public Member Functions
static std::string	header (std::string::size_type size)
	header matching the previous format More...

Private Attributes
std::string	m_name

unsigned int	m_size

double	m_factor

long long	m_startClock = 0LL

long long	m_startCpu = 0LL

long long	m_num = 0LL

double	m_lastTime = 0.

double	m_lastCpu = 0.

double	m_min = 0.

double	m_max = 0.

double	m_sum = 0.

double	m_sumCpu = 0.

Detailed Description

Auxilliary class.

Measure the time between start and stop, and compute average, min and max. In fact, measure the cpu time, and the elapsed time but givesmin/max only for elapsed.

Author: O.Callot

Definition at line 13 of file TimerForSequencer.h.

Constructor & Destructor Documentation

TimerForSequencer::TimerForSequencer	(	std::string	name,
		unsigned int	size,
		double	factor
	)

inline

Constructor.

Specify the name, for later printing.

Definition at line 19 of file TimerForSequencer.h.

     : m_name     ( std::move(name) ),
       m_size     ( size ),
       m_factor   ( factor )
   { }

TimerForSequencer::~TimerForSequencer ( )

default

Member Function Documentation

double TimerForSequencer::count ( ) const

inline

Returns the number run count.

Definition at line 57 of file TimerForSequencer.h.

57 { return m_num; }

TimerForSequencer::m_num

long long m_num

Definition: TimerForSequencer.h:73

double TimerForSequencer::cpuTotal ( ) const

inline

returns the total cpu time

Definition at line 54 of file TimerForSequencer.h.

54 { return m_sumCpu; }

TimerForSequencer::m_sumCpu

double m_sumCpu

Definition: TimerForSequencer.h:79

double TimerForSequencer::elapsedTotal ( ) const

inline

returns the total elapsed time

Definition at line 51 of file TimerForSequencer.h.

51 { return m_sum; }

TimerForSequencer::m_sum

double m_sum

Definition: TimerForSequencer.h:78

MsgStream & TimerForSequencer::fillStream ( MsgStream & s ) const

Write measured time into the message stream.

Definition at line 39 of file TimerForSequencer.cpp.

 {
   double ave = 0.;
   double cpu = 0.;
 
   if ( 0 != m_num )
   {
     ave = m_sum    / m_num;
     cpu = m_sumCpu / m_num;
   }
 
   return s << m_name.substr(0,m_size)
            << format( "| %9.3f | %9.3f | %8.3f %9.1f | %7d | %9.3f |",
                       cpu, ave, m_min, m_max, m_num, m_sum * 0.001 );
 }

std::string TimerForSequencer::header ( std::string::size_type size )

static

header matching the previous format

Definition at line 55 of file TimerForSequencer.cpp.

 {
   return  "Algorithm" + std::string( std::max(std::string::size_type(21),size) - 20, ' ' )
         + "(millisec) |    <user> |   <clock> |" 
         + "      min       max | entries | total (s) |";
 }

double TimerForSequencer::lastCpu ( ) const

inline

returns the last measured time

Definition at line 48 of file TimerForSequencer.h.

48 { return m_lastCpu; }

TimerForSequencer::m_lastCpu

double m_lastCpu

Definition: TimerForSequencer.h:75

double TimerForSequencer::lastTime ( ) const

inline

returns the last measured time

Definition at line 45 of file TimerForSequencer.h.

45 { return m_lastTime; }

TimerForSequencer::m_lastTime

double m_lastTime

Definition: TimerForSequencer.h:74

const std::string& TimerForSequencer::name ( ) const

inline

returns the name

Definition at line 42 of file TimerForSequencer.h.

42 { return m_name; }

TimerForSequencer::m_name

std::string m_name

Definition: TimerForSequencer.h:67

void TimerForSequencer::start ( )

inline

Start a time measurement.

Definition at line 30 of file TimerForSequencer.h.

   {
     m_startClock = System::currentTime( System::microSec );
     m_startCpu   = System::cpuTime    ( System::microSec );
   }

double TimerForSequencer::stop ( )

Stop time measurement and return the last elapsed time.

Returns: Measured time in ms

Definition at line 10 of file TimerForSequencer.cpp.

 {
   double cpuTime  =  double(System::cpuTime( System::microSec ) - m_startCpu );
   double lastTime =  double(System::currentTime( System::microSec ) - m_startClock );
 
   //== Change to normalized millisecond
   cpuTime  *= m_factor;
   lastTime *= m_factor;
 
   //== Update the counter
   m_num    += 1;
   m_sum    += lastTime;
   m_sumCpu += cpuTime;
 
   if ( 1 == m_num )
   {
     m_min = lastTime;
     m_max = lastTime;
   }
   else
   {
     if ( lastTime < m_min ) m_min = lastTime;
     if ( lastTime > m_max ) m_max = lastTime;
   }
   m_lastTime = lastTime;
   m_lastCpu  = cpuTime;
   return lastTime;
 }

Member Data Documentation

double TimerForSequencer::m_factor

private

Definition at line 69 of file TimerForSequencer.h.

double TimerForSequencer::m_lastCpu = 0.

private

Definition at line 75 of file TimerForSequencer.h.

double TimerForSequencer::m_lastTime = 0.

private

Definition at line 74 of file TimerForSequencer.h.

double TimerForSequencer::m_max = 0.

private

Definition at line 77 of file TimerForSequencer.h.

double TimerForSequencer::m_min = 0.

private

Definition at line 76 of file TimerForSequencer.h.

std::string TimerForSequencer::m_name

private

Definition at line 67 of file TimerForSequencer.h.

long long TimerForSequencer::m_num = 0LL

private

Definition at line 73 of file TimerForSequencer.h.

unsigned int TimerForSequencer::m_size

private

Definition at line 68 of file TimerForSequencer.h.

long long TimerForSequencer::m_startClock = 0LL

private

Definition at line 70 of file TimerForSequencer.h.

long long TimerForSequencer::m_startCpu = 0LL

private

Definition at line 71 of file TimerForSequencer.h.

double TimerForSequencer::m_sum = 0.

private

Definition at line 78 of file TimerForSequencer.h.

double TimerForSequencer::m_sumCpu = 0.

private

Definition at line 79 of file TimerForSequencer.h.

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

GaudiAlg/src/components/TimerForSequencer.h
GaudiAlg/src/components/TimerForSequencer.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation