#include </builds/gaudi/Gaudi/GaudiCommonSvc/src/AuditorSvc.h>

Inheritance diagram for AuditorSvc:

[legend]

Collaboration diagram for AuditorSvc:

[legend]

Public Member Functions
StatusCode	initialize () override

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

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 *ini) override

void	afterInitialize (INamedInterface *ini) override

void	beforeReinitialize (INamedInterface *ini) override

void	afterReinitialize (INamedInterface *ini) override

void	beforeExecute (INamedInterface *ini) override

void	afterExecute (INamedInterface *ini, const StatusCode &) override

void	beforeFinalize (INamedInterface *ini) override

void	afterFinalize (INamedInterface *ini) override

bool	isEnabled () const override

StatusCode	sysInitialize () override

StatusCode	sysFinalize () override

IAuditor *	getAuditor (const std::string &name) override

Public Member Functions inherited from extends< Service, IAuditorSvc >
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...

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service More...

StatusCode	sysStart () override
	Initialize Service More...

StatusCode	sysStop () override
	Initialize Service More...

StatusCode	sysFinalize () override
	Finalize Service More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

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

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator More...

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool. More...

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T >
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	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< IService, IProperty, IStateful > >
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
SmartIF< IAuditor >	newAuditor_ (MsgStream &, std::string_view)

SmartIF< IAuditor >	findAuditor_ (std::string_view)

StatusCode	syncAuditors_ ()

Private Attributes
Gaudi::Property< std::vector< std::string > >	m_audNameList

Gaudi::Property< bool >	m_isEnabled { this, "Enable", true, "enable/disable alltogether the auditors" }

std::vector< SmartIF< IAuditor > >	m_pAudList

Additional Inherited Members
Public Types inherited from extends< Service, IAuditorSvc >
using	base_class = extends
	Typedef to this class. More...

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

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

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

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

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

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override
	Standard Destructor More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
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...

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state More...

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools More...

Gaudi::Property< bool >	m_auditInit { this, "AuditServices", false, "[[deprecated]] unused" }

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Detailed Description

Definition at line 28 of file AuditorSvc.h.

Member Function Documentation

◆ after() [1/4]

void AuditorSvc::after	(	CustomEventTypeRef	evt,
		const std::string &	name,
		const StatusCode &	sc
	)

override

Definition at line 164 of file AuditorSvc.cpp.

                                                                                             {
   if ( !isEnabled() ) return;
   for ( auto& it : m_pAudList ) {
     if ( it->isEnabled() ) it->after( evt, name, sc );
   }
 }

◆ after() [2/4]

void AuditorSvc::after	(	CustomEventTypeRef	evt,
		INamedInterface *	obj,
		const StatusCode &	sc
	)

override

Definition at line 157 of file AuditorSvc.cpp.

                                                                                            {
   if ( !isEnabled() ) return;
   for ( auto& it : m_pAudList ) {
     if ( it->isEnabled() ) it->after( evt, obj, sc );
   }
 }

◆ after() [3/4]

void AuditorSvc::after	(	StandardEventType	evt,
		const std::string &	name,
		const StatusCode &	sc
	)

override

Definition at line 150 of file AuditorSvc.cpp.

                                                                                            {
   if ( !isEnabled() ) return;
   for ( auto& it : m_pAudList ) {
     if ( it->isEnabled() ) it->after( evt, name, sc );
   }
 }

◆ after() [4/4]

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

override

Definition at line 143 of file AuditorSvc.cpp.

                                                                                           {
   if ( !isEnabled() ) return;
   for ( auto& it : m_pAudList ) {
     if ( it->isEnabled() ) it->after( evt, obj, sc );
   }
 }

◆ afterExecute()

void AuditorSvc::afterExecute	(	INamedInterface *	ini,
		const StatusCode &
	)

override

Definition at line 185 of file AuditorSvc.cpp.

                                                                    {
   throw GaudiException( "The method afterExecute is obsolete do not call it.", "AuditorSvc::afterExecute",
                         StatusCode::FAILURE );
 }

◆ afterFinalize()

void AuditorSvc::afterFinalize ( INamedInterface * ini )

override

◆ afterInitialize()

void AuditorSvc::afterInitialize ( INamedInterface * ini )

override

◆ afterReinitialize()

void AuditorSvc::afterReinitialize ( INamedInterface * ini )

override

◆ before() [1/4]

void AuditorSvc::before	(	CustomEventTypeRef	evt,
		const std::string &	name
	)

override

Definition at line 135 of file AuditorSvc.cpp.

                                                                        {
   if ( !isEnabled() ) return;
   for ( auto& it : m_pAudList ) {
     if ( it->isEnabled() ) it->before( evt, name );
   }
 }

◆ before() [2/4]

void AuditorSvc::before	(	CustomEventTypeRef	evt,
		INamedInterface *	obj
	)

override

Definition at line 128 of file AuditorSvc.cpp.

                                                                       {
   if ( !isEnabled() ) return;
   for ( auto& it : m_pAudList ) {
     if ( it->isEnabled() ) it->before( evt, obj );
   }
 }

◆ before() [3/4]

void AuditorSvc::before	(	StandardEventType	evt,
		const std::string &	name
	)

override

Definition at line 121 of file AuditorSvc.cpp.

                                                                       {
   if ( !isEnabled() ) return;
   for ( auto& it : m_pAudList ) {
     if ( it->isEnabled() ) it->before( evt, name );
   }
 }

◆ before() [4/4]

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

override

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

Definition at line 114 of file AuditorSvc.cpp.

                                                                      {
   if ( !isEnabled() ) return;
   for ( auto& it : m_pAudList ) {
     if ( it->isEnabled() ) it->before( evt, obj );
   }
 }

◆ beforeExecute()

void AuditorSvc::beforeExecute ( INamedInterface * ini )

override

◆ beforeFinalize()

void AuditorSvc::beforeFinalize ( INamedInterface * ini )

override

◆ beforeInitialize()

void AuditorSvc::beforeInitialize ( INamedInterface * ini )

override

◆ beforeReinitialize()

void AuditorSvc::beforeReinitialize ( INamedInterface * ini )

override

◆ finalize()

StatusCode AuditorSvc::finalize ( )

override

Definition at line 102 of file AuditorSvc.cpp.

                                 {
  
   for ( auto& it : m_pAudList ) {
     if ( it->isEnabled() ) it->sysFinalize().ignore();
   }
   m_pAudList.clear();
  
   // Finalize this specific service
   return Service::finalize();
 }

◆ findAuditor_()

SmartIF< IAuditor > AuditorSvc::findAuditor_ ( std::string_view name )

private

Definition at line 51 of file AuditorSvc.cpp.

                                                                 {
   // find an auditor by name, return 0 on error
   auto it = std::find_if( std::begin( m_pAudList ), std::end( m_pAudList ),
                           [item_name = Gaudi::Utils::TypeNameString( name ).name()]( const IAuditor* i ) {
                             return i->name() == item_name;
                           } );
   return SmartIF<IAuditor>{ it != std::end( m_pAudList ) ? *it : nullptr };
 }

◆ getAuditor()

IAuditor * AuditorSvc::getAuditor ( const std::string & name )

override

Definition at line 198 of file AuditorSvc.cpp.

                                                         {
   // by interactively setting properties, auditors might be out of sync
   if ( !syncAuditors_().isSuccess() ) {
     // as we didn't manage to sync auditors, the safest bet is to assume the
     // worse...
     // So don't let clients play with an AuditorSvc in an inconsistent state
     return nullptr;
   }
  
   // search available auditors, returns 0 on error
   return findAuditor_( name );
 }

◆ initialize()

StatusCode AuditorSvc::initialize ( )

override

Definition at line 91 of file AuditorSvc.cpp.

                                   {
   StatusCode sc = Service::initialize();
   if ( sc.isFailure() ) return sc;
  
   // create auditor objects for all named auditors
   sc = syncAuditors_();
  
   return sc;
 }

◆ isEnabled()

bool AuditorSvc::isEnabled ( ) const

override

Definition at line 193 of file AuditorSvc.cpp.

193 { return m_isEnabled; }

◆ newAuditor_()

SmartIF< IAuditor > AuditorSvc::newAuditor_	(	MsgStream &	log,
		std::string_view	name
	)

private

Definition at line 32 of file AuditorSvc.cpp.

                                                                                {
   // locate the auditor factory, instantiate a new auditor, initialize it
   StatusCode                   sc;
   Gaudi::Utils::TypeNameString item( name );
   SmartIF<IAuditor> aud{ Auditor::Factory::create( item.type(), item.name(), serviceLocator().get() ).release() };
   if ( aud ) {
     if ( m_targetState >= Gaudi::StateMachine::INITIALIZED ) {
       sc = aud->sysInitialize();
       if ( sc.isFailure() ) {
         log << MSG::WARNING << "Failed to initialize Auditor " << name << endmsg;
         aud.reset();
       }
     }
   } else {
     log << MSG::WARNING << "Unable to retrieve factory for Auditor " << name << endmsg;
   }
   return aud;
 }

◆ syncAuditors_()

StatusCode AuditorSvc::syncAuditors_ ( )

private

Definition at line 60 of file AuditorSvc.cpp.

                                      {
   if ( m_audNameList.size() == m_pAudList.size() ) return StatusCode::SUCCESS;
  
   StatusCode sc;
  
   //   if ( sc.isFailure() ) {
   //     error() << "Unable to locate ObjectManager Service" << endmsg;
   //     return sc;
   //   }
  
   // create all declared Auditors that do not yet exist
   for ( auto& it : m_audNameList ) {
  
     // this is clumsy, but the PropertyHolder won't tell us when my property changes right
     // under my nose, so I'll have to figure this out the hard way
     if ( !findAuditor_( it ) ) { // if auditor does not yet exist
       auto aud = newAuditor_( msgStream(), it );
       if ( aud ) {
         m_pAudList.push_back( std::move( aud ) );
       } else {
         error() << "Error constructing Auditor " << it << endmsg;
         sc = StatusCode::FAILURE;
       }
     }
   }
   return sc;
 }

◆ sysFinalize()

StatusCode AuditorSvc::sysFinalize ( )

override

Definition at line 196 of file AuditorSvc.cpp.

196 { return Service::sysFinalize(); }

◆ sysInitialize()

StatusCode AuditorSvc::sysInitialize ( )

override

Definition at line 195 of file AuditorSvc.cpp.

195 { return Service::sysInitialize(); }

Member Data Documentation

◆ m_audNameList

Gaudi::Property<std::vector<std::string> > AuditorSvc::m_audNameList

private

Initial value:

{

this, "Auditors", {}, "list of auditors names", "OrderedSet<std::string>" }

Definition at line 90 of file AuditorSvc.h.

◆ m_isEnabled

Gaudi::Property<bool> AuditorSvc::m_isEnabled { this, "Enable", true, "enable/disable alltogether the auditors" }

private

Definition at line 92 of file AuditorSvc.h.

◆ m_pAudList

std::vector<SmartIF<IAuditor> > AuditorSvc::m_pAudList

private

Definition at line 95 of file AuditorSvc.h.

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

GaudiCommonSvc/src/AuditorSvc.h
GaudiCommonSvc/src/AuditorSvc.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ after() [1/4]

◆ after() [2/4]

◆ after() [3/4]

◆ after() [4/4]

◆ afterExecute()

◆ afterFinalize()

◆ afterInitialize()

◆ afterReinitialize()

◆ before() [1/4]

◆ before() [2/4]

◆ before() [3/4]

◆ before() [4/4]

◆ beforeExecute()

◆ beforeFinalize()

◆ beforeInitialize()

◆ beforeReinitialize()

◆ finalize()

◆ findAuditor_()

◆ getAuditor()

◆ initialize()

◆ isEnabled()

◆ newAuditor_()

◆ syncAuditors_()

◆ sysFinalize()

◆ sysInitialize()

Member Data Documentation

◆ m_audNameList

◆ m_isEnabled

◆ m_pAudList