In This Package:

IAuditorSvc Class Reference

The interface implemented by the IAuditorSvc base class. More...

#include <GaudiKernel/IAuditorSvc.h>

Inheritance diagram for IAuditorSvc:

[legend]Collaboration diagram for IAuditorSvc:[legend]List of all members.


Public Types
	SUCCESS = 1
	Normal successful completion.
	NO_INTERFACE
	Requested interface is not available.
	VERSMISMATCH
	Requested interface version is incompatible.
	LAST_ERROR
	Last error.
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
typedef std::string	CustomEventType
	Type used to allow users to specify a custom event to be audit.
typedef const CustomEventType &	CustomEventTypeRef
	Used in function calls for optimization purposes.
	Initialize
	ReInitialize
	Execute
	BeginRun
	EndRun
	Finalize
	Start
	Stop
	ReStart
enum	StandardEventType { Initialize, ReInitialize, Execute, BeginRun, EndRun, Finalize, Start, Stop, ReStart }
	Defines the standard (= used by the framework) auditable event types. More...
Public Member Functions
virtual IAuditor *	getAuditor (const std::string &name)=0
	management functionality: retrieve an Auditor
virtual const InterfaceID &	type () const =0
	Retrieve ID of the Service. Not really used.
virtual StatusCode	sysInitialize ()=0
	Initilize 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.
virtual const std::string &	name () const =0
	Retrieve the name of the instance.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)=0
	Query interfaces of Interface.
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance.
virtual unsigned long	release ()=0
	Release Interface instance.
virtual void	before (StandardEventType, INamedInterface *)=0
	Audit the start of a standard "event".
virtual void	before (StandardEventType, const std::string &)=0
	Audit the start of a standard "event" for callers that do not implement INamedInterface.
virtual void	before (CustomEventTypeRef, INamedInterface *)=0
	Audit the start of a custom "event".
virtual void	before (CustomEventTypeRef, const std::string &)=0
	Audit the start of a custom "event" for callers that do not implement INamedInterface.
virtual void	after (StandardEventType, INamedInterface *, const StatusCode &sc=StatusCode(StatusCode::SUCCESS, true))=0
	Audit the end of a standard "event".
virtual void	after (StandardEventType, const std::string &, const StatusCode &sc=StatusCode(StatusCode::SUCCESS, true))=0
	Audit the end of a standard "event" for callers that do not implement INamedInterface.
virtual void	after (CustomEventTypeRef, INamedInterface *, const StatusCode &sc=StatusCode(StatusCode::SUCCESS, true))=0
	Audit the end of a custom "event".
virtual void	after (CustomEventTypeRef, const std::string &, const StatusCode &sc=StatusCode(StatusCode::SUCCESS, true))=0
	Audit the end of a custom "event" for callers that do not implement INamedInterface.
virtual bool	isEnabled () const =0
	Tell if the auditor is enabled or not.
virtual void	beforeInitialize (INamedInterface *)=0
virtual void	afterInitialize (INamedInterface *)=0
virtual void	beforeReinitialize (INamedInterface *)=0
virtual void	afterReinitialize (INamedInterface *)=0
virtual void	beforeExecute (INamedInterface *)=0
virtual void	afterExecute (INamedInterface *, const StatusCode &)=0
virtual void	beforeBeginRun (INamedInterface *)=0
virtual void	afterBeginRun (INamedInterface *)=0
virtual void	beforeEndRun (INamedInterface *)=0
virtual void	afterEndRun (INamedInterface *)=0
virtual void	beforeFinalize (INamedInterface *)=0
virtual void	afterFinalize (INamedInterface *)=0
virtual StatusCode	sysInitialize ()=0
	Used by AuditorSvc.
virtual StatusCode	sysFinalize ()=0
	Used by AuditorSvc.
Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID.
Protected Member Functions
virtual void	setServiceManager (ISvcManager *)=0

Detailed Description

The interface implemented by the IAuditorSvc base class.

Author:: Pere Mato

Definition at line 20 of file IAuditorSvc.h.

Member Typedef Documentation

typedef std::string IAuditor::CustomEventType [inherited]

Type used to allow users to specify a custom event to be audit.

