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 ()=default
	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)

virtual void	before (StandardEventType evt, INamedInterface *caller)

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

virtual void	before (CustomEventTypeRef evt, INamedInterface *caller)

"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)

virtual void	after (StandardEventType evt, INamedInterface *caller, const StatusCode &sc)

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

virtual void	after (CustomEventTypeRef evt, INamedInterface *caller, const StatusCode &sc)

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

	~Auditor () override=default
	Destructor. More...

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

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

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

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

void	before (CustomEventTypeRef, INamedInterface *) override

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

void	after (StandardEventType, INamedInterface *, const StatusCode &) override

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

void	after (CustomEventTypeRef, INamedInterface *, const StatusCode &) override

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

void	beforeInitialize (INamedInterface *) override

void	afterInitialize (INamedInterface *) override

void	beforeReinitialize (INamedInterface *) override

void	afterReinitialize (INamedInterface *) override

void	beforeExecute (INamedInterface *) override

void	afterExecute (INamedInterface *, const StatusCode &) override

void	beforeFinalize (INamedInterface *) override

void	afterFinalize (INamedInterface *) override

void	beforeBeginRun (INamedInterface *) override

void	afterBeginRun (INamedInterface *) override

void	beforeEndRun (INamedInterface *) override

void	afterEndRun (INamedInterface *) override

virtual StatusCode	initialize ()

virtual StatusCode	finalize ()

const std::string &	name () const override

bool	isEnabled () const override

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

template<class T = IService>
SmartIF< T >	service (const std::string &name, bool createIf=false) const

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

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

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

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

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

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

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

bool	hasProperty (const std::string &name) const override
	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...

	~Auditor () override=default
	Destructor. More...

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

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

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

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

void	before (CustomEventTypeRef, INamedInterface *) override

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

void	after (StandardEventType, INamedInterface *, const StatusCode &) override

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

void	after (CustomEventTypeRef, INamedInterface *, const StatusCode &) override

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

void	beforeInitialize (INamedInterface *) override

void	afterInitialize (INamedInterface *) override

void	beforeReinitialize (INamedInterface *) override

void	afterReinitialize (INamedInterface *) override

void	beforeExecute (INamedInterface *) override

void	afterExecute (INamedInterface *, const StatusCode &) override

void	beforeFinalize (INamedInterface *) override

void	afterFinalize (INamedInterface *) override

void	beforeBeginRun (INamedInterface *) override

void	afterBeginRun (INamedInterface *) override

void	beforeEndRun (INamedInterface *) override

void	afterEndRun (INamedInterface *) override

virtual StatusCode	initialize ()

virtual StatusCode	finalize ()

const std::string &	name () const override

bool	isEnabled () const override

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

template<class T = IService>
SmartIF< T >	service (const std::string &name, bool createIf=false) const

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

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

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

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

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

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

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

bool	hasProperty (const std::string &name) const override
	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 implements< Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

	implements ()=default
	Default constructor. More...

	implements (const implements &)
	Copy constructor (zero the reference count) More...

implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...

	~implements () override=default
	Virtual destructor. More...

unsigned long	addRef () override
	Reference Interface instance. More...

unsigned long	release () override
	Release Interface instance. More...

unsigned long	refCount () const override
	Current reference count. More...

void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

	implements ()=default
	Default constructor. More...

	implements (const implements &)
	Copy constructor (zero the reference count) More...

implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...

	~implements () override=default
	Virtual destructor. More...

unsigned long	addRef () override
	Reference Interface instance. More...

unsigned long	release () override
	Release Interface instance. More...

unsigned long	refCount () const override
	Current reference count. More...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

	~extend_interfaces () override=default
	Virtual destructor. 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

Protected Attributes inherited from implements< Interfaces >
std::atomic_ulong	m_refCount = {0}
	Reference counter. More...

Additional Inherited Members
Public Types inherited from Auditor
typedef Gaudi::PluginService::Factory< IAuditor , const std::string &, ISvcLocator >	Factory

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

Public Types inherited from implements< Interfaces >
using	base_class = implements< Interfaces...>
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

using	iids = typename extend_interfaces_base::ext_iids

using	base_class = implements< Interfaces...>
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

using	iids = typename extend_interfaces_base::ext_iids

Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... 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);
 }

virtual CommonAuditor::~CommonAuditor ( )

virtualdefault

Destructor.

Member Function Documentation

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

virtual

Definition at line 37 of file CommonAuditor.cpp.

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

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

virtual

Definition at line 33 of file CommonAuditor.cpp.

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

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

virtual

Definition at line 45 of file CommonAuditor.cpp.

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

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

virtual

Definition at line 41 of file CommonAuditor.cpp.

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

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

virtual

Definition at line 20 of file CommonAuditor.cpp.

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

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

virtual

Definition at line 16 of file CommonAuditor.cpp.

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

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

virtual

Definition at line 28 of file CommonAuditor.cpp.

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

void CommonAuditor::before	(	CustomEventTypeRef	evt,
		INamedInterface *	caller
	)

virtual

Definition at line 24 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.empty() || (
              (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 10 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