The Gaudi Framework  v33r0 (d5ea422b)
IAlgTool.h
Go to the documentation of this file.
1 /***********************************************************************************\
2 * (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
3 * *
4 * This software is distributed under the terms of the Apache version 2 licence, *
5 * copied verbatim in the file "LICENSE". *
6 * *
7 * In applying this licence, CERN does not waive the privileges and immunities *
8 * granted to it by virtue of its status as an Intergovernmental Organization *
9 * or submit itself to any jurisdiction. *
10 \***********************************************************************************/
11 #ifndef GAUDIKERNEL_IALGTOOL_H
12 #define GAUDIKERNEL_IALGTOOL_H
13 
14 // Include files
16 #include "GaudiKernel/IStateful.h"
17 #include <string>
18 
19 // Forward declarations
20 class IAlgorithm;
21 
33 class GAUDI_API IAlgTool : virtual public INamedInterface {
34 public:
37 
39  virtual const std::string& type() const = 0;
40 
44  virtual const IInterface* parent() const = 0;
45 
46  // --- Methods from IStateful ---
49  virtual StatusCode configure() = 0;
50 
53  virtual StatusCode initialize() = 0;
54 
57  virtual StatusCode start() = 0;
58 
61  virtual StatusCode stop() = 0;
62 
65  virtual StatusCode finalize() = 0;
66 
69  virtual StatusCode terminate() = 0;
70 
73  virtual StatusCode reinitialize() = 0;
74 
77  virtual StatusCode restart() = 0;
78 
81  virtual Gaudi::StateMachine::State FSMState() const = 0;
82 
87  virtual StatusCode sysInitialize() = 0;
88 
93  virtual StatusCode sysStart() = 0;
94 
99  virtual StatusCode sysStop() = 0;
100 
105  virtual StatusCode sysFinalize() = 0;
106 
111  virtual StatusCode sysReinitialize() = 0;
112 
117  virtual StatusCode sysRestart() = 0;
118 };
119 
120 #endif // GAUDIKERNEL_IALGTOOL_H
DeclareInterfaceID(INamedInterface, 1, 0)
InterfaceID.
State
Allowed states for classes implementing the state machine (ApplicationMgr, Algorithm,...
Definition: StateMachine.h:22
def start
Definition: IOTest.py:108
STL class.
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:61
Definition of the basic interface.
Definition: IInterface.h:254
The IAlgorithm is the interface implemented by the Algorithm base class.
Definition: IAlgorithm.h:38
IInterface compliant class extending IInterface with the name() method.
The interface implemented by the AlgTool base class.
Definition: IAlgTool.h:33
#define GAUDI_API
Definition: Kernel.h:81