In This Package:

IAuditor Class Reference

The IAuditor is the interface implmented by the AlgAuditor base class. More...

#include <GaudiKernel/IAuditor.h>

Inheritance diagram for IAuditor:

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


Public Types
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...
	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...
Public Member Functions
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.
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.
Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID.

Detailed Description

The IAuditor is the interface implmented by the AlgAuditor base class.

Concrete auditors, derived from the AlgAuditor base class are controlled via this interface.

Author:: Marjorie Shapiro, LBNL
Marco Clemencic <marco.clemencic@cern.ch>

Definition at line 21 of file IAuditor.h.

Member Typedef Documentation

typedef std::string IAuditor::CustomEventType

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

Used in function calls for optimization purposes.

Definition at line 45 of file IAuditor.h.

Member Enumeration Documentation

enum IAuditor::StandardEventType

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   };

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   };

Member Function Documentation

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

Retrieve interface ID.

Reimplemented from INamedInterface.

Reimplemented in IAuditorSvc.

Definition at line 25 of file IAuditor.h.

00025 { return IID_IAuditor; }

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

Audit the start of a standard "event".

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

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

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

Audit the start of a custom "event".

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

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]`

Audit the end of a standard "event".

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

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]`

Audit the end of a custom "event".

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

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

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

Tell if the auditor is enabled or not.

Implemented in Auditor.

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

Deprecated:: use before

Implemented in Auditor.

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

Deprecated:: use after

Implemented in Auditor.

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

Deprecated:: use before

Implemented in Auditor.

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

Deprecated:: use after

Implemented in Auditor.

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

Deprecated:: use before

Implemented in Auditor.

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

Deprecated:: use after

Implemented in Auditor.

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

Deprecated:: use before

Implemented in Auditor.

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

Deprecated:: use after

Implemented in Auditor.

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

Deprecated:: use before

Implemented in Auditor.

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

Deprecated:: use after

Implemented in Auditor.

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

Deprecated:: use before

Implemented in Auditor.

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

Deprecated:: use after

Implemented in Auditor.

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

Used by AuditorSvc.

Implemented in Auditor.

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

Used by AuditorSvc.

Implemented in Auditor.

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.

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

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

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

In This Package:

IAuditor Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation