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

Inheritance diagram for AlgContextAuditor:

[legend]

Collaboration diagram for AlgContextAuditor:

[legend]

Public Member Functions
void	before (std::string const &, std::string const &, EventContext const &) override

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

StatusCode	initialize () override

StatusCode	finalize () override

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

	Auditor (const Auditor &a)=delete

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

StatusCode	sysInitialize () override

StatusCode	sysFinalize () override

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

void	after (std::string const &, std::string const &, EventContext const &, StatusCode const &=StatusCode::SUCCESS) override

const std::string &	name () const override

bool	isEnabled () const override

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

template<class T = IService>
SmartIF< T >	service (std::string_view name, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

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

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

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

	PropertyHolder ()=default

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

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.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

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

	AlgContextAuditor (const AlgContextAuditor &)=delete

AlgContextAuditor &	operator= (const AlgContextAuditor &)=delete

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

SmartIF< IAlgManager >	m_algMgr
	the pointer to Algorithm Manager

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

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

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

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

MSG::Level	resetMessaging ()
	Reinitialize internal states.

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

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 26 of file AlgContextAuditor.cpp.

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

void AlgContextAuditor::after	(	std::string const &	event,
		std::string const &	caller,
		EventContext const &	context,
		StatusCode const &	)

override

Definition at line 83 of file AlgContextAuditor.cpp.

                                                   {
  if ( m_svc && ( event == Gaudi::IAuditor::Initialize || event == Gaudi::IAuditor::Execute ||
                  event == Gaudi::IAuditor::Finalize ) ) {
    SmartIF<IAlgorithm>& alg = m_algMgr->algorithm( caller, false );
    if ( alg ) m_svc->unSetCurrentAlg( alg, context ).ignore();
  }
}

◆ before()

void AlgContextAuditor::before	(	std::string const &	event,
		std::string const &	caller,
		EventContext const &	context )

override

Definition at line 75 of file AlgContextAuditor.cpp.

                                                                                                             {
  if ( m_svc && ( event == Gaudi::IAuditor::Initialize || event == Gaudi::IAuditor::Execute ||
                  event == Gaudi::IAuditor::Finalize ) ) {
    SmartIF<IAlgorithm>& alg = m_algMgr->algorithm( caller, false );
    if ( alg ) m_svc->setCurrentAlg( alg, context ).ignore();
  }
}

◆ finalize()

StatusCode AlgContextAuditor::finalize ( )

overridevirtual

Reimplemented from Gaudi::Auditor.

Definition at line 69 of file AlgContextAuditor.cpp.

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

◆ initialize()

StatusCode AlgContextAuditor::initialize ( )

overridevirtual

Reimplemented from Gaudi::Auditor.

Definition at line 53 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
    }
    m_algMgr = serviceLocator();
    if ( !m_algMgr ) {
      error() << "Invalid pointer to IAlgManager" << endmsg;
      return StatusCode::FAILURE; // RETURN
    }
    return StatusCode::SUCCESS;
  } );
}

◆ operator=()

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

privatedelete

Member Data Documentation

◆ m_algMgr

SmartIF<IAlgManager> AlgContextAuditor::m_algMgr

private

the pointer to Algorithm Manager

Definition at line 47 of file AlgContextAuditor.cpp.

◆ m_svc

SmartIF<IAlgContextSvc> AlgContextAuditor::m_svc

private

the pointer to Algorithm Context Service

Definition at line 45 of file AlgContextAuditor.cpp.

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

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

◆ before()

◆ finalize()

◆ initialize()

◆ operator=()

Member Data Documentation

◆ m_algMgr

◆ m_svc