Simple implementation of the abstract interface ICounterSvc. More...

Inheritance diagram for CounterSvc:

Collaboration diagram for CounterSvc:

Public Member Functions
	CounterSvc (const std::string &name, ISvcLocator *svcLoc)
	Standard Constructor. More...

	~CounterSvc () override
	Standard destructor. More...

StatusCode	finalize () override
	Finalization. More...

Counter *	get (const std::string &group, const std::string &name) const override
	Access an existing counter object. More...

ICounterSvc::Counters	get (const std::string &group) const override
	get all counters form the given group: More...

StatusCode	create (const std::string &group, const std::string &name, longlong initial_value, Counter *&refpCounter) override
	Create a new counter object. More...

CountObject	create (const std::string &group, const std::string &name, longlong initial_value=0) override
	Create a new counter object. More...

StatusCode	remove (const std::string &group, const std::string &name) override
	Remove a counter object. More...

StatusCode	remove (const std::string &group) override
	Remove all counters of a given group. More...

virtual StatusCode	remove ()
	Remove all known counter objects. More...

StatusCode	print (const std::string &group, const std::string &name, Printout &printer) const override
	Print counter value. More...

StatusCode	print (const std::string &group, Printout &printer) const override
	If no such counter exists the return code is COUNTER_NOT_PRESENT Note: This call is not direct access. More...

StatusCode	print (const Counter *pCounter, Printout &printer) const override
	Print counter value. More...

StatusCode	print (const CountObject &pCounter, Printout &printer) const override
	Print counter value. More...

StatusCode	print (Printout &printer) const override

StatusCode	defaultPrintout (MsgStream &log, const Counter *pCounter) const override
	Default Printout for counters. More...

void	print () const
	"standard" printout a'la GaudiCommon More...

Public Member Functions inherited from extends< Service, ICounterSvc >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

	~extends () override=default
	Virtual destructor. More...

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service. More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service. More...

StatusCode	sysStart () override
	Initialize Service. More...

StatusCode	sysStop () override
	Initialize Service. More...

StatusCode	sysFinalize () override
	Finalize Service. More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Types
typedef GaudiUtils::HashMap< std::string, Counter * >	NameMap

typedef GaudiUtils::HashMap< std::string, NameMap >	CountMap

Private Member Functions
std::pair< std::string, std::string >	_find (const Counter *c) const

size_t	num () const

Private Attributes
CountMap	m_counts
	the actual map of counters More...

bool	m_print = true
	boolean flag to print statistics More...

std::string	m_header
	the header row More...

std::string	m_format1
	format for regular statistical printout rows More...

std::string	m_format2
	format for "efficiency" statistical printout rows More...

bool	m_useEffFormat = true
	flag to use the special "efficiency" format More...

Additional Inherited Members
Public Types inherited from extends< Service, ICounterSvc >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

Public Types inherited from Service
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging

Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...

Detailed Description

Simple implementation of the abstract interface ICounterSvc.

Author: Markus FRANK; Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-05-25

Definition at line 24 of file CounterSvc.cpp.

Member Typedef Documentation

typedef GaudiUtils::HashMap<std::string,NameMap> CounterSvc::CountMap

private

Definition at line 209 of file CounterSvc.cpp.

typedef GaudiUtils::HashMap<std::string,Counter*> CounterSvc::NameMap

private

Definition at line 208 of file CounterSvc.cpp.

Constructor & Destructor Documentation

CounterSvc::CounterSvc	(	const std::string &	name,
		ISvcLocator *	svcLoc
	)

inline

Standard Constructor.

Definition at line 28 of file CounterSvc.cpp.

     : base_class(name, svcLoc)
     // the header row
     , m_header  ( "       Counter :: Group         |     #     |    sum     | mean/eff^* | rms/err^*  |     min     |     max     |")
     // format for regular statistical printout rows
     , m_format1 ( " %|15.15s|%|-15.15s|%|32t||%|10d| |%|11.7g| |%|#11.5g| |%|#11.5g| |%|#12.5g| |%|#12.5g| |"         )
     // format for "efficiency" statistical printout rows
     , m_format2 ( "*%|15.15s|%|-15.15s|%|32t||%|10d| |%|11.5g| |(%|#9.7g| +- %|-#9.7g|)%%|   -------   |   -------   |" )
     //
   {
     declareProperty ("PrintStat" , m_print ) ;
     //
     declareProperty
       ( "StatTableHeader"        , m_header                          ,
         "The header row for the output Stat-table"                   ) ;
     //
     declareProperty
       ( "RegularRowFormat"       , m_format1                         ,
         "The format for the regular row in the output Stat-table"    ) ;
     //
     declareProperty
       ( "EfficiencyRowFormat"    , m_format2                         ,
         "The format for the regular row in the outptu Stat-table"    ) ;
     //
     declareProperty
       ( "UseEfficiencyRowFormat" , m_useEffFormat                    ,
         "Use the special format for printout of efficiency counters" ) ;
   }

CounterSvc::~CounterSvc ( )

inlineoverride

Standard destructor.

Definition at line 58 of file CounterSvc.cpp.

58 { remove().ignore() ; }

Member Function Documentation

std::pair<std::string,std::string> CounterSvc::_find ( const Counter * c ) const

inlineprivate

Definition at line 182 of file CounterSvc.cpp.

   {
     if ( c ) {
         for ( const auto& i : m_counts ) {
           auto j = std::find_if( i.second.begin(), i.second.end(),
                                  [&](const NameMap::value_type& k) {
                                      return k.second == c;
           });
           if (j!=i.second.end()) return { i.first, j->first } ;
         }
     }
     return { };
   }

StatusCode CounterSvc::create	(	const std::string &	group,
		const std::string &	name,
		longlong	initial_value,
		Counter *&	refpCounter
	)

override

Create a new counter object.

If the counter object exists already the existing object is returned. In this event the return code is COUNTER_EXISTS. The ownership of the actual counter stays with the service.

Parameters

group	[IN] Hint for smart printing
name	[IN] Counter name
initial_value	[IN] Initial counter value
refpCounter	[OUT] Reference to store pointer to counter.

Returns: StatusCode indicating failure or success.

Definition at line 265 of file CounterSvc.cpp.

 {
   // try to find existing counter:
   refpCounter = get ( grp , nam ) ;
   if ( refpCounter ) { return COUNTER_EXISTS ; }                // RETURN
   // create the new counter
   auto  newc = new Counter() ;
   refpCounter = newc ;
   if ( 0 != initial_value ) {
     refpCounter->addFlag ( static_cast<double>(initial_value) ) ; // icc remark #2259
   }
   // find a proper group
   auto i = m_counts.find  ( grp ) ;
   // (create a group if needed)
   if (  m_counts.end() == i )
   { i = m_counts.emplace ( grp , NameMap() ).first ; }
   // insert new counter with proper name into proper group:
   i->second.emplace( nam , newc );
   return StatusCode::SUCCESS ;                                     // RETURN
 }

CounterSvc::CountObject CounterSvc::create	(	const std::string &	group,
		const std::string &	name,
		longlong	initial_value = `0`
	)

override

Create a new counter object.

If the counter object exists already, a std::runtime_error exception is thrown. The ownership of the actual counter stays with the service.

Parameters

group	[IN] Hint for smart printing
name	[IN] Counter name
initial_value	[IN] Initial counter value
refpCounter	[OUT] Reference to store pointer to counter.

Returns: Fully initialized CountObject.

Definition at line 296 of file CounterSvc.cpp.

 {
   Counter* p = nullptr;
   StatusCode sc = create ( group, name, initial_value, p ) ;
   if ( sc.isSuccess() && p ) { return CountObject ( p , group , name ) ; }
   throw std::runtime_error("CounterSvc::Counter('"+group+"::"+name+"') exists already!");
 }

StatusCode CounterSvc::defaultPrintout	(	MsgStream &	log,
		const Counter *	pCounter
	)		const

override

Default Printout for counters.

Definition at line 420 of file CounterSvc.cpp.

 {
   if ( !c ) { return StatusCode::FAILURE ; }
   auto p = _find ( c ) ;
 
   log << MSG::ALWAYS
       << CountObject( const_cast<Counter*>(c) , p.first , p.second )
       << endmsg ;
 
   return StatusCode::SUCCESS;
 }

StatusCode CounterSvc::finalize ( )

inlineoverride

Finalization.