Examples of custom events are callbacks (see patch #1725).

Definition at line 43 of file IAuditor.h.

typedef const CustomEventType& IAuditor::CustomEventTypeRef [inherited]

Used in function calls for optimization purposes.

Definition at line 45 of file IAuditor.h.

Member Enumeration Documentation

enum IInterface::Status [inherited]

Return status.

Enumerator:

SUCCESS	Normal successful completion.
NO_INTERFACE	Requested interface is not available.
VERSMISMATCH	Requested interface version is incompatible.
LAST_ERROR	Last error.

Reimplemented in IConversionSvc, IConverter, and IDataProviderSvc.

Definition at line 113 of file IInterface.h.

00113                 {
00115     SUCCESS = 1,
00117     NO_INTERFACE,
00119     VERSMISMATCH,
00121     LAST_ERROR
00122   };

enum IAuditor::StandardEventType [inherited]

Defines the standard (= used by the framework) auditable event types.

Enumerator:

Initialize
ReInitialize
Execute
BeginRun
EndRun
Finalize
Start
Stop
ReStart

Definition at line 28 of file IAuditor.h.

00028                          {
00029     Initialize,
00030     ReInitialize,
00031     Execute,
00032     BeginRun,
00033     EndRun,
00034     Finalize,
00035     Start,
00036     Stop,
00037     ReStart
00038   };

Member Function Documentation

static const InterfaceID& IAuditorSvc::interfaceID ( ) [inline, static]

Retrieve interface ID.

Reimplemented from IAuditor.

Definition at line 24 of file IAuditorSvc.h.

00024 { return IID_IAuditorSvc; }

virtual IAuditor* IAuditorSvc::getAuditor ( const std::string & name ) [pure virtual]

management functionality: retrieve an Auditor

virtual const InterfaceID& IService::type ( ) const [pure virtual, inherited]

Retrieve ID of the Service. Not really used.

Implemented in Service.

virtual StatusCode IService::sysInitialize ( ) [pure virtual, inherited]

Initilize Service.

Implemented in Service.

virtual StatusCode IService::sysStart ( ) [pure virtual, inherited]

Start Service.

Implemented in Service.

virtual StatusCode IService::sysStop ( ) [pure virtual, inherited]

Stop Service.

Implemented in Service.

virtual StatusCode IService::sysFinalize ( ) [pure virtual, inherited]

Finalize Service.

Implemented in Service.

virtual StatusCode IService::sysReinitialize ( ) [pure virtual, inherited]

Re-initialize the Service.

Implemented in Service.

virtual StatusCode IService::sysRestart ( ) [pure virtual, inherited]

Re-start the Service.

Implemented in Service.

virtual StatusCode IService::configure ( ) [pure virtual, inherited]

Configuration (from OFFLINE to CONFIGURED).

Implemented in Service.

virtual StatusCode IService::initialize ( ) [pure virtual, inherited]

Initialization (from CONFIGURED to INITIALIZED).

Implemented in ConversionSvc, DataSvc, MinimalEventLoopMgr, and Service.

virtual StatusCode IService::start ( ) [pure virtual, inherited]

Start (from INITIALIZED to RUNNING).

Implemented in MinimalEventLoopMgr, and Service.

virtual StatusCode IService::stop ( ) [pure virtual, inherited]

Stop (from RUNNING to INITIALIZED).

Implemented in MinimalEventLoopMgr, and Service.

virtual StatusCode IService::finalize ( ) [pure virtual, inherited]

Finalize (from INITIALIZED to CONFIGURED).

Implemented in ConversionSvc, DataSvc, MinimalEventLoopMgr, and Service.

virtual StatusCode IService::terminate ( ) [pure virtual, inherited]

Initialization (from CONFIGURED to OFFLINE).

Implemented in Service.

virtual StatusCode IService::reinitialize ( ) [pure virtual, inherited]

Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).

Implemented in DataSvc, MinimalEventLoopMgr, and Service.

virtual StatusCode IService::restart ( ) [pure virtual, inherited]

Initialization (from RUNNING to RUNNING, via INITIALIZED).

Implemented in MinimalEventLoopMgr, and Service.

virtual Gaudi::StateMachine::State IService::FSMState ( ) const [pure virtual, inherited]

Get the current state.

Implemented in Service.

virtual Gaudi::StateMachine::State IService::targetFSMState ( ) const [pure virtual, inherited]

When we are in the middle of a transition, get the state where the transition is leading us.

Otherwise it returns the same state as state().

Implemented in Service.

virtual void IService::setServiceManager ( ISvcManager * ) [protected, pure virtual, inherited]

Implemented in Service.

virtual const std::string& INamedInterface::name ( ) const [pure virtual, inherited]

Retrieve the name of the instance.

Implemented in Algorithm, AlgTool, Auditor, and Service.

virtual StatusCode IInterface::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)			`[pure virtual, inherited]`

Query interfaces of Interface.

Parameters:

	riid	ID of Interface to be retrieved
	ppvInterface	Pointer to Location for interface pointer

Implemented in Algorithm, AlgTool, Auditor, ConversionSvc, Converter, DataSvc, EventSelectorDataStream, MinimalEventLoopMgr, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::addRef ( ) [pure virtual, inherited]

Increment the reference count of Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::release ( ) [pure virtual, inherited]

Release Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

virtual void IAuditor::before	(	StandardEventType	,
		INamedInterface *
	)			`[pure virtual, inherited]`

Audit the start of a standard "event".

virtual void IAuditor::before	(	StandardEventType	,
		const std::string &
	)			`[pure virtual, inherited]`

Audit the start of a standard "event" for callers that do not implement INamedInterface.

virtual void IAuditor::before	(	CustomEventTypeRef	,
		INamedInterface *
	)			`[pure virtual, inherited]`

Audit the start of a custom "event".

virtual void IAuditor::before	(	CustomEventTypeRef	,
		const std::string &
	)			`[pure virtual, inherited]`

Audit the start of a custom "event" for callers that do not implement INamedInterface.

virtual void IAuditor::after	(	StandardEventType	,
		INamedInterface *	,
		const StatusCode &	sc = `StatusCode(StatusCode::SUCCESS, true)`
	)			`[pure virtual, inherited]`

Audit the end of a standard "event".

virtual void IAuditor::after	(	StandardEventType	,
		const std::string &	,
		const StatusCode &	sc = `StatusCode(StatusCode::SUCCESS, true)`
	)			`[pure virtual, inherited]`

Audit the end of a standard "event" for callers that do not implement INamedInterface.

virtual void IAuditor::after	(	CustomEventTypeRef	,
		INamedInterface *	,
		const StatusCode &	sc = `StatusCode(StatusCode::SUCCESS, true)`
	)			`[pure virtual, inherited]`

Audit the end of a custom "event".

virtual void IAuditor::after	(	CustomEventTypeRef	,
		const std::string &	,
		const StatusCode &	sc = `StatusCode(StatusCode::SUCCESS, true)`
	)			`[pure virtual, inherited]`

Audit the end of a custom "event" for callers that do not implement INamedInterface.

virtual bool IAuditor::isEnabled ( ) const [pure virtual, inherited]

Tell if the auditor is enabled or not.

Implemented in Auditor.

virtual void IAuditor::beforeInitialize ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use before

Implemented in Auditor.

virtual void IAuditor::afterInitialize ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use after

Implemented in Auditor.

virtual void IAuditor::beforeReinitialize ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use before

Implemented in Auditor.

virtual void IAuditor::afterReinitialize ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use after

Implemented in Auditor.

virtual void IAuditor::beforeExecute ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use before

Implemented in Auditor.

virtual void IAuditor::afterExecute	(	INamedInterface *	,
		const StatusCode &
	)			`[pure virtual, inherited]`

Deprecated:: use after

Implemented in Auditor.

virtual void IAuditor::beforeBeginRun ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use before

Implemented in Auditor.

virtual void IAuditor::afterBeginRun ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use after

Implemented in Auditor.

virtual void IAuditor::beforeEndRun ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use before

Implemented in Auditor.

virtual void IAuditor::afterEndRun ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use after

Implemented in Auditor.

virtual void IAuditor::beforeFinalize ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use before

Implemented in Auditor.

virtual void IAuditor::afterFinalize ( INamedInterface * ) [pure virtual, inherited]

Deprecated:: use after

Implemented in Auditor.

virtual StatusCode IAuditor::sysInitialize ( ) [pure virtual, inherited]

Used by AuditorSvc.

Implemented in Auditor.

virtual StatusCode IAuditor::sysFinalize ( ) [pure virtual, inherited]

Used by AuditorSvc.

Implemented in Auditor.

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

/home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/IAuditorSvc.h

Generated on Mon Apr 11 19:57:08 2011 for GaudiKernel by 1.4.7

In This Package:

IAuditorSvc Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation