#include <src/AuditorSvc.h>

Inheritance diagram for AuditorSvc:

Collaboration diagram for AuditorSvc:

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

void	afterBeginRun (INamedInterface *ini) override

void	beforeEndRun (INamedInterface *ini) override

void	afterEndRun (INamedInterface *ini) 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

	AuditorSvc (const std::string &name, ISvcLocator *svc)

	~AuditorSvc () override=default

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

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

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

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

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

Private Member Functions
SmartIF< IAuditor >	newAuditor_ (MsgStream &, const std::string &)

SmartIF< IAuditor >	findAuditor_ (const std::string &)

StatusCode	syncAuditors_ ()

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

std::vector< SmartIF< IAuditor > >	m_pAudList

bool	m_isEnabled = true

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

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

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

Definition at line 18 of file AuditorSvc.h.

Constructor & Destructor Documentation

AuditorSvc::AuditorSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Definition at line 82 of file AuditorSvc.cpp.

 : base_class(name, svc) {
   declareProperty("Auditors", m_audNameList );
   declareProperty("Enable", m_isEnabled = true);
 }

AuditorSvc::~AuditorSvc ( )

overridedefault

Member Function Documentation

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

override

Definition at line 144 of file AuditorSvc.cpp.

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

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

override

Definition at line 151 of file AuditorSvc.cpp.

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

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

override

Definition at line 158 of file AuditorSvc.cpp.

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

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

override

Definition at line 165 of file AuditorSvc.cpp.

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

void AuditorSvc::afterBeginRun ( INamedInterface * ini )

override

void AuditorSvc::afterEndRun ( INamedInterface * ini )

override

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

override

Definition at line 186 of file AuditorSvc.cpp.

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

void AuditorSvc::afterFinalize ( INamedInterface * ini )

override

void AuditorSvc::afterInitialize ( INamedInterface * ini )

override

void AuditorSvc::afterReinitialize ( INamedInterface * ini )

override

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

override

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

Definition at line 115 of file AuditorSvc.cpp.

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

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

override

Definition at line 122 of file AuditorSvc.cpp.

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

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

override

Definition at line 129 of file AuditorSvc.cpp.

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

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

override

Definition at line 136 of file AuditorSvc.cpp.

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

void AuditorSvc::beforeBeginRun ( INamedInterface * ini )

override

void AuditorSvc::beforeEndRun ( INamedInterface * ini )

override

void AuditorSvc::beforeExecute ( INamedInterface * ini )

override

void AuditorSvc::beforeFinalize ( INamedInterface * ini )

override

void AuditorSvc::beforeInitialize ( INamedInterface * ini )

override

void AuditorSvc::beforeReinitialize ( INamedInterface * ini )

override

StatusCode AuditorSvc::finalize ( )

override

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

SmartIF< IAuditor > AuditorSvc::findAuditor_ ( const std::string & name )

private

Definition at line 41 of file AuditorSvc.cpp.

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

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

override

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

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;
 }

bool AuditorSvc::isEnabled ( ) const

override

Definition at line 201 of file AuditorSvc.cpp.

                                   {
   return m_isEnabled;
 }

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

private

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

StatusCode AuditorSvc::syncAuditors_ ( )

private

Definition at line 49 of file AuditorSvc.cpp.

                                      {
   if ( m_audNameList.size() == m_pAudList.size() )
     return StatusCode::SUCCESS;
 
   MsgStream log( msgSvc(), name() );
   StatusCode sc;
 
 //   if ( sc.isFailure() ) {
 //     log << MSG::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 PropertyMgr 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_( log, it );
       if ( aud ) {
         m_pAudList.push_back( std::move(aud) );
       } else {
         log << MSG::ERROR << "Error constructing Auditor " << it << endmsg;
         sc = StatusCode::FAILURE;
       }
     }
   }
   return sc;
 }

StatusCode AuditorSvc::sysFinalize ( )

override

Definition at line 208 of file AuditorSvc.cpp.

                                   {
   return Service::sysFinalize();
 }

StatusCode AuditorSvc::sysInitialize ( )

override

Definition at line 205 of file AuditorSvc.cpp.

                                     {
   return Service::sysInitialize();
 }

Member Data Documentation

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

private

Definition at line 100 of file AuditorSvc.h.

bool AuditorSvc::m_isEnabled = true

private

Definition at line 106 of file AuditorSvc.h.

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

private

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation