| The Gaudi Framework v30r0 (c919700c)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

ISvcLocator.h
Go to the documentation of this file.
1 #ifndef GAUDIKERNEL_ISVCLOCATOR_H
2 #define GAUDIKERNEL_ISVCLOCATOR_H 1
3
4 // Include files
5 #include "GaudiKernel/IInterface.h"
6 #include "GaudiKernel/ISvcManager.h"
7 #include "GaudiKernel/SmartIF.h"
8 #include "GaudiKernel/TypeNameString.h"
9 #include <list>
10 #include <string>
11
12 // Forward class declaration
13 class IService;
14
25 class GAUDI_API ISvcLocator : virtual public IInterface
26 {
27 public:
29 DeclareInterfaceID( ISvcLocator, 3, 0 );
30
31 #if !defined( GAUDI_V22_API ) || defined( G22_NEW_SVCLOCATOR )
32
36 virtual StatusCode getService( const Gaudi::Utils::TypeNameString& typeName, IService*& svc,
37 const bool createIf = true )
38 {
39 SmartIF<IService>& s = service( typeName, createIf );
40 svc = s.get();
41 if ( svc ) {
42 svc->addRef(); // Needed to maintain the correct reference counting.
43 return StatusCode::SUCCESS;
44 }
45 return StatusCode::FAILURE;
46 }
47
53 virtual StatusCode getService( const Gaudi::Utils::TypeNameString& typeName, const InterfaceID& iid,
54 IInterface*& pinterface )
55 {
56 auto svc = service( typeName, false );
57 return svc ? svc->queryInterface( iid, (void**)&pinterface ) : StatusCode::FAILURE;
58 }
59
65 // virtual StatusCode getService( const Gaudi::Utils::TypeNameString& name,
66 // IService*& svc,
67 // bool createIf ) = 0;
68 #endif
69
71 virtual const std::list<IService*>& getServices() const = 0;
72
74 virtual bool existsService( const std::string& name ) const = 0;
75
76 #if !defined( GAUDI_V22_API ) || defined( G22_NEW_SVCLOCATOR )
77 template <class T>
79 StatusCode service( const Gaudi::Utils::TypeNameString& name, T*& svc, bool createIf = true )
80 {
81 if ( createIf ) {
82 IService* s;
83 StatusCode sc = getService( name, s, true );
84 if ( !sc.isSuccess() ) return sc; // Must check if initialization was OK!
85 }
86 return getService( name, T::interfaceID(), (IInterface*&)svc );
87 }
88
90 template <class T>
91 StatusCode service( const std::string& type, const std::string& name, T*& svc, bool createIf = true )
92 {
93 return service( type + "/" + name, svc, createIf );
94 }
95 #endif
96
98 virtual SmartIF<IService>& service( const Gaudi::Utils::TypeNameString& typeName, const bool createIf = true ) = 0;
99
101 template <typename T>
102 inline SmartIF<T> service( const Gaudi::Utils::TypeNameString& typeName, const bool createIf = true )
103 {
104 return SmartIF<T>{service( typeName, createIf )};
105 }
106
107 // try to access a different interface of the _current_ serviceLocator...
108 template <typename IFace>
109 SmartIF<IFace> as()
110 {
111 return SmartIF<IFace>{this};
112 }
113 };
114
115 #endif // GAUDI_ISVCLOCATOR_H
StatusCode::SUCCESS
Definition: StatusCode.h:29
SmartIF< IService >
ISvcLocator
The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to loc...
Definition: ISvcLocator.h:25
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:32
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:50
ISvcLocator::service
SmartIF< T > service(const Gaudi::Utils::TypeNameString &typeName, const bool createIf=true)
Returns a smart pointer to the requested interface of a service.
Definition: ISvcLocator.h:102
ISvcLocator::service
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.
Definition: ISvcLocator.h:91
ISvcLocator::as
SmartIF< IFace > as()
Definition: ISvcLocator.h:109
ISvcManager.h
std::string
STL class.
SmartIF::get
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:82
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:79
InterfaceID
Interface ID class.
Definition: IInterface.h:29
Gaudi::Utils::TypeNameString
Helper class to parse a string of format "type/name".
Definition: TypeNameString.h:12
IService
General service interface definition.
Definition: IService.h:18
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
DeclareInterfaceID
#define DeclareInterfaceID(iface, major, minor)
Macro to declare the interface ID when using the new mechanism of extending and implementing interfac...
Definition: IInterface.h:13
IInterface
Definition of the basic interface.
Definition: IInterface.h:277
gaudirun.type
type
Definition: gaudirun.py:133
SmartIF.h
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
std::list< IService * >
ISvcLocator::getService
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.
Definition: ISvcLocator.h:53
gaudirun.s
string s
Definition: gaudirun.py:253
TypeNameString.h
StatusCode::FAILURE
Definition: StatusCode.h:29
GaudiDict::typeName
std::string typeName(const std::type_info &typ)
Definition: Dictionary.cpp:23
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:110
IInterface.h
getService
IInterface *PyHelper() getService(IInterface *app, char *name)
Definition: Bootstrap.cpp:241
IInterface::iid
Gaudi::InterfaceId< IInterface, 0, 0 > iid
Interface ID.
Definition: IInterface.h:281