ISvcLocator Class Reference

#include <GaudiKernel/ISvcLocator.h>

Inheritance diagram for ISvcLocator:

Collaboration diagram for ISvcLocator:

Public Member Functions
	DeclareInterfaceID (ISvcLocator, 3, 0)
	InterfaceID. More...
virtual StatusCode	getService (const Gaudi::Utils::TypeNameString &typeName, IService *&svc, const bool createIf=true)
	Get a reference to the service given a service name. More...
virtual StatusCode	getService (const Gaudi::Utils::TypeNameString &typeName, const InterfaceID &iid, IInterface *&pinterface)
	Get a specific interface pointer given a service name and interface id. More...
virtual const std::list< IService * > &	getServices () const =0
	Get a reference to a service and create it if it does not exists. More...
virtual bool	existsService (std::string_view name) const =0
	Check the existence of a service given a service name. More...
template<class T >
StatusCode	service (const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
	Templated method to access a service by name. More...
template<class T >
StatusCode	service (std::string_view type, std::string_view name, T *&svc, bool createIf=true)
	Templated method to access a service by type and name. More...
virtual SmartIF< IService > &	service (const Gaudi::Utils::TypeNameString &typeName, const bool createIf=true)=0
	Returns a smart pointer to a service. More...
template<typename T >
SmartIF< T >	service (const Gaudi::Utils::TypeNameString &typeName, const bool createIf=true)
	Returns a smart pointer to the requested interface of a service. More...
template<typename IFace >
SmartIF< IFace >	as ()
Gaudi::Interfaces::IOptionsSvc &	getOptsSvc ()
	Direct access to Gaudi::Interfaces::IOptionsSvc implementation. More...
Gaudi::Monitoring::Hub &	monitoringHub ()
Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...
virtual unsigned long	release ()=0
	Release Interface instance. More...
virtual unsigned long	refCount () const =0
	Current reference count. More...
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance. More...
virtual	~IInterface ()=default
	Virtual destructor. More...

Additional Inherited Members
Public Types inherited from IInterface
enum	Status : StatusCode::code_t {   Status::FAILURE = 0, Status::SUCCESS = 1, Status::NO_INTERFACE, Status::VERSMISMATCH,   Status::LAST_ERROR }
	Return status. More...
using	iid = Gaudi::InterfaceId< IInterface, 0, 0 >
	Interface ID. More...
using	ext_iids = Gaudi::interface_list< iid >
	Extra interfaces. More...
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Detailed Description

The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to locate services in the framework. Clients use this interface to locate references to interfaces of services existing in the application. This operation needs to be done before the service can be used by the client. Typically "locating the services" is done at the initialization phase of the clients.

Author

Pere Mato

Definition at line 46 of file ISvcLocator.h.

Member Function Documentation

as()

template<typename IFace >

SmartIF<IFace> ISvcLocator::as ( )

inline

Definition at line 126 of file ISvcLocator.h.

                      {
    return SmartIF<IFace>{ this };
  }

DeclareInterfaceID()

ISvcLocator::DeclareInterfaceID	(	ISvcLocator	,
		3	,
		0
	)

InterfaceID.

existsService()

virtual bool ISvcLocator::existsService ( std::string_view  name ) const

pure virtual

Check the existence of a service given a service name.

getOptsSvc()

Gaudi::Interfaces::IOptionsSvc & ISvcLocator::getOptsSvc

(

)

Direct access to Gaudi::Interfaces::IOptionsSvc implementation.

Definition at line 18 of file ISvcLocator.cpp.

                                                    {
  using namespace Gaudi::Interfaces;
  auto p = dynamic_cast<IOptionsSvc*>( service( "JobOptionsSvc" ).get() );
  if ( !p ) throw std::runtime_error( "cannot dynamic_cast JobOptionsSvc to IOptionsSvc*" );
  return *p;
}

getService() [1/2]

virtual StatusCode ISvcLocator::getService ( const Gaudi::Utils::TypeNameString &  typeName, const InterfaceID &  iid, IInterface *&  pinterface  )

inlinevirtual

Get a specific interface pointer given a service name and interface id.

Parameters

name	Service name
iid	Interface ID
pinterface	Returned pointer to the requested interface

Definition at line 73 of file ISvcLocator.h.

                                                                                                          {
    auto svc = service( typeName, false );
    return svc ? svc->queryInterface( iid, (void**)&pinterface ) : StatusCode::FAILURE;
  }

getService() [2/2]

virtual StatusCode ISvcLocator::getService ( const Gaudi::Utils::TypeNameString &  typeName, IService *&  svc, const bool  createIf = true  )

inlinevirtual

Get a reference to the service given a service name.

Parameters

name	Service name
svc	Returned service pointer

Definition at line 57 of file ISvcLocator.h.

                                                                                                     {
    SmartIF<IService>& s = service( typeName, createIf );
    svc                  = s.get();
    if ( svc ) {
      svc->addRef(); // Needed to maintain the correct reference counting.
      return StatusCode::SUCCESS;
    }
    return StatusCode::FAILURE;
  }

getServices()

virtual const std::list<IService*>& ISvcLocator::getServices ( ) const

pure virtual

Get a reference to a service and create it if it does not exists.

Parameters

name	Service name
svc	Returned service pointer
createIf	flag to control the creation Return the list of Services

monitoringHub()

Gaudi::Monitoring::Hub & ISvcLocator::monitoringHub

(

)

Definition at line 25 of file ISvcLocator.cpp.

{ return as<IAppMgrUI>()->monitoringHub(); }

service() [1/4]

template<class T >

StatusCode ISvcLocator::service ( const Gaudi::Utils::TypeNameString &  name, T *&  svc, bool  createIf = true  )

inline

Templated method to access a service by name.

Definition at line 98 of file ISvcLocator.h.

                                                                                 {
    if ( createIf ) {
      IService*  s;
      StatusCode sc = getService( name, s, true );
      if ( !sc.isSuccess() ) return sc; // Must check if initialization was OK!
    }
    return getService( name, T::interfaceID(), (IInterface*&)svc );
  }

service() [2/4]

template<typename T >

SmartIF<T> ISvcLocator::service ( const Gaudi::Utils::TypeNameString &  typeName, const bool  createIf = true  )

inline

Returns a smart pointer to the requested interface of a service.

Definition at line 120 of file ISvcLocator.h.

                                                                                                    {
    return SmartIF<T>{ service( typeName, createIf ) };
  }

service() [3/4]

virtual SmartIF<IService>& ISvcLocator::service ( const Gaudi::Utils::TypeNameString &  typeName, const bool  createIf = true  )

pure virtual

Returns a smart pointer to a service.

service() [4/4]

template<class T >

StatusCode ISvcLocator::service ( std::string_view  type, std::string_view  name, T *&  svc, bool  createIf = true  )

inline

Templated method to access a service by type and name.

Definition at line 110 of file ISvcLocator.h.

                                                                                     {
    return service( std::string{ type }.append( "/" ).append( name ), svc, createIf );
  }

---

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

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