Base class with common functionalities shared by few auditor implementations. More...

#include <src/CommonAuditor.h>

Inheritance diagram for CommonAuditor:

Collaboration diagram for CommonAuditor:

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

virtual	~CommonAuditor ()
	Destructor. More...

"before" Auditor hooks
The default behavior is to fall back on the version accepting 2 strings, which must be implemented in the derived class.
virtual void	before (StandardEventType evt, const std::string &caller)
	Audit the start of a standard "event" for callers that do not implement INamedInterface. More...

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

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

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

"after" Auditor hooks
The default behavior is to fall back on the version accepting 2 strings, which must be implemented in the derived class.
virtual void	after (StandardEventType evt, const std::string &caller, const StatusCode &sc)
	Audit the end of a standard "event" for callers that do not implement INamedInterface. More...

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

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

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

Public Member Functions inherited from Auditor
	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	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...

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

Public Member Functions inherited from IAuditor
	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...

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

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

Protected Member Functions
virtual void	i_before (CustomEventTypeRef evt, const std::string &caller)=0
	catch all "before" method, implemented in the derived class More...

virtual void	i_after (CustomEventTypeRef evt, const std::string &caller, const StatusCode &sc)=0
	catch all "after" method, implemented in the derived class More...

bool	i_auditEventType (const std::string &evt)
	Check if we are requested to audit the passed event type. More...

void	i_updateCustomTypes (Property &)
	Update handler for the obsolete property CustomEventTypes. More...

Protected Attributes
StringArrayProperty	m_types

StringArrayProperty	m_customTypes

Additional Inherited Members
Public Types inherited from Auditor
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 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...

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

Public Types inherited from IAuditor
enum	StandardEventType { 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...

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< iid >	ext_iids
	Extra interfaces. More...

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

Detailed Description

Base class with common functionalities shared by few auditor implementations.

Author: Marco Clemencic

Definition at line 5 of file CommonAuditor.h.

Constructor & Destructor Documentation

CommonAuditor::CommonAuditor	(	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 3 of file CommonAuditor.cpp.

                                                                       : Auditor(name, svcloc) {
   declareProperty("EventTypes", m_types,
                   "List of event types to audit ([]=all, ['none']=none)");
   declareProperty("CustomEventTypes", m_customTypes,
                   "OBSOLETE, use EventTypes instead")->declareUpdateHandler(&CommonAuditor::i_updateCustomTypes, this);
 }

CommonAuditor::~CommonAuditor ( )

virtual

Destructor.

Definition at line 10 of file CommonAuditor.cpp.

10 {}

Member Function Documentation

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

virtual

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

Reimplemented from Auditor.

Definition at line 39 of file CommonAuditor.cpp.

 {
   after(toStr(evt), caller, sc);
 }

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

virtual

Audit the end of a standard "event".

Reimplemented from Auditor.

Definition at line 35 of file CommonAuditor.cpp.

 {
   if (caller) after(toStr(evt), caller->name(), sc);
 }

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

virtual

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

Reimplemented from Auditor.

Definition at line 47 of file CommonAuditor.cpp.

 {
   if (i_auditEventType(evt)) i_after(evt, caller, sc);
 }

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

virtual

Audit the end of a custom "event".

Reimplemented from Auditor.

Definition at line 43 of file CommonAuditor.cpp.

 {
   if (caller) after(evt, caller->name(), sc);
 }

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

virtual

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

Reimplemented from Auditor.

Definition at line 22 of file CommonAuditor.cpp.

 {
   before(toStr(evt), caller);
 }

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

virtual

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

Reimplemented from Auditor.

Definition at line 18 of file CommonAuditor.cpp.

 {
   if (caller) before(toStr(evt), caller->name());
 }

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

virtual

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

Reimplemented from Auditor.

Definition at line 30 of file CommonAuditor.cpp.

 {
   if (i_auditEventType(evt)) i_before(evt, caller);
 }

void CommonAuditor::before	(	CustomEventTypeRef	,
		INamedInterface *
	)

virtual

Audit the start of a custom "event".

Reimplemented from Auditor.

Definition at line 26 of file CommonAuditor.cpp.

 {
   if (caller) before(evt, caller->name());
 }

virtual void CommonAuditor::i_after	(	CustomEventTypeRef	evt,
		const std::string &	caller,
		const StatusCode &	sc
	)

protectedpure virtual

catch all "after" method, implemented in the derived class

Implemented in ChronoAuditor, MemoryAuditor, and NameAuditor.

bool CommonAuditor::i_auditEventType ( const std::string & evt )

inlineprotected

Check if we are requested to audit the passed event type.

Definition at line 42 of file CommonAuditor.h.

                                                      {
     // Note: there is no way to extract from a Property type the type returned by
     // value().
     const std::vector<std::string> &v = m_types.value();
     // we need to return true is the list is empty or when the list does't
     // start by "none" and the list contain the event we got.
     return (v.size() == 0) || (
              (v[0] != "none") &&
              (find(v.begin(), v.end(), evt) != v.end())
            );
   }

virtual void CommonAuditor::i_before	(	CustomEventTypeRef	evt,
		const std::string &	caller
	)

protectedpure virtual

catch all "before" method, implemented in the derived class

Implemented in ChronoAuditor, MemStatAuditor, MemoryAuditor, and NameAuditor.

void CommonAuditor::i_updateCustomTypes ( Property & )

protected

Update handler for the obsolete property CustomEventTypes.

Definition at line 12 of file CommonAuditor.cpp.

                                                   {
   MsgStream log(msgSvc(), name());
   log << MSG::WARNING << "Property CustomEventTypes is deprecated, use EventTypes instead" << endmsg;
   m_types.setValue(m_customTypes.value());
 }

Member Data Documentation

StringArrayProperty CommonAuditor::m_customTypes

protected

Definition at line 58 of file CommonAuditor.h.

StringArrayProperty CommonAuditor::m_types

protected

Definition at line 54 of file CommonAuditor.h.

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

GaudiAud/src/CommonAuditor.h
GaudiAud/src/CommonAuditor.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation