All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ICounterSummarySvc Class Referenceabstract

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

#include <GaudiKernel/ICounterSummarySvc.h>

Inheritance diagram for ICounterSummarySvc:
Collaboration diagram for ICounterSummarySvc:

Public Member Functions

 DeclareInterfaceID (ICounterSummarySvc, 1, 0)
 InterfaceID. More...
 
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 More...
 
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 More...
 
virtual ~ICounterSummarySvc ()
 virtual destructor More...
 
- Public Member Functions inherited from IService
 DeclareInterfaceID (IService, 3, 0)
 InterfaceID. More...
 
virtual StatusCode sysInitialize ()=0
 Initialize Service. More...
 
virtual StatusCode sysStart ()=0
 Start Service. More...
 
virtual StatusCode sysStop ()=0
 Stop Service. More...
 
virtual StatusCode sysFinalize ()=0
 Finalize Service. More...
 
virtual StatusCode sysReinitialize ()=0
 Re-initialize the Service. More...
 
virtual StatusCode sysRestart ()=0
 Re-start the Service. More...
 
virtual StatusCode configure ()=0
 Configuration (from OFFLINE to CONFIGURED). More...
 
virtual StatusCode initialize ()=0
 Initialization (from CONFIGURED to INITIALIZED). More...
 
virtual StatusCode start ()=0
 Start (from INITIALIZED to RUNNING). More...
 
virtual StatusCode stop ()=0
 Stop (from RUNNING to INITIALIZED). More...
 
virtual StatusCode finalize ()=0
 Finalize (from INITIALIZED to CONFIGURED). More...
 
virtual StatusCode terminate ()=0
 Initialization (from CONFIGURED to OFFLINE). More...
 
virtual StatusCode reinitialize ()=0
 Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
 
virtual StatusCode restart ()=0
 Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
 
virtual Gaudi::StateMachine::State FSMState () const =0
 Get the current state. More...
 
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. More...
 
virtual ~IService ()
 virtual destructor More...
 
- Public Member Functions inherited from INamedInterface
 DeclareInterfaceID (INamedInterface, 1, 0)
 InterfaceID. More...
 
virtual const std::string & name () const =0
 Retrieve the name of the instance. More...
 
virtual ~INamedInterface ()
 Virtual destructor (always needed for abstract classes). More...
 
- Public Member Functions inherited from IInterface
virtual void * i_cast (const InterfaceID &) const =0
 main cast function More...
 
virtual std::vector< std::string > getInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces. More...
 
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance. More...
 
virtual unsigned long release ()=0
 Release Interface instance. More...
 
virtual unsigned long refCount () const =0
 Current reference count. More...
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance. More...
 
virtual ~IInterface ()
 Virtual destructor. More...
 

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. More...
 
typedef mpl::set1< iidext_iids
 Extra interfaces. More...
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 
- 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.

Constructor & Destructor Documentation

virtual ICounterSummarySvc::~ICounterSummarySvc ( )
inlinevirtual

virtual destructor

Definition at line 74 of file ICounterSummarySvc.h.

74 {}

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::stringname [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::stringname [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  ,
,
 
)

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