< finalize the base class

Definition at line 60 of file CounterSvc.cpp.

   {
     if ( msgLevel(MSG::DEBUG) || m_print ) { print () ; }
     remove().ignore() ;
     // finalize the base class
     return Service::finalize() ; 
   }

CounterSvc::Counter * CounterSvc::get	(	const std::string &	group,
		const std::string &	name
	)		const

override

Access an existing counter object.

Parameters

group	[IN] Hint for smart printing
name	[IN] Counter name

Returns: Pointer to existing counter object (NULL if non existing).

Definition at line 231 of file CounterSvc.cpp.

 {
   auto i = m_counts.find  ( grp ) ;
   if (  m_counts.end() == i ) { return nullptr ; }              // RETURN
   auto  j = i->second.find ( nam ) ;
   if ( i->second.end() == j ) { return nullptr ; }              // RETURN
   return j->second ;                                            // RETURN
 }

ICounterSvc::Counters CounterSvc::get ( const std::string & group ) const

override

get all counters form the given group:

Definition at line 243 of file CounterSvc.cpp.

 {
   ICounterSvc::Counters result ;
   auto i = m_counts.find  ( group ) ;
   if (  i != m_counts.end() ) {
     std::transform( i->second.begin(), i->second.end(),
                     std::back_inserter(result),
                     [&](const NameMap::value_type& j) {
         return CountObject{ j.second, i->first, j.first };
     } );
   }
   return result ;
 }

size_t CounterSvc::num ( ) const

inlineprivate

Definition at line 196 of file CounterSvc.cpp.

   {
     return std::accumulate( m_counts.begin(), m_counts.end(), size_t{0},
                  [](size_t r, const CountMap::value_type& i) {
                      return r + std::count_if(i.second.begin(),i.second.end(),
                                               [](const NameMap::value_type& j) -> bool { return j.second; });
                  });
   }

StatusCode CounterSvc::print	(	const std::string &	group,
		const std::string &	name,
		Printout &	printer
	)		const

override

Print counter value.

Parameters

group	[IN] Hint for smart printing
name	[IN] Counter name
printer	[IN] Print actor

Returns: StatusCode indicating failure or success.

Definition at line 345 of file CounterSvc.cpp.

 {
   const Counter* c = get( grp , nam ) ;
   if ( !c ) { return COUNTER_NOT_PRESENT ; }                  // RETURN
   // create the stream and use it!
   return printer ( msgStream() , c ) ;
 }

StatusCode CounterSvc::print	(	const std::string &	group,
		Printout &	printer
	)		const

override

If no such counter exists the return code is COUNTER_NOT_PRESENT Note: This call is not direct access.

Parameters

group	[IN] Hint for smart printing
printer	[IN] Print actor

Returns: StatusCode indicating failure or success.

Definition at line 375 of file CounterSvc.cpp.

 {
   auto i = m_counts.find ( grp ) ;
   if ( m_counts.end() == i ) { return COUNTER_NOT_PRESENT ; }
 
   // Force printing in alphabetical order
   std::map<std::string, Counter*> sorted_map(i->second.begin(), i->second.end());
   std::for_each(sorted_map.begin(), sorted_map.end(),
                 conditionalPrint(printer, msgStream()));
   return StatusCode::SUCCESS;   // RETURN
 }

StatusCode CounterSvc::print	(	const Counter *	pCounter,
		Printout &	printer
	)		const

override

Print counter value.

Parameters

pCounter	[IN] Pointer to Counter object
printer	[IN] Print actor

Returns: StatusCode indicating failure or success.

Definition at line 391 of file CounterSvc.cpp.

 {
   return printer ( msgStream() , pCounter ) ;
 }

StatusCode CounterSvc::print	(	const CountObject &	pCounter,
		Printout &	printer
	)		const

override

Print counter value.

Parameters

refCounter	[IN] Reference to CountObject object
printer	[IN] Print actor

Returns: StatusCode indicating failure or success.

Definition at line 400 of file CounterSvc.cpp.

402 { return print( refCounter.counter() , printer ) ; }

CounterSvc::print

void print() const

"standard" printout a'la GaudiCommon

Definition: CounterSvc.cpp:435

StatusCode CounterSvc::print ( Printout & printer ) const

override

Parameters

printer [IN] Print actor

Returns: StatusCode indicating failure or success.

Definition at line 406 of file CounterSvc.cpp.

 {
   // Force printing in alphabetical order
   std::map<std::pair<std::string,std::string>, Counter*> sorted_map;
   for ( const auto& i : m_counts ) for ( const auto&  j : i.second )
       sorted_map[ { i.first, j.first } ] = j.second;
   std::for_each(sorted_map.begin(), sorted_map.end(),
                 conditionalPrint(printer, msgStream()));
   return StatusCode::SUCCESS;
 }

void CounterSvc::print ( ) const

"standard" printout a'la GaudiCommon

Definition at line 435 of file CounterSvc.cpp.

 {
   // number of counters
   const auto _num = num() ;
   if ( 0 != _num )
   {
     always()
         << "Number of counters : "  << _num << endmsg
         << m_header << endmsg ;
   }
   // Force printing in alphabetical order
   std::map<std::pair<std::string,std::string>, Counter*> sorted_map;
   for ( const auto& i : m_counts ) {
     for ( const auto& j : i.second ) {
       if ( j.second ) sorted_map[ {i.first, j.first} ] = j.second;
     }
   }
   for ( const auto& i : sorted_map ) {
     always() << Gaudi::Utils::formatAsTableRow( i.first.second
                                          , i.first.first
                                          , *i.second
                                          , m_useEffFormat
                                          , m_format1
                                          , m_format2 )
         << endmsg ;
   }
 }

StatusCode CounterSvc::remove	(	const std::string &	group,
		const std::string &	name
	)

override

Remove a counter object.

If the counter object does not exists, the return code is COUNTER_NOT_PRESENT. The counter may not be used anymore after this call.

Parameters

group	[IN] Hint for smart printing
name	[IN] Counter name
initial_value	[IN] Initial counter value
refpCounter	[OUT] Reference to store pointer to counter.

Returns: StatusCode indicating failure or success.

Definition at line 309 of file CounterSvc.cpp.

 {
   auto i = m_counts.find  ( grp ) ;
   if (  m_counts.end() == i ) { return COUNTER_NOT_PRESENT ; }  // RETURN
   auto  j = i->second.find ( nam ) ;
   if ( i->second.end() == j ) { return COUNTER_NOT_PRESENT ; }  // RETURN
   delete j->second ;
   i->second.erase ( j ) ;
   return StatusCode::SUCCESS ;
 }

StatusCode CounterSvc::remove ( const std::string & group )

override

Remove all counters of a given group.

If no such counter exists the return code is COUNTER_NOT_PRESENT

Parameters

group [IN] Hint for smart printing

Returns: StatusCode indicating failure or success.

Definition at line 323 of file CounterSvc.cpp.

 {
   auto i = m_counts.find ( grp  ) ;
   if (  m_counts.end() == i ) { return COUNTER_NOT_PRESENT ; }  // RETURN
   for ( auto& j : i->second ) delete j.second ;
   i->second.clear() ;
   return StatusCode::SUCCESS ;
 }

StatusCode CounterSvc::remove ( )

virtual

Remove all known counter objects.

Definition at line 334 of file CounterSvc.cpp.

 {
   // remove group by group
   for ( auto& i : m_counts ) remove ( i.first ).ignore () ;
   m_counts.clear() ;
   return StatusCode::SUCCESS;
 }

Member Data Documentation

CountMap CounterSvc::m_counts

private

the actual map of counters

Definition at line 211 of file CounterSvc.cpp.

std::string CounterSvc::m_format1

private

format for regular statistical printout rows

Definition at line 217 of file CounterSvc.cpp.

std::string CounterSvc::m_format2

private

format for "efficiency" statistical printout rows

Definition at line 219 of file CounterSvc.cpp.

std::string CounterSvc::m_header

private

the header row

Definition at line 215 of file CounterSvc.cpp.

bool CounterSvc::m_print = true

private

boolean flag to print statistics

Definition at line 213 of file CounterSvc.cpp.

bool CounterSvc::m_useEffFormat = true

private

flag to use the special "efficiency" format

Definition at line 221 of file CounterSvc.cpp.

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

GaudiCommonSvc/src/CounterSvc.cpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation