Simple service interface to collect counters to persist in a summary file. More...

#include <ICounterSummarySvc.h>

Inheritance diagram for ICounterSummarySvc:

Collaboration diagram for ICounterSummarySvc:

Public Member Functions
	DeclareInterfaceID (ICounterSummarySvc, 1, 0)
	InterfaceID.

virtual void	addCounter (const std::string, const std::string name, const StatEntity &, const Gaudi::CounterSummary::SaveType saveType=Gaudi::CounterSummary::SaveSimpleCounter)=0
	declare a counter, StatEntity, to be filled in the Counter summary

virtual void	addCounter (const std::string, const std::string name, const Stat &, const Gaudi::CounterSummary::SaveType saveType=Gaudi::CounterSummary::SaveSimpleCounter)=0
	declare a counter, Stat, to be filled in the Counter summary

Public Member Functions inherited from IService
	DeclareInterfaceID (IService, 3, 0)
	InterfaceID.

virtual StatusCode	sysInitialize ()=0
	Initialize Service.

virtual StatusCode	sysStart ()=0
	Start Service.

virtual StatusCode	sysStop ()=0
	Stop Service.

virtual StatusCode	sysFinalize ()=0
	Finalize Service.

virtual StatusCode	sysReinitialize ()=0
	Re-initialize the Service.

virtual StatusCode	sysRestart ()=0
	Re-start the Service.

virtual StatusCode	configure ()=0
	Configuration (from OFFLINE to CONFIGURED).

virtual StatusCode	initialize ()=0
	Initialization (from CONFIGURED to INITIALIZED).

virtual StatusCode	start ()=0
	Start (from INITIALIZED to RUNNING).

virtual StatusCode	stop ()=0
	Stop (from RUNNING to INITIALIZED).

virtual StatusCode	finalize ()=0
	Finalize (from INITIALIZED to CONFIGURED).

virtual StatusCode	terminate ()=0
	Initialization (from CONFIGURED to OFFLINE).

virtual StatusCode	reinitialize ()=0
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).

virtual StatusCode	restart ()=0
	Initialization (from RUNNING to RUNNING, via INITIALIZED).

virtual Gaudi::StateMachine::State	FSMState () const =0
	Get the current state.

virtual Gaudi::StateMachine::State	targetFSMState () const =0
	When we are in the middle of a transition, get the state where the transition is leading us.

Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID.

virtual const std::string &	name () const =0
	Retrieve the name of the instance.

virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes).

Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function

virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces.

virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance.

virtual unsigned long	release ()=0
	Release Interface instance.

virtual unsigned long	refCount () const =0
	Current reference count.

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance.

virtual	~IInterface ()
	Virtual destructor.

Additional Inherited Members
Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...

typedef Gaudi::InterfaceId < IInterface, 0, 0 >	iid
	Interface ID.

typedef mpl::set1< iid >	ext_iids
	Extra interfaces.

Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface.

Protected Member Functions inherited from IService
virtual void	setServiceManager (ISvcManager *)=0

Detailed Description

Simple service interface to collect counters to persist in a summary file.

In LHCb this is used to write an XML summary of the job.

See Also: XMLSummarySvc

Author: Rob Lambert

Date: 2009-07-29

Definition at line 37 of file ICounterSummarySvc.h.

Member Function Documentation

virtual void ICounterSummarySvc::addCounter	(	const std::string	,
		const std::string	name,
		const StatEntity &	,
		const Gaudi::CounterSummary::SaveType	saveType = `Gaudi::CounterSummary::SaveSimpleCounter`
	)

pure virtual

declare a counter, StatEntity, to be filled in the Counter summary

Parameters

std::string	[IN]: Name of the tool/alg/mother filling this counter
std::string	name [IN]: Name of the counter
StatEntity	[IN]: The counter to store/save
saveType	[IN]: How to save it, from an enum

See Also: Gaudi::CounterSummary::SaveType

virtual void ICounterSummarySvc::addCounter	(	const std::string	,
		const std::string	name,
		const Stat &	,
		const Gaudi::CounterSummary::SaveType	saveType = `Gaudi::CounterSummary::SaveSimpleCounter`
	)

pure virtual

declare a counter, Stat, to be filled in the Counter summary

Parameters

std::string	[IN]: Name of the tool/alg/mother filling this counter
std::string	name [IN]: Name of the counter
Stat	[IN]: The counter to store/save
saveType	[IN]: How to save it, from an enum

See Also: Gaudi::CounterSummary::SaveType

ICounterSummarySvc::DeclareInterfaceID	(	ICounterSummarySvc	,
		1	,
		0
	)

InterfaceID.

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

/afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r6/GaudiKernel/GaudiKernel/ICounterSummarySvc.h

Gaudi Framework, version v23r6

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation