Base class from which all concrete auditor classes should be derived. More...

#include <GaudiKernel/Auditor.h>

Inheritance diagram for Auditor:

Collaboration diagram for Auditor:

Public Types
typedef Gaudi::PluginService::Factory< IAuditor , const std::string &, ISvcLocator >	Factory

typedef Gaudi::PluginService::Factory< IAuditor , const std::string &, ISvcLocator >	Factory

Public Types inherited from implements2< IAuditor, IProperty >
typedef implements2	base_class
	Typedef to this class. More...

typedef implements2	base_class
	Typedef to this class. More...

typedef extend_interfaces2< IAuditor, IProperty >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces2< IAuditor, IProperty >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from extend_interfaces2< IAuditor, IProperty >
typedef mpl::fold< typename IAuditor::iid::iids::type, typename IProperty::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

typedef mpl::fold< typename IAuditor::iid::iids::type, typename IProperty::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Types inherited from IAuditor
enum	StandardEventType { Initialize, ReInitialize, Execute, BeginRun, EndRun, Finalize, Start, Stop, ReStart, Initialize, ReInitialize, Execute, BeginRun, EndRun, Finalize, Start, Stop, ReStart }
	Defines the standard (= used by the framework) auditable event types. More...

enum	StandardEventType { Initialize, ReInitialize, Execute, BeginRun, EndRun, Finalize, Start, Stop, ReStart, Initialize, ReInitialize, Execute, BeginRun, EndRun, Finalize, Start, Stop, ReStart }
	Defines the standard (= used by the framework) auditable event types. More...

typedef std::string	CustomEventType
	Type used to allow users to specify a custom event to be audit. More...

typedef const CustomEventType &	CustomEventTypeRef
	Used in function calls for optimization purposes. More...

typedef std::string	CustomEventType
	Type used to allow users to specify a custom event to be audit. More...

typedef const CustomEventType &	CustomEventTypeRef
	Used in function calls for optimization purposes. More...

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

enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR, SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...

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

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

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

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

Public Member Functions
	Auditor (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...

virtual	~Auditor ()
	Destructor. More...

StatusCode	sysInitialize ()
	Initialization method invoked by the framework. More...

StatusCode	sysFinalize ()
	Finalization method invoked by the framework. More...

virtual void	before (StandardEventType, INamedInterface *)
	The following methods are meant to be implemented by the child class... More...

virtual void	before (StandardEventType, const std::string &)
	Audit the start of a standard "event" for callers that do not implement INamedInterface. More...

virtual void	before (CustomEventTypeRef, INamedInterface *)
	Audit the start of a custom "event". More...

virtual void	before (CustomEventTypeRef, const std::string &)
	Audit the start of a custom "event" for callers that do not implement INamedInterface. More...

virtual void	after (StandardEventType, INamedInterface *, const StatusCode &)
	Audit the end of a standard "event". More...

virtual void	after (StandardEventType, const std::string &, const StatusCode &)
	Audit the end of a standard "event" for callers that do not implement INamedInterface. More...

virtual void	after (CustomEventTypeRef, INamedInterface *, const StatusCode &)
	Audit the end of a custom "event". More...

virtual void	after (CustomEventTypeRef, const std::string &, const StatusCode &)
	Audit the end of a custom "event" for callers that do not implement INamedInterface. More...

virtual void	beforeInitialize (INamedInterface *)

virtual void	afterInitialize (INamedInterface *)

virtual void	beforeReinitialize (INamedInterface *)

virtual void	afterReinitialize (INamedInterface *)

virtual void	beforeExecute (INamedInterface *)

virtual void	afterExecute (INamedInterface *, const StatusCode &)

virtual void	beforeFinalize (INamedInterface *)

virtual void	afterFinalize (INamedInterface *)

virtual void	beforeBeginRun (INamedInterface *)

virtual void	afterBeginRun (INamedInterface *)

virtual void	beforeEndRun (INamedInterface *)

virtual void	afterEndRun (INamedInterface *)

virtual StatusCode	initialize ()

virtual StatusCode	finalize ()

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

virtual bool	isEnabled () const
	Tell if the auditor is enabled or not. More...

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

int	outputLevel () const
	Retrieve the output level of current auditor. More...

void	setOutputLevel (int level)
	Set the output level for current auditor. More...

SmartIF< ISvcLocator > &	serviceLocator () const
	The standard service locator. More...

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

virtual StatusCode	setProperty (const Property &p)
	Set a value of a property of an auditor. More...

virtual StatusCode	setProperty (const std::string &s)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	getProperty (Property *p) const
	Get the value of a property. More...

virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...

virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Implementation of IProperty::getProperty. More...

const std::vector< Property * > &	getProperties () const
	Get all properties. More...

virtual bool	hasProperty (const std::string &name) const
	Implementation of IProperty::hasProperty. More...

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

StatusCode	setProperties ()
	Set the auditor's properties. More...

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

	Auditor (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...

virtual	~Auditor ()
	Destructor. More...

StatusCode	sysInitialize ()
	Initialization method invoked by the framework. More...

StatusCode	sysFinalize ()
	Finalization method invoked by the framework. More...

virtual void	before (StandardEventType, INamedInterface *)
	The following methods are meant to be implemented by the child class... More...

virtual void	before (StandardEventType, const std::string &)
	Audit the start of a standard "event" for callers that do not implement INamedInterface. More...

virtual void	before (CustomEventTypeRef, INamedInterface *)
	Audit the start of a custom "event". More...

virtual void	before (CustomEventTypeRef, const std::string &)
	Audit the start of a custom "event" for callers that do not implement INamedInterface. More...

virtual void	after (StandardEventType, INamedInterface *, const StatusCode &)
	Audit the end of a standard "event". More...

virtual void	after (StandardEventType, const std::string &, const StatusCode &)
	Audit the end of a standard "event" for callers that do not implement INamedInterface. More...

virtual void	after (CustomEventTypeRef, INamedInterface *, const StatusCode &)
	Audit the end of a custom "event". More...

virtual void	after (CustomEventTypeRef, const std::string &, const StatusCode &)
	Audit the end of a custom "event" for callers that do not implement INamedInterface. More...

virtual void	beforeInitialize (INamedInterface *)

virtual void	afterInitialize (INamedInterface *)

virtual void	beforeReinitialize (INamedInterface *)

virtual void	afterReinitialize (INamedInterface *)

virtual void	beforeExecute (INamedInterface *)

virtual void	afterExecute (INamedInterface *, const StatusCode &)

virtual void	beforeFinalize (INamedInterface *)

virtual void	afterFinalize (INamedInterface *)

virtual void	beforeBeginRun (INamedInterface *)

virtual void	afterBeginRun (INamedInterface *)

virtual void	beforeEndRun (INamedInterface *)

virtual void	afterEndRun (INamedInterface *)

virtual StatusCode	initialize ()

virtual StatusCode	finalize ()

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

virtual bool	isEnabled () const
	Tell if the auditor is enabled or not. More...

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

int	outputLevel () const
	Retrieve the output level of current auditor. More...

void	setOutputLevel (int level)
	Set the output level for current auditor. More...

SmartIF< ISvcLocator > &	serviceLocator () const
	The standard service locator. More...

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

virtual StatusCode	setProperty (const Property &p)
	Set a value of a property of an auditor. More...

virtual StatusCode	setProperty (const std::string &s)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	getProperty (Property *p) const
	Get the value of a property. More...

virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...

virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Implementation of IProperty::getProperty. More...

const std::vector< Property * > &	getProperties () const
	Get all properties. More...

virtual bool	hasProperty (const std::string &name) const
	Implementation of IProperty::hasProperty. More...

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

StatusCode	setProperties ()
	Set the auditor's properties. More...

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

Public Member Functions inherited from extend_interfaces2< IAuditor, IProperty >
virtual	~extend_interfaces2 ()
	Virtual destructor. More...

virtual	~extend_interfaces2 ()
	Virtual destructor. More...

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

	DeclareInterfaceID (IAuditor, 3, 0)
	InterfaceID. More...

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

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

	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. 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...

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...

Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 1)
	InterfaceID. More...

	DeclareInterfaceID (IProperty, 2, 1)
	InterfaceID. More...

Private Member Functions
	Auditor (const Auditor &a)

Auditor &	operator= (const Auditor &rhs)

	Auditor (const Auditor &a)

Auditor &	operator= (const Auditor &rhs)

Private Attributes
std::string	m_name
	Auditor's name for identification. More...

SmartIF< IMessageSvc >	m_MS
	Message service. More...

SmartIF< ISvcLocator >	m_pSvcLocator
	Pointer to service locator service. More...

PropertyMgr *	m_PropertyMgr
	For management of properties. More...

int	m_outputLevel
	Auditor output level. More...

bool	m_isEnabled
	Auditor is enabled flag. More...

bool	m_isInitialized
	Auditor has been initialized flag. More...

bool	m_isFinalized
	Auditor has been finalized flag. More...

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

static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Detailed Description

Base class from which all concrete auditor classes should be derived.

The only base class functionality which may be used in the constructor of a concrete auditor is the declaration of member variables as properties. All other functionality, i.e. the use of services, may be used only in initialize() and afterwards.

Author: David Quarrie

Date: 2000

Author: Marco Clemencic

Date: 2008-03

Definition at line 34 of file Auditor.h.

Member Typedef Documentation

typedef Gaudi::PluginService::Factory<IAuditor*, const std::string&, ISvcLocator*> Auditor::Factory

Definition at line 39 of file Auditor.h.

typedef Gaudi::PluginService::Factory<IAuditor*, const std::string&, ISvcLocator*> Auditor::Factory

Definition at line 39 of file Auditor.h.

Constructor & Destructor Documentation

Auditor::Auditor	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Constructor.

Parameters

name	The algorithm object's name
svcloc	A pointer to a service location service

Definition at line 12 of file Auditor.cpp.

 : m_name(name),
   m_pSvcLocator(pSvcLocator),
   m_isEnabled(true),
   m_isInitialized(false),
   m_isFinalized(false)
 {
   m_PropertyMgr = new PropertyMgr();
 
   // Declare common Auditor properties with their defaults
   declareProperty( "OutputLevel", m_outputLevel = MSG::NIL);
   declareProperty( "Enable", m_isEnabled = true);
 }

Auditor::~Auditor ( )

virtual

Destructor.

Definition at line 27 of file Auditor.cpp.

                   {
   delete m_PropertyMgr;
 }

Auditor::Auditor ( const Auditor & a )

private

Auditor::Auditor	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Constructor.

Parameters

name	The algorithm object's name
svcloc	A pointer to a service location service

virtual Auditor::~Auditor ( )

virtual

Destructor.

Auditor::Auditor ( const Auditor & a )

private

Member Function Documentation

void Auditor::after	(	StandardEventType	,
		INamedInterface *	,
		const StatusCode &	sc
	)

virtual

Audit the end of a standard "event".

Implements IAuditor.

Reimplemented in Google::AuditorBase, PerfMonAuditor, IntelProfilerAuditor, TimingAuditor, and CommonAuditor.

Definition at line 120 of file Auditor.cpp.

                                                                                     {
   switch (evt) {
   case Initialize:   afterInitialize(obj);   break;
   case ReInitialize: afterReinitialize(obj); break;
   case Execute:      afterExecute(obj, sc);  break;
   case BeginRun:     afterBeginRun(obj);     break;
   case EndRun:       afterEndRun(obj);       break;
   case Finalize:     afterFinalize(obj);     break;
   case Start:        break;
   case Stop:         break;
   case ReStart:      break;
   default: break ;// do nothing
   }
 }

virtual void Auditor::after	(	StandardEventType	,
		INamedInterface *	,
		const StatusCode &	sc
	)

virtual

Audit the end of a standard "event".

Implements IAuditor.

Reimplemented in Google::AuditorBase, PerfMonAuditor, IntelProfilerAuditor, TimingAuditor, and CommonAuditor.

void Auditor::after	(	StandardEventType	,
		const std::string &	,
		const StatusCode &	sc
	)

virtual

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

Implements IAuditor.

Reimplemented in Google::AuditorBase, and CommonAuditor.

Definition at line 134 of file Auditor.cpp.

134 {}

virtual void Auditor::after	(	StandardEventType	,
		const std::string &	,
		const StatusCode &	sc
	)

virtual

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

Implements IAuditor.

Reimplemented in Google::AuditorBase, and CommonAuditor.

void Auditor::after	(	CustomEventTypeRef	,
		INamedInterface *	,
		const StatusCode &	sc
	)

virtual

Audit the end of a custom "event".

Implements IAuditor.

Reimplemented in Google::AuditorBase, and CommonAuditor.

Definition at line 136 of file Auditor.cpp.

136 {}

virtual void Auditor::after	(	CustomEventTypeRef	,
		INamedInterface *	,
		const StatusCode &	sc
	)

virtual

Audit the end of a custom "event".

Implements IAuditor.

Reimplemented in Google::AuditorBase, and CommonAuditor.

void Auditor::after	(	CustomEventTypeRef	,
		const std::string &	,
		const StatusCode &	sc
	)

virtual

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

Implements IAuditor.

Reimplemented in Google::AuditorBase, TimingAuditor, and CommonAuditor.

Definition at line 137 of file Auditor.cpp.

137 {}

virtual void Auditor::after	(	CustomEventTypeRef	,
		const std::string &	,
		const StatusCode &	sc
	)

virtual

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

Implements IAuditor.

Reimplemented in Google::AuditorBase, TimingAuditor, and CommonAuditor.

void Auditor::afterBeginRun ( INamedInterface * )

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase.

Definition at line 153 of file Auditor.cpp.

153 {}

virtual void Auditor::afterBeginRun ( INamedInterface * )

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase.

virtual void Auditor::afterEndRun ( INamedInterface * )

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase.

void Auditor::afterEndRun ( INamedInterface * )

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase.

Definition at line 157 of file Auditor.cpp.

157 {}

void Auditor::afterExecute	(	INamedInterface *	,
		const StatusCode &
	)

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase, AlgContextAuditor, and AlgErrorAuditor.

Definition at line 149 of file Auditor.cpp.

149 {}

virtual void Auditor::afterExecute	(	INamedInterface *	,
		const StatusCode &
	)

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase, AlgContextAuditor, and AlgErrorAuditor.

void Auditor::afterFinalize ( INamedInterface * )

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase, and AlgContextAuditor.

Definition at line 161 of file Auditor.cpp.

161 {}

virtual void Auditor::afterFinalize ( INamedInterface * )

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase, and AlgContextAuditor.

void Auditor::afterInitialize ( INamedInterface * )

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase, and AlgContextAuditor.

Definition at line 141 of file Auditor.cpp.

141 {}

virtual void Auditor::afterInitialize ( INamedInterface * )

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase, and AlgContextAuditor.

void Auditor::afterReinitialize ( INamedInterface * )

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase.

Definition at line 145 of file Auditor.cpp.

145 {}

virtual void Auditor::afterReinitialize ( INamedInterface * )

virtual

Deprecated:: use after

Implements IAuditor.

Reimplemented in Google::AuditorBase.

virtual void Auditor::before	(	StandardEventType	,
		INamedInterface *
	)

virtual

The following methods are meant to be implemented by the child class...

Implements IAuditor.

Reimplemented in PerfMonAuditor, Google::AuditorBase, IntelProfilerAuditor, TimingAuditor, and CommonAuditor.

void Auditor::before	(	StandardEventType	evt,
		INamedInterface *	obj
	)

virtual

The following methods are meant to be implemented by the child class...

Implements IAuditor.

Reimplemented in PerfMonAuditor, Google::AuditorBase, IntelProfilerAuditor, TimingAuditor, and CommonAuditor.

Definition at line 100 of file Auditor.cpp.

                                                                {
   switch (evt) {
   case Initialize:   beforeInitialize(obj);   break;
   case ReInitialize: beforeReinitialize(obj); break;
   case Execute:      beforeExecute(obj);      break;
   case BeginRun:     beforeBeginRun(obj);     break;
   case EndRun:       beforeEndRun(obj);       break;
   case Finalize:     beforeFinalize(obj);     break;
   case Start:        break;
   case Stop:         break;
   case ReStart:      break;
   default: break ;// do nothing
   }
 }

void Auditor::before	(	StandardEventType	,
		const std::string &
	)

virtual

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

Implements IAuditor.

Reimplemented in Google::AuditorBase, and CommonAuditor.

Definition at line 114 of file Auditor.cpp.

114 {}

virtual void Auditor::before	(	StandardEventType	,
		const std::string &
	)

virtual

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

Implements IAuditor.

Reimplemented in Google::AuditorBase, and CommonAuditor.

void Auditor::before	(	CustomEventTypeRef	,
		INamedInterface *
	)

virtual

Audit the start of a custom "event".

Implements IAuditor.

Reimplemented in Google::AuditorBase, and CommonAuditor.

Definition at line 116 of file Auditor.cpp.

116 {}

virtual void Auditor::before	(	CustomEventTypeRef	,
		INamedInterface *
	)

virtual

Audit the start of a custom "event".

Implements IAuditor.

Reimplemented in Google::AuditorBase, and CommonAuditor.

virtual void Auditor::before	(	CustomEventTypeRef	,
		const std::string &
	)

virtual

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

Implements IAuditor.

Reimplemented in Google::AuditorBase, TimingAuditor, and CommonAuditor.

void Auditor::before	(	CustomEventTypeRef	,
		const std::string &
	)

virtual

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

Implements IAuditor.

Reimplemented in Google::AuditorBase, TimingAuditor, and CommonAuditor.

Definition at line 117 of file Auditor.cpp.

117 {}

void Auditor::beforeBeginRun ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase.

Definition at line 151 of file Auditor.cpp.

151 {}

virtual void Auditor::beforeBeginRun ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase.

virtual void Auditor::beforeEndRun ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase.

void Auditor::beforeEndRun ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase.

Definition at line 155 of file Auditor.cpp.

155 {}

virtual void Auditor::beforeExecute ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase, AlgContextAuditor, and AlgErrorAuditor.

void Auditor::beforeExecute ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase, AlgContextAuditor, and AlgErrorAuditor.

Definition at line 147 of file Auditor.cpp.

147 {}

void Auditor::beforeFinalize ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase, and AlgContextAuditor.

Definition at line 159 of file Auditor.cpp.

159 {}

virtual void Auditor::beforeFinalize ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase, and AlgContextAuditor.

void Auditor::beforeInitialize ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase, and AlgContextAuditor.

Definition at line 139 of file Auditor.cpp.

139 {}

virtual void Auditor::beforeInitialize ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase, and AlgContextAuditor.

void Auditor::beforeReinitialize ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase.

Definition at line 143 of file Auditor.cpp.

143 {}

virtual void Auditor::beforeReinitialize ( INamedInterface * )

virtual

Deprecated:: use before

Implements IAuditor.

Reimplemented in Google::AuditorBase.

template<class T >

Property* Auditor::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)		const

inline

Declare the named property.

MyAuditor( ... )
   : Auditor ( ...  )
   , m_property1   ( ... )
   , m_property2   ( ... )
 {
   // declare the property
   declareProperty( "Property1" , m_property1 , "Doc for property #1" ) ;
   // declare the property and attach the handler to it
   declareProperty( "Property2" , m_property2 , "Doc for property #2" )
      -> declareUpdateHandler( &MyAuditor::handler_2 ) ;
 }

See also: PropertyMgr; PropertyMgr::declareProperty

Parameters

name	the property name
property	the property itself,
doc	the documentation string

Returns: the actual property objects

Definition at line 237 of file Auditor.h.

                                                       {
     return m_PropertyMgr->declareProperty(name, property, doc);
   }

template<class T >

Property* Auditor::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)		const

inline

Declare the named property.

MyAuditor( ... )
   : Auditor ( ...  )
   , m_property1   ( ... )
   , m_property2   ( ... )
 {
   // declare the property
   declareProperty( "Property1" , m_property1 , "Doc for property #1" ) ;
   // declare the property and attach the handler to it
   declareProperty( "Property2" , m_property2 , "Doc for property #2" )
      -> declareUpdateHandler( &MyAuditor::handler_2 ) ;
 }

See also: PropertyMgr; PropertyMgr::declareProperty

Parameters

name	the property name
property	the property itself,
doc	the documentation string

Returns: the actual property objects

Definition at line 237 of file Auditor.h.

                                                       {
     return m_PropertyMgr->declareProperty(name, property, doc);
   }

virtual StatusCode Auditor::finalize ( )

virtual

Reimplemented in PerfMonAuditor, Google::AuditorBase, TimingAuditor, AlgContextAuditor, and AlgErrorAuditor.

StatusCode Auditor::finalize ( )

virtual

Reimplemented in PerfMonAuditor, Google::AuditorBase, TimingAuditor, AlgContextAuditor, and AlgErrorAuditor.

Definition at line 211 of file Auditor.cpp.

                              {
   m_MS = 0; // release message service
   return StatusCode::SUCCESS;
 }

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

virtual

Get all properties.

Implements IProperty.

Definition at line 272 of file Auditor.cpp.

                                                           {
   return m_PropertyMgr->getProperties();
 }

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

virtual

Get all properties.

Implements IProperty.

StatusCode Auditor::getProperty ( Property * p ) const

virtual

Get the value of a property.

Implements IProperty.

Definition at line 263 of file Auditor.cpp.

                                                  {
   return m_PropertyMgr->getProperty(p);
 }

virtual StatusCode Auditor::getProperty ( Property * p ) const

virtual

Get the value of a property.

Implements IProperty.

virtual const Property& Auditor::getProperty ( const std::string & name ) const

virtual

Get the property by name.

Implements IProperty.

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

virtual

Get the property by name.

Implements IProperty.

Definition at line 266 of file Auditor.cpp.

                                                                 {
   return m_PropertyMgr->getProperty(name);
 }

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

virtual

Implementation of IProperty::getProperty.

Implements IProperty.

Definition at line 269 of file Auditor.cpp.

                                                                        {
   return m_PropertyMgr->getProperty(n,v);
 }

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

virtual

Implementation of IProperty::getProperty.

Implements IProperty.

virtual bool Auditor::hasProperty ( const std::string & name ) const

virtual

Implementation of IProperty::hasProperty.

Implements IProperty.

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

virtual

Implementation of IProperty::hasProperty.

Implements IProperty.

Definition at line 275 of file Auditor.cpp.

                                                      {
   return m_PropertyMgr->hasProperty(name);
 }

virtual StatusCode Auditor::initialize ( )

virtual

Reimplemented in Google::HeapChecker, PerfMonAuditor, Google::AuditorBase, TimingAuditor, AlgContextAuditor, IntelProfilerAuditor, AlgErrorAuditor, ChronoAuditor, and MemStatAuditor.

StatusCode Auditor::initialize ( )

virtual

Reimplemented in Google::HeapChecker, PerfMonAuditor, Google::AuditorBase, TimingAuditor, AlgContextAuditor, IntelProfilerAuditor, AlgErrorAuditor, ChronoAuditor, and MemStatAuditor.

Definition at line 95 of file Auditor.cpp.

                                {
   return StatusCode::SUCCESS;
 }

virtual bool Auditor::isEnabled ( ) const

virtual

Tell if the auditor is enabled or not.

Implements IAuditor.

bool Auditor::isEnabled ( ) const

virtual

Tell if the auditor is enabled or not.

Implements IAuditor.

Definition at line 220 of file Auditor.cpp.

                                {
   return m_isEnabled;
 }

SmartIF< IMessageSvc > & Auditor::msgSvc ( ) const

The standard message service.

Returns a pointer to the standard message service. May not be invoked before sysInitialize() has been invoked.

Definition at line 224 of file Auditor.cpp.

                                             {
   return m_MS;
 }

SmartIF<IMessageSvc>& Auditor::msgSvc ( ) const

The standard message service.

Returns a pointer to the standard message service. May not be invoked before sysInitialize() has been invoked.

const std::string & Auditor::name ( ) const

virtual

Retrieve the name of the instance.

Implements INamedInterface.

Definition at line 216 of file Auditor.cpp.

                                      {
   return m_name;
 }

virtual const std::string& Auditor::name ( ) const

virtual

Retrieve the name of the instance.

Implements INamedInterface.

Auditor& Auditor::operator= ( const Auditor & rhs )

private

Auditor& Auditor::operator= ( const Auditor & rhs )

private

int Auditor::outputLevel ( ) const

inline

Retrieve the output level of current auditor.

Definition at line 105 of file Auditor.h.

105 { return m_outputLevel; }

Auditor::m_outputLevel

int m_outputLevel

Auditor output level.

Definition: Auditor.h:249

int Auditor::outputLevel ( ) const

inline

Retrieve the output level of current auditor.

Definition at line 105 of file Auditor.h.

105 { return m_outputLevel; }

Auditor::m_outputLevel

int m_outputLevel

Auditor output level.

Definition: Auditor.h:249

template<class T >

StatusCode Auditor::service	(	const std::string &	name,
		T *&	svc,
		bool	createIf = `false`
	)		const

inline

Access a service by name, creating it if it doesn't already exist.

Definition at line 119 of file Auditor.h.

                                                                                     {
     SmartIF<T> ptr(serviceLocator()->service(name, createIf));
     if (ptr.isValid()) {
       svc = ptr.get();
       svc->addRef();
       return StatusCode::SUCCESS;
     }
     // else
     svc = 0;
     return StatusCode::FAILURE;
   }

template<class T >

StatusCode Auditor::service	(	const std::string &	name,
		T *&	svc,
		bool	createIf = `false`
	)		const

inline

Access a service by name, creating it if it doesn't already exist.

Definition at line 119 of file Auditor.h.

                                                                                     {
     SmartIF<T> ptr(serviceLocator()->service(name, createIf));
     if (ptr.isValid()) {
       svc = ptr.get();
       svc->addRef();
       return StatusCode::SUCCESS;
     }
     // else
     svc = 0;
     return StatusCode::FAILURE;
   }

SmartIF<ISvcLocator>& Auditor::serviceLocator ( ) const

The standard service locator.

Returns a pointer to the service locator service. This service may be used by an auditor to request any services it requires in addition to those provided by default.

SmartIF< ISvcLocator > & Auditor::serviceLocator ( ) const

The standard service locator.

Returns a pointer to the service locator service. This service may be used by an auditor to request any services it requires in addition to those provided by default.

Definition at line 234 of file Auditor.cpp.

                                                     {
   return m_pSvcLocator;
 }

void Auditor::setOutputLevel ( int level )

Set the output level for current auditor.

void Auditor::setOutputLevel ( int level )

Set the output level for current auditor.

Definition at line 228 of file Auditor.cpp.

                                         {
   if( m_MS != 0) {
     m_MS->setOutputLevel( name(), level );
   }
 }

StatusCode Auditor::setProperties ( )

Set the auditor's properties.

This method requests the job options service to set the values of any declared properties. The method is invoked from within sysInitialize() by the framework and does not need to be explicitly called by a concrete auditor.

Definition at line 239 of file Auditor.cpp.

                                   {
   if( m_pSvcLocator != 0 )    {
     IJobOptionsSvc* jos;
     StatusCode sc = service("JobOptionsSvc", jos);
     if( sc.isSuccess() )    {
       jos->setMyProperties( name(), this ).ignore();
       jos->release();
       return StatusCode::SUCCESS;
     }
   }
   return StatusCode::FAILURE;
 }

StatusCode Auditor::setProperties ( )

Set the auditor's properties.

This method requests the job options service to set the values of any declared properties. The method is invoked from within sysInitialize() by the framework and does not need to be explicitly called by a concrete auditor.

StatusCode Auditor::setProperty ( const Property & p )

virtual

Set a value of a property of an auditor.

Implements IProperty.

Definition at line 254 of file Auditor.cpp.

                                                  {
   return m_PropertyMgr->setProperty(p);
 }

virtual StatusCode Auditor::setProperty ( const Property & p )

virtual

Set a value of a property of an auditor.

Implements IProperty.

virtual StatusCode Auditor::setProperty ( const std::string & s )

virtual

Implementation of IProperty::setProperty.

Implements IProperty.

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

virtual

Implementation of IProperty::setProperty.

Implements IProperty.

Definition at line 257 of file Auditor.cpp.

                                                   {
   return m_PropertyMgr->setProperty(s);
 }

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

virtual

Implementation of IProperty::setProperty.

Implements IProperty.

Definition at line 260 of file Auditor.cpp.

                                                                       {
   return m_PropertyMgr->setProperty(n,v);
 }

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

virtual

Implementation of IProperty::setProperty.

Implements IProperty.

template<class TYPE >

StatusCode Auditor::setProperty	(	const std::string &	name,
		const TYPE &	value
	)

inline

set the property form the value

std::vector<double> data = ... ;
setProperty( "Data" , data ) ;
std::map<std::string,double> cuts = ... ;
setProperty( "Cuts" , cuts ) ;
std::map<std::string,std::string> dict = ... ;
setProperty( "Dictionary" , dict ) ;

Note: the interface IProperty allows setting of the properties either directly from other properties or from strings only

This is very convenient in resetting of the default properties in the derived classes. E.g. without this method one needs to convert everything into strings to use IProperty::setProperty

setProperty ( "OutputLevel" , "1"    ) ;
setProperty ( "Enable"      , "True" ) ;
setProperty ( "ErrorMax"    , "10"   ) ;

For simple cases it is more or less ok, but for complicated properties it is just ugly..

Parameters

name	name of the property
value	value of the property

See also: Gaudi::Utils::setProperty

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

Date: 2007-05-13

Definition at line 197 of file Auditor.h.

199 { return Gaudi::Utils::setProperty ( m_PropertyMgr , name , value ) ; }

Gaudi::Utils::setProperty

StatusCode setProperty(IProperty *component, const std::string &name, const TYPE &value, const std::string &doc)

simple function to set the property of the given object from the value

Definition: Property.h:1212

Auditor::name

virtual const std::string & name() const

Retrieve the name of the instance.

Definition: Auditor.cpp:216

dump_component_properties.value

list value

Definition: dump_component_properties.py:12

Auditor::m_PropertyMgr

PropertyMgr * m_PropertyMgr

For management of properties.

Definition: Auditor.h:248

template<class TYPE >

StatusCode Auditor::setProperty	(	const std::string &	name,
		const TYPE &	value
	)

inline

set the property form the value

std::vector<double> data = ... ;
setProperty( "Data" , data ) ;
std::map<std::string,double> cuts = ... ;
setProperty( "Cuts" , cuts ) ;
std::map<std::string,std::string> dict = ... ;
setProperty( "Dictionary" , dict ) ;

Note: the interface IProperty allows setting of the properties either directly from other properties or from strings only

This is very convenient in resetting of the default properties in the derived classes. E.g. without this method one needs to convert everything into strings to use IProperty::setProperty

setProperty ( "OutputLevel" , "1"    ) ;
setProperty ( "Enable"      , "True" ) ;
setProperty ( "ErrorMax"    , "10"   ) ;

For simple cases it is more or less ok, but for complicated properties it is just ugly..

Parameters

name	name of the property
value	value of the property

See also: Gaudi::Utils::setProperty

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

Date: 2007-05-13

Definition at line 197 of file Auditor.h.

199 { return Gaudi::Utils::setProperty ( m_PropertyMgr , name , value ) ; }

Gaudi::Utils::setProperty

StatusCode setProperty(IProperty *component, const std::string &name, const TYPE &value, const std::string &doc)

simple function to set the property of the given object from the value

Definition: Property.h:1212

Auditor::name

virtual const std::string & name() const

Retrieve the name of the instance.

Definition: Auditor.cpp:216

dump_component_properties.value

list value

Definition: dump_component_properties.py:12

Auditor::m_PropertyMgr

PropertyMgr * m_PropertyMgr

For management of properties.

Definition: Auditor.h:248

StatusCode Auditor::sysFinalize ( )

virtual

Finalization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself.

Implements IAuditor.

StatusCode Auditor::sysFinalize ( )

virtual

Finalization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself.

RETURN !!!

catch GaudiExeption

(1) perform the printout of message

(2) print the exception itself (NB! - GaudiException is a linked list of all "previous exceptions")

catch std::exception

(1) perform the printout of message

(2) print the exception itself

catch unknown exception

(1) perform the printout

Implements IAuditor.

Definition at line 163 of file Auditor.cpp.

                                 {
   StatusCode sc = StatusCode::SUCCESS;
   try{
     //
     // Invoke the finalize() method of the derived class if
     // it has been initialized.
     if ( m_isInitialized && ! m_isFinalized ) {
       m_isFinalized = true;
       sc = finalize();
       if( !sc.isSuccess() )  return StatusCode::FAILURE;
     }
     return sc;                                               
     //
   }
   catch( const GaudiException& Exception )                   
     {
       MsgStream log ( msgSvc() , name() + ".sysFinalize()" );
       log << MSG::FATAL
       << " Exception with tag=" << Exception.tag() << " is catched " << endmsg;
       MsgStream logEx ( msgSvc() , Exception.tag() );
       logEx << MSG::ERROR
         << Exception  << endmsg;
     }
   catch( const std::exception& Exception )                   
     {
       MsgStream log ( msgSvc() , name() + ".sysFinalize()" );
       log << MSG::FATAL
       << " Standard std::exception is caught " << endmsg;
       MsgStream logEx ( msgSvc() , name() + "*std::exception*" );
       logEx << MSG::ERROR
         << Exception.what()  << endmsg;
     }
   catch( ... )                                                
     {
       MsgStream log ( msgSvc() , name() + ".sysFinalize()" );
       log << MSG::FATAL
       << " UNKNOWN Exception is caught " << endmsg;
     }
   return StatusCode::FAILURE ;
 }

StatusCode Auditor::sysInitialize ( )

virtual

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself.

Implements IAuditor.

StatusCode Auditor::sysInitialize ( )

virtual

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself.

RETURN !!!

catch Gaudi Exception

(1) perform the printout of message

(2) print the exception itself (NB! - GaudiException is a linked list of all "previous exceptions")

catch std::exception

(1) perform the printout of message

(2) print the exception itself (NB! - GaudiException is a linked list of all "previous exceptions")

(1) perform the printout

Implements IAuditor.

Definition at line 32 of file Auditor.cpp.

                                   {
   StatusCode sc;
 
   // Bypass the initialization if the auditor is disabled or
   // has already been initialized.
   if ( isEnabled( ) && ! m_isInitialized ) {
 
     // Setup the default service ... this should be upgraded so as to be configurable.
     if( m_pSvcLocator == 0 )
       return StatusCode::FAILURE;
 
     // Set up message service
     m_MS = serviceLocator(); // get default message service
     if( !m_MS.isValid() )  return StatusCode::FAILURE;
 
     // Set the Auditor's properties
     sc = setProperties();
     if( !sc.isSuccess() )  return StatusCode::FAILURE;
 
     // Check current outputLevel to eventually inform the MessagsSvc
     if( m_outputLevel != MSG::NIL ) {
       setOutputLevel( m_outputLevel );
     }
 
     {
       try{
     // Invoke the initialize() method of the derived class
     sc = initialize();
     if( !sc.isSuccess() )  return StatusCode::FAILURE;
         m_isInitialized = true;
 
         return sc;                                               
       }
       catch ( const GaudiException& Exception )                  
         {
       MsgStream log ( msgSvc() , name() + ".sysInitialize()" );
       log << MSG::FATAL << " Exception with tag=" << Exception.tag() << " is catched " << endmsg;
       MsgStream logEx ( msgSvc() , Exception.tag() );
       logEx << MSG::ERROR << Exception  << endmsg;
         }
       catch( const std::exception& Exception )                   
         {
       MsgStream log ( msgSvc() , name() + ".sysInitialize()" );
       log << MSG::FATAL << " Standard std::exception is catched " << endmsg;
       MsgStream logEx ( msgSvc() , name() + "*std::exception*" );
       logEx << MSG::ERROR << Exception.what()  << endmsg;
         }
       catch(...)
         {
       MsgStream log ( msgSvc() , name() + ".sysInitialize()" );
       log << MSG::FATAL << " UNKNOWN Exception is  catched " << endmsg;
         }
     }
   }
   return StatusCode::FAILURE;
 }

Member Data Documentation

bool Auditor::m_isEnabled

private

Auditor is enabled flag.

Definition at line 250 of file Auditor.h.

bool Auditor::m_isFinalized

private

Auditor has been finalized flag.

Definition at line 252 of file Auditor.h.

bool Auditor::m_isInitialized

private

Auditor has been initialized flag.

Definition at line 251 of file Auditor.h.

SmartIF< IMessageSvc > Auditor::m_MS

mutableprivate

Message service.

Definition at line 246 of file Auditor.h.

std::string Auditor::m_name

private

Auditor's name for identification.

Definition at line 244 of file Auditor.h.

int Auditor::m_outputLevel

private

Auditor output level.

Definition at line 249 of file Auditor.h.

PropertyMgr * Auditor::m_PropertyMgr

private

For management of properties.

Definition at line 248 of file Auditor.h.

SmartIF< ISvcLocator > Auditor::m_pSvcLocator

mutableprivate

Pointer to service locator service.

Definition at line 247 of file Auditor.h.

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

InstallArea/x86_64-slc6-gcc48-opt/include/GaudiKernel/Auditor.h
GaudiKernel/src/Lib/Auditor.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation