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

Inheritance diagram for AlgContextAuditor:

[legend]

Collaboration diagram for AlgContextAuditor:

[legend]

Public Member Functions
void	before (StandardEventType evt, INamedInterface *a) override

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

StatusCode	initialize () override

StatusCode	finalize () 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	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

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

	Auditor (const Auditor &a)=delete

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

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, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...

	requires (!Gaudi::Details::is_gaudi_property_v< TYPE >) Gaudi
	Helper to wrap a regular data member and use it as a regular property. 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	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...

Private Member Functions
	AlgContextAuditor ()=delete
	delete the default/copy constructor and assignment More...

	AlgContextAuditor (const AlgContextAuditor &)=delete

AlgContextAuditor &	operator= (const AlgContextAuditor &)=delete

Private Attributes
SmartIF< IAlgContextSvc >	m_svc
	the pointer to Algorithm Context Service More...

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

Description: Register/Unregister the AlgContext of each algorithm before entering the algorithm and after leaving it

Author: M. Shapiro, LBNL; modified by Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Definition at line 24 of file AlgContextAuditor.h.

Constructor & Destructor Documentation

◆ AlgContextAuditor() [1/2]

AlgContextAuditor::AlgContextAuditor ( )

privatedelete

delete the default/copy constructor and assignment

◆ AlgContextAuditor() [2/2]

AlgContextAuditor::AlgContextAuditor ( const AlgContextAuditor & )

privatedelete

Member Function Documentation

◆ after() [1/5]

void Auditor::after

inlineoverride

Definition at line 75 of file Auditor.h.

75 {}

◆ after() [2/5]

void Auditor::after

inlineoverride

Definition at line 74 of file Auditor.h.

74 {}

◆ after() [3/5]

void AlgContextAuditor::after	(	StandardEventType	evt,
		INamedInterface *	obj,
		const StatusCode &	sc
	)

override

Definition at line 69 of file AlgContextAuditor.cpp.

                                                                                             {
   switch ( evt ) {
   case Initialize:
   case Execute:
   case Finalize:
     return call<&IAlgContextSvc::unSetCurrentAlg>( m_svc, a );
   default:
     return;
   }
 }

◆ after() [4/5]

void Auditor::after

inlineoverride

Definition at line 72 of file Auditor.h.

72 {}

◆ after() [5/5]

void Auditor::after

inlineoverride

Definition at line 71 of file Auditor.h.

71 {}

◆ Auditor() [1/2]

Auditor::Auditor

delete

◆ Auditor() [2/2]

Auditor::Auditor

Constructor.

Parameters

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

Definition at line 49 of file Auditor.cpp.

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

◆ before() [1/5]

void Auditor::before

inlineoverride

Definition at line 69 of file Auditor.h.

69 {}

◆ before() [2/5]

void Auditor::before

inlineoverride

Definition at line 68 of file Auditor.h.

68 {}

◆ before() [3/5]

void AlgContextAuditor::before	(	StandardEventType	evt,
		INamedInterface *	a
	)

override

Definition at line 58 of file AlgContextAuditor.cpp.

                                                                           {
   switch ( evt ) {
   case Initialize:
   case Execute:
   case Finalize:
     return call<&IAlgContextSvc::setCurrentAlg>( m_svc, a );
   default:
     return;
   }
 }

◆ before() [4/5]

void Auditor::before

inlineoverride

Definition at line 66 of file Auditor.h.

66 {}

◆ before() [5/5]

void Auditor::before

inlineoverride

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

Definition at line 65 of file Auditor.h.

65 {}

◆ finalize()

StatusCode AlgContextAuditor::finalize ( )

overridevirtual

Reimplemented from Auditor.

Definition at line 53 of file AlgContextAuditor.cpp.

                                        {
   m_svc.reset();
   return Auditor::finalize();
 }

◆ initialize()

StatusCode AlgContextAuditor::initialize ( )

overridevirtual

Reimplemented from Auditor.

Definition at line 42 of file AlgContextAuditor.cpp.

                                          {
   return Auditor::initialize().andThen( [&] {
     m_svc = service( "AlgContextSvc", true );
     if ( !m_svc ) {
       error() << "Invalid pointer to IAlgContextSvc" << endmsg;
       return StatusCode::FAILURE; // RETURN
     }
     return StatusCode::SUCCESS;
   } );
 }

◆ operator=()

AlgContextAuditor& AlgContextAuditor::operator= ( const AlgContextAuditor & )

privatedelete

Member Data Documentation

◆ m_svc

SmartIF<IAlgContextSvc> AlgContextAuditor::m_svc

private

the pointer to Algorithm Context Service

Definition at line 45 of file AlgContextAuditor.h.

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

GaudiAud/src/AlgContextAuditor.h
GaudiAud/src/AlgContextAuditor.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AlgContextAuditor() [1/2]

◆ AlgContextAuditor() [2/2]

Member Function Documentation

◆ after() [1/5]

◆ after() [2/5]

◆ after() [3/5]

◆ after() [4/5]

◆ after() [5/5]

◆ Auditor() [1/2]

◆ Auditor() [2/2]

◆ before() [1/5]

◆ before() [2/5]

◆ before() [3/5]

◆ before() [4/5]

◆ before() [5/5]

◆ finalize()

◆ initialize()

◆ operator=()

Member Data Documentation

◆ m_svc