Stat Class Reference

Small wrapper class for easy manipulation with generic counters and IStatSvc interface. More...

#include <GaudiKernel/Stat.h>

Collaboration diagram for Stat:

Public Member Functions
	Stat (StatEntity *entity=0, const std::string &name="", const std::string &group="")
	constructor from StatEntity, name and group :
	Stat (StatEntity &entity, const std::string &name="", const std::string &group="")
	constructor from StatEntity, name and group :
	Stat (IStatSvc *svc, const std::string &tag)
	constructor from IStatSvc, tag and value
	Stat (IStatSvc *svc, const std::string &tag, const double flag)
	constructor from IStatSvc, tag and value
	Stat (const Stat &)=default
	copy constructor
Stat &	operator= (const Stat &)=default
	Assignement operator.
	~Stat ()=default
	destructor
const StatEntity *	entity () const
	get the entity
const StatEntity *	operator-> () const
	dereference operaqtor
	operator const StatEntity & () const
	cast to StatEntity
bool	operator! () const
	check validity
Stat &	operator+= (const double f)
	General increment for the counter.
Stat &	operator++ ()
	Pre-increment operator for the counter.
Stat &	operator++ (int)
	Post-increment operator for the counter.
Stat &	operator-= (const double f)
	General decrement operator for the counter.
Stat &	operator-- ()
	Pre-decrement operator for the flag.
Stat &	operator-- (int)
	Post-decrement operator for the flag.
Stat &	operator+= (const StatEntity &right)
	increment with StatEntity object
Stat &	operator+= (const Stat &right)
	increment with other stat objects
std::string	toString () const
	representation as string
std::ostream &	print (std::ostream &o=std::cout) const
	printout to std::ostream
std::ostream &	fillStream (std::ostream &o) const
	printout to std::ostream
StatEntity *	counter () const
	alternative access to underlying counter
const std::string &	name () const
	counter name
const std::string &	group () const
	counter group

Private Attributes
StatEntity *	m_entity = nullptr
	underlying counter
std::string	m_tag
	unique stat tag(name)
std::string	m_group
SmartIF< IStatSvc >	m_stat
	Stat service.

Detailed Description

Small wrapper class for easy manipulation with generic counters and IStatSvc interface.

It acts as "smart pointer" fro StatEntity objects, and allows manipulation with StatEntity objects, owned by GaudiCommon<TYPE> base class and/or IStatSvc

long nTracks = ... ;
Stat stat( chronoSvc() , "#tracks" , nTracks ) ;

Alternatively one can use operator methods:

long nTracks = ... ;
Stat stat( chronoSvc() , "#tracks" ) ;
stat += nTracks ;

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@l.nosp@m.app..nosp@m.in2p3.nosp@m..fr

Date

2007-08-02

Definition at line 48 of file Stat.h.

Constructor & Destructor Documentation

Stat() [1/5]

Stat::Stat ( StatEntity * entity = 0, const std::string & name = "", const std::string & group = "" )

inline

constructor from StatEntity, name and group :

StatEntity* entity = ... ;
 
// make helper object:
Stat stat ( entity ) ;

See also

StatEntity

Parameters

entity	pointer to entity object
name	(optional) name of the object, for printout
group	(optional) group of the object, for printout

Definition at line 66 of file Stat.h.

      : m_entity( entity ), m_tag( name ), m_group( group ) {}

Stat() [2/5]

Stat::Stat ( StatEntity & entity, const std::string & name = "", const std::string & group = "" )

inline

constructor from StatEntity, name and group :

// make helper object:
Stat stat = Stat( countter("Name") , "Name" ) ;

See also

StatEntity

GaudiCommon::counter

Parameters

entity	reference to entity object
name	(optional) name of the object, for printout
group	(optional) group of the object, for printout

Definition at line 82 of file Stat.h.

      : m_entity( &entity ), m_tag( name ), m_group( group ) {}

Stat() [3/5]

Stat::Stat	(	IStatSvc *	svc,
		const std::string &	tag )

constructor from IStatSvc, tag and value

IStatSvc* svc = ... ;
double eTotal = .... ;
 
// get/create the counter from Stat Service
Stat eTot ( svc , "total energy" ) ;
 
eTot += eTotal ;

See also

IStatSvc

Parameters

svc	pointer to Chrono&Stat Service @paran tag unique tag for the entry

Definition at line 28 of file Stat.cpp.

                                                : m_tag( tag ), m_group(), m_stat( svc ) {
  if ( m_stat ) {
    // get from the service
    StatEntity* tmp = m_stat->stat( tag );
    if ( !tmp ) {
      // create if needed
      m_stat->stat( tag, 0 );
      tmp = m_stat->stat( tag );
      tmp->reset();
    }
    m_entity = tmp;
  }
}

Stat() [4/5]

Stat::Stat	(	IStatSvc *	svc,
		const std::string &	tag,
		const double	flag )

constructor from IStatSvc, tag and value

IStatSvc* svc = ... ;
double eTotal = .... ;
 
// get/create the counter from Stat Service
Stat stat( svc , "total energy" , eTotal ) ;

See also

IStatSvc

Parameters

svc	pointer to Chrono&Stat Service @paran tag unique tag for the entry
flag	"flag"(additive quantity) to be used

Definition at line 42 of file Stat.cpp.

                                                                   : m_tag( tag ), m_group(), m_stat( svc ) {
  if ( m_stat ) {
    m_stat->stat( tag, flag );
    // get from the service
    m_entity = m_stat->stat( tag );
  }
}

Stat() [5/5]

Stat::Stat ( const Stat & )

default

copy constructor

~Stat()

Stat::~Stat ( )

default

destructor

Member Function Documentation

counter()

StatEntity * Stat::counter ( ) const

inline

alternative access to underlying counter

Definition at line 230 of file Stat.h.

{ return m_entity; }

entity()

const StatEntity * Stat::entity ( ) const

inline

get the entity

Definition at line 128 of file Stat.h.

{ return m_entity; }

fillStream()

std::ostream & Stat::fillStream ( std::ostream & o ) const

inline

printout to std::ostream

Parameters

s	the reference to the output stream

Returns

the reference to the output stream

Definition at line 228 of file Stat.h.

{ return print( o ); }

group()

const std::string & Stat::group ( ) const

inline

counter group

Definition at line 234 of file Stat.h.

{ return m_group; }

name()

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

inline

counter name

Definition at line 232 of file Stat.h.

{ return m_tag; }

operator const StatEntity &()

Stat::operator const StatEntity & ( ) const

inline

cast to StatEntity

Definition at line 132 of file Stat.h.

{ return *entity(); }

operator!()

bool Stat::operator! ( ) const

inline

check validity

Definition at line 134 of file Stat.h.

{ return 0 == m_entity; }

operator++() [1/2]

Stat & Stat::operator++ ( )

inline

Pre-increment operator for the counter.

Stat stat = ... ;
 
++stat ;

See also

StatEntity

Returns

selfreference

Definition at line 168 of file Stat.h.

                     {
    if ( m_entity ) { ++( *m_entity ); }
    return *this;
  }

operator++() [2/2]

Stat & Stat::operator++ ( int )

inline

Post-increment operator for the counter.

Stat stat = ... ;
 
stat++ ;

See also

StatEntity

Returns

self-reference

Definition at line 184 of file Stat.h.

                          {
    if ( m_entity ) { ( *m_entity )++; }
    return *this;
  }

operator+=() [1/3]

Stat & Stat::operator+= ( const double f )

inline

General increment for the counter.

Stat stat = ... ;
 
const long nTracks = ... ;
 
stat += nTracks ;

See also

StatEntity

Parameters

f	value to be added to the counter

Returns

selfreference

Definition at line 151 of file Stat.h.

                                     {
    if ( m_entity ) { ( *m_entity ) += f; }
    return *this;
  }

operator+=() [2/3]

Stat & Stat::operator+= ( const Stat & right )

inline

increment with other stat objects

Definition at line 213 of file Stat.h.

                                        {
    if ( 0 != right.entity() ) { ( *this ) += *right.entity(); }
    return *this;
  }

operator+=() [3/3]

Stat & Stat::operator+= ( const StatEntity & right )

inline

increment with StatEntity object

Definition at line 208 of file Stat.h.

                                              {
    if ( m_entity ) { ( *m_entity ) += right; }
    return *this;
  }

operator--() [1/2]

Stat & Stat::operator-- ( )

inline

Pre-decrement operator for the flag.

Definition at line 198 of file Stat.h.

                     {
    if ( m_entity ) { --( *m_entity ); }
    return *this;
  }

operator--() [2/2]

Stat & Stat::operator-- ( int )

inline

Post-decrement operator for the flag.

Definition at line 203 of file Stat.h.

                          {
    if ( m_entity ) { ( *m_entity )--; }
    return *this;
  }

operator-=()

Stat & Stat::operator-= ( const double f )

inline

General decrement operator for the counter.

See also

StatEntity

Returns

self-reference

Parameters

f	counter decrement

Definition at line 193 of file Stat.h.

                                     {
    if ( m_entity ) { ( *m_entity ) -= f; }
    return *this;
  }

operator->()

const StatEntity * Stat::operator-> ( ) const

inline

dereference operaqtor

Definition at line 130 of file Stat.h.

{ return entity(); }

operator=()

Stat & Stat::operator= ( const Stat & )

default

Assignement operator.

print()

std::ostream & Stat::print

(

std::ostream &

o = std::cout

)

const

printout to std::ostream

Parameters

s	the reference to the output stream

Returns

the reference to the output stream

Definition at line 56 of file Stat.cpp.

                                             {
  auto        entity = ( m_entity ) ? fmt::format( "{}", *m_entity ) : "NULL";
  std::string tag;
  if ( !m_tag.empty() ) {
    if ( !m_group.empty() ) {
      tag = fmt::format( "\"{}::{}\"", m_group, m_tag );
    } else {
      tag = fmt::format( "\"{}\"", m_tag );
    }
  }
  return o << fmt::format( " {:^30} {}", tag, entity );
}

toString()

std::string Stat::toString

(

)

const

representation as string

Definition at line 50 of file Stat.cpp.

                               {
  std::ostringstream ost;
  print( ost );
  return ost.str();
}

Member Data Documentation

m_entity

StatEntity* Stat::m_entity = nullptr

private

underlying counter

Definition at line 238 of file Stat.h.

m_group

std::string Stat::m_group

private

Definition at line 242 of file Stat.h.

m_stat

SmartIF<IStatSvc> Stat::m_stat

private

Stat service.

Definition at line 244 of file Stat.h.

m_tag

std::string Stat::m_tag

private

unique stat tag(name)

Definition at line 240 of file Stat.h.

---

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

• GaudiKernel/include/GaudiKernel/Stat.h
• GaudiKernel/src/Lib/Stat.cpp