| The Gaudi Framework v27r1

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

- File List
- File Members

IAlgContextSvc.h
Go to the documentation of this file.
1 // ============================================================================
2 #ifndef GAUDIKERNEL_IALGCONTEXTSVC_H
3 #define GAUDIKERNEL_IALGCONTEXTSVC_H
4 // ============================================================================
5 // Include files:
6 // ============================================================================
7 // STD & STL
8 // ============================================================================
9 #include <vector>
10 // ============================================================================
11 // GaudiKernel
12 // ============================================================================
13 #include "GaudiKernel/IInterface.h"
14 #include "GaudiKernel/SmartIF.h"
15 #include "GaudiKernel/IAlgorithm.h"
16 // ============================================================================
23 class GAUDI_API IAlgContextSvc: virtual public IInterface
24 {
25 public:
27 DeclareInterfaceID(IAlgContextSvc,3,0);
29 typedef std::vector<IAlgorithm*> Algorithms ;
30 public:
32 virtual StatusCode setCurrentAlg ( IAlgorithm* a ) = 0 ;
34 virtual StatusCode unSetCurrentAlg ( IAlgorithm* a ) = 0 ;
36 virtual IAlgorithm* currentAlg () const = 0 ;
38 virtual const Algorithms& algorithms () const = 0 ;
39 protected:
41 ~IAlgContextSvc() override = default;
42 } ;
43 // ============================================================================
44 namespace Gaudi
45 {
46 namespace Utils
47 {
79 class GAUDI_API AlgContext final
80 {
81 public:
89 AlgContext
90 ( IAlgContextSvc* svc ,
91 IAlgorithm* alg ) ;
99 AlgContext
100 ( IAlgorithm* alg ,
101 IAlgContextSvc* svc ) ;
107 ~AlgContext() ;
108 private:
109 // default constructor is disabled
110 AlgContext() = delete;
111 // copy constructor is disabled
112 AlgContext ( const AlgContext& right ) = delete;
113 // assignement operator is disabled
114 AlgContext& operator=( const AlgContext& right ) = delete;
115 private:
116 SmartIF<IAlgContextSvc> m_svc ;
117 SmartIF<IAlgorithm> m_alg ;
118 };
119 } // end of namespace Gaudi::Utils
120 } // end of namespace Gaudi
121 // ============================================================================
122 // The END
123 // ============================================================================
124 #endif // GAUDIKERNEL_IALGCONTEXTSVC_H
125 // ============================================================================
SmartIF< IAlgContextSvc >
Gaudi::Utils::AlgContext
Helper "sentry" class to automatize the safe register/unregister the algorithm's context.
Definition: IAlgContextSvc.h:79
IAlgorithm.h
IAlgContextSvc::Algorithms
std::vector< IAlgorithm * > Algorithms
the actual type of algorithm' stack
Definition: IAlgContextSvc.h:29
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
IInterface
Definition of the basic interface.
Definition: IInterface.h:234
SmartIF.h
IAlgorithm
The IAlgorithm is the interface implemented by the Algorithm base class.
Definition: IAlgorithm.h:25
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:14
std::vector< IAlgorithm * >
Gaudi::Utils::AlgContext::m_svc
SmartIF< IAlgContextSvc > m_svc
Definition: IAlgContextSvc.h:116
IAlgContextSvc
An abstract interface for Algorithm Context Service.
Definition: IAlgContextSvc.h:23
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:107
IInterface.h
Gaudi
Helper functions to set/get the application return code.
Definition: __init__.py:1
Gaudi::Utils::AlgContext::m_alg
SmartIF< IAlgorithm > m_alg
Definition: IAlgContextSvc.h:117