ChronoEntity Class Reference

a small helper class for implementation of ChronoStatSvc service, It also could be used as some local timer More...

#include <GaudiKernel/ChronoEntity.h>

Collaboration diagram for ChronoEntity:

Public Member Functions
	ChronoEntity ()=default
	default constructor More...
IChronoSvc::ChronoStatus	start ()
	start the current chrono More...
IChronoSvc::ChronoStatus	stop ()
	stop the chrono More...
IChronoSvc::ChronoTime	delta (IChronoSvc::ChronoType type) const
	return the last delta-time of type "type" More...
IChronoSvc::ChronoStatus	status () const
	return the status of chrono More...
unsigned long	nOfMeasurements () const
	number of chrono measurements More...
double	uMinimalTime () const
	minimal measurement for user time More...
double	kMinimalTime () const
	minimal measurement for kernel time More...
double	eMinimalTime () const
	minimal measurement for elapsed time More...
double	uMaximalTime () const
	maximal measurement for user time More...
double	kMaximalTime () const
	maximal measurement for kernel time More...
double	eMaximalTime () const
	maximal measurement for elapsed time More...
double	uTotalTime () const
	total user time More...
double	kTotalTime () const
	total Kernel time More...
double	eTotalTime () const
	total Elapsed time More...
double	totalTime () const
	total time More...
double	kMeanTime () const
	average Kernel Time More...
double	uMeanTime () const
	average User Time More...
double	eMeanTime () const
	average Elapsed Time More...
double	kRMSTime () const
	r.m.s Kernel Time More...
double	uRMSTime () const
	r.m.s User Time More...
double	eRMSTime () const
	r.m.s Elapsed Time More...
double	kMeanErrorTime () const
	error in mean Kernel time More...
double	uMeanErrorTime () const
	error in mean User time More...
double	eMeanErrorTime () const
	error in mean Elapsed time More...
ChronoEntity &	operator+= (const ChronoEntity &entity)
	Compound assignment operator. More...
std::string	outputUserTime () const
	print the chrono ; More...
std::string	outputSystemTime () const
	print the chrono ; More...
std::string	outputElapsedTime () const
	print the chrono ; More...
std::string	outputUserTime (const std::string &fmt, System::TimeType unit) const
	print the chrono according the format and units More...
std::string	outputSystemTime (const std::string &fmt, System::TimeType unit) const
	print the chrono according the format and units More...
std::string	outputElapsedTime (const std::string &fmt, System::TimeType unit) const
	print the chrono according the format and units More...
std::string	outputTime (IChronoSvc::ChronoType typ, const std::string &fmt, System::TimeType unit) const
	print the chrono according the format and units More...

Protected Member Functions
std::string	format (const double total, const double minimal, const double mean, const double rms, const double maximal, const unsigned long number) const
	format More...

Private Attributes
IChronoSvc::ChronoStatus	m_status = IChronoSvc::UNKNOWN
	current status of this chrono object; More...
System::ProcessTime	m_delta
	delta process times More...
System::ProcessTime	m_start
	start stamp for current measurement of process times More...
StatEntity	m_user
	the actual storage of "user" time More...
StatEntity	m_kernel
	the actual storage of "kernel" time More...
StatEntity	m_elapsed
	the actual storage of "elapsed" time More...

Static Private Attributes
static const System::TimeType	TimeUnit = System::microSec
	internal unit used for the system time conversion (microseconds) More...

Friends
bool	operator< (ChronoEntity const &lhs, ChronoEntity const &rhs)
	comparison operator More...

Detailed Description

a small helper class for implementation of ChronoStatSvc service, It also could be used as some local timer

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@i.nosp@m.tep..nosp@m.ru

Date

December 1, 1999

Definition at line 21 of file ChronoEntity.h.

Constructor & Destructor Documentation

ChronoEntity::ChronoEntity ( )

default

default constructor

Member Function Documentation

IChronoSvc::ChronoTime ChronoEntity::delta ( IChronoSvc::ChronoType  type ) const

inline

return the last delta-time of type "type"

Definition at line 261 of file ChronoEntity.h.

                                                                                 {
  const IChronoSvc::ChronoTime result = -1;
  switch ( type ) {
  case IChronoSvc::USER:
    return m_delta.userTime<TimeUnit>();
  case IChronoSvc::KERNEL:
    return m_delta.kernelTime<TimeUnit>();
  case IChronoSvc::ELAPSED:
    return m_delta.elapsedTime<TimeUnit>();
  default:
    return result;
  }
  // cannot reach this point
}

double ChronoEntity::eMaximalTime ( ) const

inline

maximal measurement for elapsed time

Definition at line 205 of file ChronoEntity.h.

{ return m_elapsed.flagMax(); }

double ChronoEntity::eMeanErrorTime ( ) const

inline

error in mean Elapsed time

Definition at line 257 of file ChronoEntity.h.

{ return m_elapsed.flagMeanErr(); }

double ChronoEntity::eMeanTime ( ) const

inline

average Elapsed Time

Definition at line 233 of file ChronoEntity.h.

{ return m_elapsed.flagMean(); }

double ChronoEntity::eMinimalTime ( ) const

inline

minimal measurement for elapsed time

Definition at line 193 of file ChronoEntity.h.

{ return m_elapsed.flagMin(); }

double ChronoEntity::eRMSTime ( ) const

inline

r.m.s Elapsed Time

Definition at line 245 of file ChronoEntity.h.

{ return m_elapsed.flagRMS(); }

double ChronoEntity::eTotalTime ( ) const

inline

total Elapsed time

Definition at line 217 of file ChronoEntity.h.

{ return m_elapsed.flag(); }

std::string ChronoEntity::format ( const double  total, const double  minimal, const double  mean, const double  rms, const double  maximal, const unsigned long  number  ) const

protected

format

Todo:

: cache the format

Todo:

: cache the format

Definition at line 102 of file ChronoEntity.cpp.

                                                                                           {

  boost::format fmt( "Tot=%2$5.3g%1$s %4$43s #=%3$3lu" );

  static const auto tbl = {std::make_tuple( 500, microsecond, " [us]" ), std::make_tuple( 500, millisecond, " [ms]" ),
                           std::make_tuple( 500, second, "  [s]" ),      std::make_tuple( 500, minute, "[min]" ),
                           std::make_tuple( 500, hour, "  [h]" ),        std::make_tuple( 10, day, "[day]" ),
                           std::make_tuple( 5, week, "  [w]" ),          std::make_tuple( 20, month, "[mon]" ),
                           std::make_tuple( -1, year, "  [y]" )};

  auto i = std::find_if(
      std::begin( tbl ), std::prev( std::end( tbl ) ),
      [&]( const std::tuple<int, double, const char*>& i ) { return total < std::get<0>( i ) * std::get<1>( i ); } );
  long double unit = std::get<1>( *i );
  fmt % std::get<2>( *i ) % (double)( total / unit ) % number;

  if ( number > 1 ) {
    boost::format fmt1( "Ave/Min/Max=%2$5.3g(+-%3$5.3g)/%4$5.3g/%5$5.3g%1$s" );
    i = std::find_if(
        std::begin( tbl ), std::prev( std::end( tbl ) ),
        [&]( const std::tuple<int, double, const char*>& i ) { return total < std::get<0>( i ) * std::get<1>( i ); } );
    unit = std::get<1>( *i );
    fmt1 % std::get<2>( *i ) % (double)( mean / unit ) % (double)( rms / unit ) % (double)( minimal / unit ) %
        (double)( maximal / unit );
    fmt % fmt1.str();
  } else {
    fmt % "";
  }

  return fmt.str();
}

double ChronoEntity::kMaximalTime ( ) const

inline

maximal measurement for kernel time

Definition at line 201 of file ChronoEntity.h.

{ return m_kernel.flagMax(); }

double ChronoEntity::kMeanErrorTime ( ) const

inline

error in mean Kernel time

Definition at line 249 of file ChronoEntity.h.

{ return m_kernel.flagMeanErr(); }

double ChronoEntity::kMeanTime ( ) const

inline

average Kernel Time

Definition at line 225 of file ChronoEntity.h.

{ return m_kernel.flagMean(); }

double ChronoEntity::kMinimalTime ( ) const

inline

minimal measurement for kernel time

Definition at line 189 of file ChronoEntity.h.

{ return m_kernel.flagMin(); }

double ChronoEntity::kRMSTime ( ) const

inline

r.m.s Kernel Time

Definition at line 237 of file ChronoEntity.h.

{ return m_kernel.flagRMS(); }

double ChronoEntity::kTotalTime ( ) const

inline

total Kernel time

Definition at line 213 of file ChronoEntity.h.

{ return m_kernel.flag(); }

unsigned long ChronoEntity::nOfMeasurements ( ) const

inline

number of chrono measurements

Definition at line 181 of file ChronoEntity.h.

{ return m_user.nEntries(); }

ChronoEntity & ChronoEntity::operator+=

(

const ChronoEntity &

entity

)

Compound assignment operator.

Definition at line 139 of file ChronoEntity.cpp.

                                                              {
  // System::ProcessTime type
  m_delta += e.m_delta;

  // Summing, massaging here does not make too much sense.
  // This is done only for final reductions
  // Keep by convention the original one.
  //    m_start += e.m_start;

  // Tymevaluetypes type
  m_user += e.m_user;
  m_kernel += e.m_kernel;
  m_elapsed += e.m_elapsed;

  return *this;
}

std::string ChronoEntity::outputElapsedTime

(

)

const

print the chrono ;

Definition at line 95 of file ChronoEntity.cpp.

                                                {
  return "TimeElapsed: " +
         format( eTotalTime(), eMinimalTime(), eMeanTime(), eRMSTime(), eMaximalTime(), nOfMeasurements() );
}

std::string ChronoEntity::outputElapsedTime ( const std::string &  fmt, System::TimeType  unit  ) const

inline

print the chrono according the format and units

Parameters

fmt	the format string
unit	the unit

Returns

the string representations

See also

boost::format

Definition at line 305 of file ChronoEntity.h.

                                                                                                  {
  return outputTime( IChronoSvc::ELAPSED, fmt, unit );
}

std::string ChronoEntity::outputSystemTime

(

)

const

print the chrono ;

Definition at line 89 of file ChronoEntity.cpp.

                                               {
  return "Time System : " +
         format( kTotalTime(), kMinimalTime(), kMeanTime(), kRMSTime(), kMaximalTime(), nOfMeasurements() );
}

std::string ChronoEntity::outputSystemTime ( const std::string &  fmt, System::TimeType  unit  ) const

inline

print the chrono according the format and units

Parameters

fmt	the format string
unit	the unit

Returns

the string representations

See also

boost::format

Definition at line 294 of file ChronoEntity.h.

                                                                                                 {
  return outputTime( IChronoSvc::KERNEL, fmt, unit );
}

std::string ChronoEntity::outputTime	(	IChronoSvc::ChronoType	typ,
		const std::string &	fmt,
		System::TimeType	unit
	)		const

print the chrono according the format and units

The format fields are:

1. number of entries
2. total time (in the specified units)
3. mean time (in the specified units)
4. r.m.s. time (in the specified units)
5. error in mean time (in the specified units)
6. minimal time (in the specified units)
7. maximal time (in the specified units)

Parameters

typ	the chrono type
fmt	the format string
unit	the unit

Returns

the string representations

See also

boost::format

Definition at line 165 of file ChronoEntity.cpp.

                                                                  {
  boost::format _fmt( fmt );
  // allow various number of arguments
  using namespace boost::io;
  _fmt.exceptions( all_error_bits ^ ( too_many_args_bit | too_few_args_bit ) );
  //
  double _unit = microsecond;
  switch ( unit ) {
  case System::Year:
    _unit = year;
    break;
  case System::Month:
    _unit = month;
    break;
  case System::Day:
    _unit = day;
    break;
  case System::Hour:
    _unit = hour;
    break;
  case System::Min:
    _unit = minute;
    break;
  case System::Sec:
    _unit = second;
    break;
  case System::milliSec:
    _unit = millisecond;
    break;
  case System::microSec:
    _unit = microsecond;
    break;
  case System::nanoSec:
    _unit = nanosecond;
    break;
  default:
    _unit = microsecond;
    break;
  }
  //
  const StatEntity* stat = &m_user;
  switch ( typ ) {
  case IChronoSvc::USER:
    stat = &m_user;
    break;
  case IChronoSvc::KERNEL:
    stat = &m_kernel;
    break;
  case IChronoSvc::ELAPSED:
    stat = &m_elapsed;
    break;
  default:
    stat = &m_user;
    break;
  }
  //
  _fmt % ( stat->nEntries() )           // %1 : #entries
      % ( stat->flag() / _unit )        // %2 : total time
      % ( stat->flagMean() / _unit )    // %3 : mean time
      % ( stat->flagRMS() / _unit )     // %4 : RMS  time
      % ( stat->flagMeanErr() / _unit ) // %5 : error in mean time
      % ( stat->flagMin() / _unit )     // %6 : minimal time
      % ( stat->flagMax() / _unit );    // %7 : maximal time
  //
  return _fmt.str();
}

std::string ChronoEntity::outputUserTime

(

)

const

print the chrono ;

Definition at line 82 of file ChronoEntity.cpp.

                                             {
  return "Time User   : " +
         format( uTotalTime(), uMinimalTime(), uMeanTime(), uRMSTime(), uMaximalTime(), nOfMeasurements() );
}

std::string ChronoEntity::outputUserTime ( const std::string &  fmt, System::TimeType  unit  ) const

inline

print the chrono according the format and units

Parameters

fmt	the format string
unit	the unit

Returns

the string representations

See also

boost::format

Definition at line 283 of file ChronoEntity.h.

                                                                                               {
  return outputTime( IChronoSvc::USER, fmt, unit );
}

IChronoSvc::ChronoStatus ChronoEntity::start

(

)

start the current chrono

Definition at line 46 of file ChronoEntity.cpp.

                                           {
  if ( IChronoSvc::RUNNING == m_status ) { return m_status; }
  //
  // following lines could be platform dependent!
  //
  // Store in object the measured times
  m_start = System::getProcessTime();

  m_status = IChronoSvc::RUNNING;

  return m_status;
}

IChronoSvc::ChronoStatus ChronoEntity::status ( ) const

inline

return the status of chrono

Definition at line 177 of file ChronoEntity.h.

{ return m_status; }

IChronoSvc::ChronoStatus ChronoEntity::stop

(

)

stop the chrono

Definition at line 61 of file ChronoEntity.cpp.

                                          {
  if ( IChronoSvc::RUNNING != m_status ) { return m_status; }

  // following lines could be platform dependent!
  m_delta = System::getProcessTime() - m_start;

  // update the counters:

  m_user += m_delta.userTime<TimeUnit>();
  m_kernel += m_delta.kernelTime<TimeUnit>();
  m_elapsed += m_delta.elapsedTime<TimeUnit>();

  // set new status

  m_status = IChronoSvc::STOPPED;

  return m_status;
}

double ChronoEntity::totalTime ( ) const

inline

total time

Definition at line 221 of file ChronoEntity.h.

{ return uTotalTime() + kTotalTime(); }

double ChronoEntity::uMaximalTime ( ) const

inline

maximal measurement for user time

Definition at line 197 of file ChronoEntity.h.

{ return m_user.flagMax(); }

double ChronoEntity::uMeanErrorTime ( ) const

inline

error in mean User time

Definition at line 253 of file ChronoEntity.h.

{ return m_user.flagMeanErr(); }

double ChronoEntity::uMeanTime ( ) const

inline

average User Time

Definition at line 229 of file ChronoEntity.h.

{ return m_user.flagMean(); }

double ChronoEntity::uMinimalTime ( ) const

inline

minimal measurement for user time

Definition at line 185 of file ChronoEntity.h.

{ return m_user.flagMin(); }

double ChronoEntity::uRMSTime ( ) const

inline

r.m.s User Time

Definition at line 241 of file ChronoEntity.h.

{ return m_user.flagRMS(); }

double ChronoEntity::uTotalTime ( ) const

inline

total user time

Definition at line 209 of file ChronoEntity.h.

{ return m_user.flag(); }

Friends And Related Function Documentation

bool operator< ( ChronoEntity const &  lhs, ChronoEntity const &  rhs  )

friend

comparison operator

Definition at line 89 of file ChronoEntity.h.

                                                                            {
    return std::make_tuple( lhs.totalTime(), lhs.m_user, lhs.m_kernel, lhs.m_elapsed ) <
           std::make_tuple( rhs.totalTime(), rhs.m_user, rhs.m_kernel, rhs.m_elapsed );
  }

Member Data Documentation

System::ProcessTime ChronoEntity::m_delta

private

delta process times

Definition at line 161 of file ChronoEntity.h.

StatEntity ChronoEntity::m_elapsed

private

the actual storage of "elapsed" time

Definition at line 169 of file ChronoEntity.h.

StatEntity ChronoEntity::m_kernel

private

the actual storage of "kernel" time

Definition at line 167 of file ChronoEntity.h.

System::ProcessTime ChronoEntity::m_start

private

start stamp for current measurement of process times

Definition at line 163 of file ChronoEntity.h.

IChronoSvc::ChronoStatus ChronoEntity::m_status = IChronoSvc::UNKNOWN

private

current status of this chrono object;

Definition at line 159 of file ChronoEntity.h.

StatEntity ChronoEntity::m_user

private

the actual storage of "user" time

Definition at line 165 of file ChronoEntity.h.

const System::TimeType ChronoEntity::TimeUnit = System::microSec

staticprivate

internal unit used for the system time conversion (microseconds)

Definition at line 171 of file ChronoEntity.h.

---

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

• GaudiKernel/GaudiKernel/ChronoEntity.h
• GaudiKernel/src/Lib/ChronoEntity.cpp