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

#include </builds/gaudi/Gaudi/GaudiAud/src/CommonAuditor.h>

Inheritance diagram for CommonAuditor:

[legend]

Collaboration diagram for CommonAuditor:

[legend]

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

	Auditor (const Auditor &a)=delete
	Constructor. 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.
void	before (StandardEventType evt, const std::string &caller) override

void	before (StandardEventType evt, INamedInterface *caller) override

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

void	before (CustomEventTypeRef evt, INamedInterface *caller) override

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

	Auditor (const Auditor &a)=delete

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

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

virtual StatusCode	initialize ()

virtual StatusCode	finalize ()

const std::string &	name () const override

bool	isEnabled () const override

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

template<class T >
StatusCode	service (std::string_view 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 (std::string_view name, bool createIf=false) const

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property. More...

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals. More...

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string. More...

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

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation More...

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name More...

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string More...

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name. More...

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected More...

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IAuditor, IProperty > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream 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.
Gaudi::Property< std::vector< std::string > >	m_types

Gaudi::Property< std::vector< std::string > >	m_customTypes

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

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

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

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

virtual void	i_before (CustomEventTypeRef evt, std::string_view caller)=0
	catch all "before" method, implemented in the derived class More...

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

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

void	deprecated_property (Gaudi::Details::PropertyBase &p)

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

Public Types inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
	Typedef used to refer to this class from derived classes, as in. More...

Public Types inherited from CommonMessaging< implements< IAuditor, IProperty > >
using	base_class = CommonMessaging

Protected Member Functions inherited from CommonMessaging< implements< IAuditor, IProperty > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Detailed Description

Base class with common functionalities shared by few auditor implementations.

Author: Marco Clemencic

Definition at line 18 of file CommonAuditor.h.

Member Function Documentation

◆ after() [1/4]

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

override

Definition at line 34 of file CommonAuditor.cpp.

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

◆ after() [2/4]

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

override

Definition at line 31 of file CommonAuditor.cpp.

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

◆ after() [3/4]

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

override

Definition at line 28 of file CommonAuditor.cpp.

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

◆ after() [4/4]

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

override

Definition at line 25 of file CommonAuditor.cpp.

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

◆ Auditor() [1/2]

Auditor::Auditor

delete

Constructor.

Parameters

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

◆ Auditor() [2/2]

Auditor::Auditor

Constructor.

Parameters

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

Definition at line 51 of file Auditor.cpp.

22 : m_name( std::move( name ) ), m_pSvcLocator( pSvcLocator ) {}

◆ before() [1/4]

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

override

Definition at line 21 of file CommonAuditor.cpp.

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

◆ before() [2/4]

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

override

Definition at line 18 of file CommonAuditor.cpp.

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

◆ before() [3/4]

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

override

Definition at line 17 of file CommonAuditor.cpp.

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

◆ before() [4/4]

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

override

Definition at line 14 of file CommonAuditor.cpp.

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

◆ deprecated_property()

void CommonAuditor::deprecated_property ( Gaudi::Details::PropertyBase & p )

inlineprivate

Definition at line 62 of file CommonAuditor.h.

                                                           {
     if ( m_customTypes.size() > 0 ) {
       if ( m_types.size() > 0 ) {
         error() << p.name() << " is deprecated, but both " << m_customTypes.name() << " and " << m_types.name()
                 << " used." << endmsg;
         throw GaudiException( "Property CustomEventTypes is deprecated, but both CustomEventTypes and EventTypes used",
                               this->name(), StatusCode::FAILURE );
       } else {
         warning() << p.name() << " " << p.documentation() << endmsg;
         m_types = m_customTypes;
       }
     }
   };

◆ i_after()

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

protectedpure virtual

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

Implemented in ChronoAuditor, MemoryAuditor, MemStatAuditor, and NameAuditor.

◆ i_auditEventType()

bool CommonAuditor::i_auditEventType ( std::string_view evt )

inlineprotected

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

Definition at line 52 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() ) );
   }

◆ i_before()

virtual void CommonAuditor::i_before	(	CustomEventTypeRef	evt,
		std::string_view	caller
	)

protectedpure virtual

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

Implemented in MemStatAuditor, ChronoAuditor, MemoryAuditor, and NameAuditor.

Member Data Documentation

◆ m_customTypes

Gaudi::Property<std::vector<std::string> > CommonAuditor::m_customTypes

private

Initial value:

{

this, "CustomEventTypes", {}, &CommonAuditor::deprecated_property, "[[deprecated]] use EventTypes instead" }

Definition at line 78 of file CommonAuditor.h.

◆ m_types

Gaudi::Property<std::vector<std::string> > CommonAuditor::m_types

private

Initial value:

{

this, "EventTypes", {}, "list of event types to audit ([]=all, ['none']=none)" }

Definition at line 76 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

"after" Auditor hooks

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ after() [1/4]

◆ after() [2/4]

◆ after() [3/4]

◆ after() [4/4]

◆ Auditor() [1/2]

◆ Auditor() [2/2]

◆ before() [1/4]

◆ before() [2/4]

◆ before() [3/4]

◆ before() [4/4]

◆ deprecated_property()

◆ i_after()

◆ i_auditEventType()

◆ i_before()

Member Data Documentation

◆ m_customTypes

◆ m_types