Public Member Functions | List of all members
ISvcLocator Class Referenceabstract

The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to locate services in the framework. More...

#include <GaudiKernel/ISvcLocator.h>

Inheritance diagram for ISvcLocator:
Inheritance graph
[legend]
Collaboration diagram for ISvcLocator:
Collaboration graph
[legend]

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 (const std::string &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 (const std::string &type, const std::string &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...
 
 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 (const std::string &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 (const std::string &type, const std::string &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...
 
- 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 ()
 Virtual destructor. More...
 
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 ()
 Virtual destructor. More...
 

Additional Inherited Members

- Public Types inherited from IInterface
enum  Status {
  SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR,
  SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR
}
 Return status. More...
 
enum  Status {
  SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR,
  SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR
}
 Return status. More...
 
typedef Gaudi::InterfaceId< IInterface, 0, 0 > iid
 Interface ID. More...
 
typedef mpl::set1< iid > ext_iids
 Extra interfaces. More...
 
typedef Gaudi::InterfaceId< IInterface, 0, 0 > iid
 Interface ID. More...
 
typedef mpl::set1< iid > ext_iids
 Extra interfaces. More...
 
- Static Public Member Functions inherited from IInterface
static const InterfaceID & interfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 
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 26 of file ISvcLocator.h.

Member Function Documentation

ISvcLocator::DeclareInterfaceID ( ISvcLocator  ,
3  ,
0   
)

InterfaceID.

ISvcLocator::DeclareInterfaceID ( ISvcLocator  ,
3  ,
0   
)

InterfaceID.

virtual bool ISvcLocator::existsService ( const std::string &  name) const
pure virtual

Check the existence of a service given a service name.

Implemented in ServiceManager, and Gaudi::BootSvcLocator.

virtual bool ISvcLocator::existsService ( const std::string &  name) const
pure virtual

Check the existence of a service given a service name.

Implemented in ServiceManager, and Gaudi::BootSvcLocator.

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
nameService name
svcReturned service pointer

Reimplemented in Gaudi::BootSvcLocator.

Definition at line 36 of file ISvcLocator.h.

37  {
38  SmartIF<IService> &s = service(typeName, createIf);
39  svc = s.get();
40  if (svc) {
41  svc->addRef(); // Needed to maintain the correct reference counting.
42  return StatusCode::SUCCESS;
43  }
44  return StatusCode::FAILURE;
45  }
SmartIF::get
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:62
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:82
gaudirun.s
string s
Definition: gaudirun.py:244
IInterface::addRef
virtual unsigned long addRef()=0
Increment the reference count of Interface instance.
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
nameService name
svcReturned service pointer

Reimplemented in Gaudi::BootSvcLocator.

Definition at line 36 of file ISvcLocator.h.

37  {
38  SmartIF<IService> &s = service(typeName, createIf);
39  svc = s.get();
40  if (svc) {
41  svc->addRef(); // Needed to maintain the correct reference counting.
42  return StatusCode::SUCCESS;
43  }
44  return StatusCode::FAILURE;
45  }
SmartIF::get
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:62
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:82
gaudirun.s
string s
Definition: gaudirun.py:244
IInterface::addRef
virtual unsigned long addRef()=0
Increment the reference count of Interface instance.
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
nameService name
iidInterface ID
pinterfaceReturned pointer to the requested interface

Reimplemented in Gaudi::BootSvcLocator.

Definition at line 52 of file ISvcLocator.h.

54  {
55  SmartIF<IService> svc = service(typeName, false);
56  if (svc.isValid()) {
57  // Service found. So now get the right interface
58  return svc->queryInterface(iid, (void**)&pinterface);
59  }
60  return StatusCode::FAILURE;
61  }
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:82
SmartIF::isValid
bool isValid() const
Allow for check if smart pointer is valid.
Definition: SmartIF.h:51
IInterface::queryInterface
virtual StatusCode queryInterface(const InterfaceID &ti, void **pp)=0
Set the void** to the pointer to the requested interface of the instance.
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
nameService name
iidInterface ID
pinterfaceReturned pointer to the requested interface

Reimplemented in Gaudi::BootSvcLocator.

Definition at line 52 of file ISvcLocator.h.

54  {
55  SmartIF<IService> svc = service(typeName, false);
56  if (svc.isValid()) {
57  // Service found. So now get the right interface
58  return svc->queryInterface(iid, (void**)&pinterface);
59  }
60  return StatusCode::FAILURE;
61  }
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:82
SmartIF::isValid
bool isValid() const
Allow for check if smart pointer is valid.
Definition: SmartIF.h:51
IInterface::queryInterface
virtual StatusCode queryInterface(const InterfaceID &ti, void **pp)=0
Set the void** to the pointer to the requested interface of the instance.
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
nameService name
svcReturned service pointer
createIfflag to control the creationReturn the list of Services

Implemented in ServiceManager, and Gaudi::BootSvcLocator.

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
nameService name
svcReturned service pointer
createIfflag to control the creationReturn the list of Services

Implemented in ServiceManager, and Gaudi::BootSvcLocator.

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 82 of file ISvcLocator.h.

82  {
83  if( createIf ) {
84  IService* s;
85  StatusCode sc = getService( name, s, true);
86  if ( !sc.isSuccess() ) return sc; // Must check if initialization was OK!
87  }
88  return getService( name, T::interfaceID(), (IInterface*&)svc );
89  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
merge_files.sc
int sc
Definition: merge_files.py:153
IService
General service interface definition.
Definition: IService.h:19
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:30
IInterface
Definition of the basic interface.
Definition: IInterface.h:160
ISvcLocator::getService
virtual StatusCode getService(const Gaudi::Utils::TypeNameString &typeName, IService *&svc, const bool createIf=true)
Get a reference to the service given a service name.
Definition: ISvcLocator.h:36
gaudirun.s
string s
Definition: gaudirun.py:244
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 82 of file ISvcLocator.h.

82  {
83  if( createIf ) {
84  IService* s;
85  StatusCode sc = getService( name, s, true);
86  if ( !sc.isSuccess() ) return sc; // Must check if initialization was OK!
87  }
88  return getService( name, T::interfaceID(), (IInterface*&)svc );
89  }
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
merge_files.sc
int sc
Definition: merge_files.py:153
IService
General service interface definition.
Definition: IService.h:19
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:30
IInterface
Definition of the basic interface.
Definition: IInterface.h:160
ISvcLocator::getService
virtual StatusCode getService(const Gaudi::Utils::TypeNameString &typeName, IService *&svc, const bool createIf=true)
Get a reference to the service given a service name.
Definition: ISvcLocator.h:36
gaudirun.s
string s
Definition: gaudirun.py:244
template<class T >
StatusCode ISvcLocator::service ( const std::string &  type,
const std::string &  name,
T *&  svc,
bool  createIf = true 
)
inline

Templated method to access a service by type and name.

Definition at line 93 of file ISvcLocator.h.

94  {
95  return service(type + "/" + name, svc, createIf);
96  }
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:82
gaudirun.type
string type
Definition: gaudirun.py:151
template<class T >
StatusCode ISvcLocator::service ( const std::string &  type,
const std::string &  name,
T *&  svc,
bool  createIf = true 
)
inline

Templated method to access a service by type and name.

Definition at line 93 of file ISvcLocator.h.

94  {
95  return service(type + "/" + name, svc, createIf);
96  }
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:82
gaudirun.type
string type
Definition: gaudirun.py:151
virtual SmartIF<IService>& ISvcLocator::service ( const Gaudi::Utils::TypeNameString &  typeName,
const bool  createIf = true 
)
pure virtual

Returns a smart pointer to a service.

Implemented in ServiceManager, and Gaudi::BootSvcLocator.

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

Returns a smart pointer to a service.

Implemented in ServiceManager, and Gaudi::BootSvcLocator.

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 104 of file ISvcLocator.h.

104  {
105  return SmartIF<T>(service(typeName, createIf));
106  }
SmartIF
Small smart pointer class with automatic reference counting for IInterface.
Definition: IConverter.h:14
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:82
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 104 of file ISvcLocator.h.

104  {
105  return SmartIF<T>(service(typeName, createIf));
106  }
SmartIF
Small smart pointer class with automatic reference counting for IInterface.
Definition: IConverter.h:14
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:82
The documentation for this class was generated from the following file: