ServiceLocatorHelper Class Reference

an helper to share the implementation of service() among the various kernel base classes More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/ServiceLocatorHelper.h>

Collaboration diagram for ServiceLocatorHelper:

Public Member Functions
	ServiceLocatorHelper (ISvcLocator &svcLoc, const INamedInterface &requester)
	ServiceLocatorHelper (ISvcLocator &svcLoc, std::string loggedName, std::string requesterName)
	ServiceLocatorHelper (ISvcLocator &svcLoc, std::string requesterName)
	ServiceLocatorHelper (ISvcLocator &svcLoc, const MsgStream &log, std::string requesterName)
StatusCode	getService (std::string_view name, bool createIf, const InterfaceID &iid, void **ppSvc) const
StatusCode	locateService (std::string_view name, const InterfaceID &iid, void **ppSvc, bool quiet=false) const
StatusCode	createService (std::string_view name, const InterfaceID &iid, void **ppSvc) const
StatusCode	createService (std::string_view type, std::string_view name, const InterfaceID &iid, void **ppSvc) const
SmartIF< IService >	service (std::string_view name, const bool quiet=false, const bool createIf=true) const
template<typename T >
SmartIF< T >	service (std::string_view name, const bool quiet=false, const bool createIf=true) const

Private Member Functions
ISvcLocator *	serviceLocator () const
MsgStream &	log () const
const std::string &	requesterName () const

Private Attributes
ISvcLocator &	m_svcLoc
MsgStream	m_msgLog
std::string	m_requesterName

Detailed Description

an helper to share the implementation of service() among the various kernel base classes

Definition at line 27 of file ServiceLocatorHelper.h.

Constructor & Destructor Documentation

ServiceLocatorHelper() [1/4]

ServiceLocatorHelper::ServiceLocatorHelper ( ISvcLocator &  svcLoc, const INamedInterface &  requester  )

inline

Definition at line 29 of file ServiceLocatorHelper.h.

      : m_svcLoc( svcLoc )
      , m_msgLog( SmartIF<IMessageSvc>( &svcLoc ), requester.name() )
      , // use requester msg level
      m_requesterName( requester.name() ) {}

ServiceLocatorHelper() [2/4]

ServiceLocatorHelper::ServiceLocatorHelper ( ISvcLocator &  svcLoc, std::string  loggedName, std::string  requesterName  )

inline

Definition at line 34 of file ServiceLocatorHelper.h.

      : m_svcLoc( svcLoc )
      , m_msgLog( SmartIF<IMessageSvc>( &svcLoc ), std::move( loggedName ) )
      , // use requester msg level
      m_requesterName( std::move( requesterName ) ) {}

ServiceLocatorHelper() [3/4]

ServiceLocatorHelper::ServiceLocatorHelper ( ISvcLocator &  svcLoc, std::string  requesterName  )

inline

Definition at line 39 of file ServiceLocatorHelper.h.

      : m_svcLoc( svcLoc )
      , m_msgLog( SmartIF<IMessageSvc>( &svcLoc ), requesterName )
      , // use requester msg level
      m_requesterName( std::move( requesterName ) ) {}

ServiceLocatorHelper() [4/4]

ServiceLocatorHelper::ServiceLocatorHelper ( ISvcLocator &  svcLoc, const MsgStream &  log, std::string  requesterName  )

inline

Definition at line 45 of file ServiceLocatorHelper.h.

      : m_svcLoc( svcLoc ), m_msgLog( log ), m_requesterName( std::move( requesterName ) ) {}

Member Function Documentation

createService() [1/2]

StatusCode ServiceLocatorHelper::createService	(	std::string_view	name,
		const InterfaceID &	iid,
		void **	ppSvc
	)		const

Definition at line 33 of file ServiceLocatorHelper.cpp.

                                                                                                                {
  auto theSvc = service( name, false, true );
  if ( !theSvc ) return StatusCode::FAILURE;
  StatusCode sc = theSvc->queryInterface( iid, ppSvc );
  if ( !sc.isSuccess() ) {
    *ppSvc = nullptr;
    log() << MSG::ERROR << "ServiceLocatorHelper::createService: wrong interface id " << iid << " for service " << name
          << endmsg;
  }
  return sc;
}

createService() [2/2]

StatusCode ServiceLocatorHelper::createService	(	std::string_view	type,
		std::string_view	name,
		const InterfaceID &	iid,
		void **	ppSvc
	)		const

Definition at line 45 of file ServiceLocatorHelper.cpp.

                                                                     {
  return createService( fmt::format( "{}/{}", type, name ), iid, ppSvc );
}

getService()

StatusCode ServiceLocatorHelper::getService ( std::string_view  name, bool  createIf, const InterfaceID &  iid, void **  ppSvc  ) const

inline

Definition at line 51 of file ServiceLocatorHelper.h.

                                                                                                          {
    return createIf ? createService( name, iid, ppSvc ) : locateService( name, iid, ppSvc, true );
  }

locateService()

StatusCode ServiceLocatorHelper::locateService	(	std::string_view	name,
		const InterfaceID &	iid,
		void **	ppSvc,
		bool	quiet = false
	)		const

Definition at line 19 of file ServiceLocatorHelper.cpp.

                                                                   {
  auto theSvc = service( name, quiet, false );
  if ( !theSvc ) return StatusCode::FAILURE;
  StatusCode sc = theSvc->queryInterface( iid, ppSvc );
  if ( !sc.isSuccess() ) {
    *ppSvc = nullptr;
    if ( !quiet )
      log() << MSG::ERROR << "ServiceLocatorHelper::locateService: wrong interface id " << iid << " for service "
            << name << endmsg;
  }
  return sc;
}

log()

MsgStream& ServiceLocatorHelper::log ( ) const

inlineprivate

Definition at line 70 of file ServiceLocatorHelper.h.

{ return m_msgLog; }

requesterName()

const std::string& ServiceLocatorHelper::requesterName ( ) const

inlineprivate

Definition at line 71 of file ServiceLocatorHelper.h.

{ return m_requesterName; }

service() [1/2]

SmartIF< IService > ServiceLocatorHelper::service	(	std::string_view	name,
		const bool	quiet = false,
		const bool	createIf = true
	)		const

Definition at line 50 of file ServiceLocatorHelper.cpp.

                                                                                                                  {
  SmartIF<IService> theSvc = serviceLocator()->service( name, createIf );
 
  if ( theSvc ) {
    if ( !quiet ) {
      if ( UNLIKELY( log().level() <= MSG::VERBOSE ) )
        log() << MSG::VERBOSE << "ServiceLocatorHelper::service: found service " << name << endmsg;
    }
  } else {
    // if not return an error
    if ( !quiet ) { log() << MSG::ERROR << "ServiceLocatorHelper::service: can not locate service " << name << endmsg; }
  }
  return theSvc;
}

service() [2/2]

template<typename T >

SmartIF<T> ServiceLocatorHelper::service ( std::string_view  name, const bool  quiet = false, const bool  createIf = true  ) const

inline

Definition at line 64 of file ServiceLocatorHelper.h.

                                                                                                        {
    return service( name, quiet, createIf ).as<T>();
  }

serviceLocator()

ISvcLocator* ServiceLocatorHelper::serviceLocator ( ) const

inlineprivate

Definition at line 69 of file ServiceLocatorHelper.h.

{ return &m_svcLoc; }

Member Data Documentation

m_msgLog

MsgStream ServiceLocatorHelper::m_msgLog

mutableprivate

Definition at line 73 of file ServiceLocatorHelper.h.

m_requesterName

std::string ServiceLocatorHelper::m_requesterName

private

Definition at line 74 of file ServiceLocatorHelper.h.

m_svcLoc

ISvcLocator& ServiceLocatorHelper::m_svcLoc

private

Definition at line 72 of file ServiceLocatorHelper.h.

---

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

• GaudiKernel/include/GaudiKernel/ServiceLocatorHelper.h
• GaudiKernel/src/Lib/ServiceLocatorHelper.cpp