The Gaudi Framework
master (37c0b60a)
IAlgTool.h
Go to the documentation of this file.
1
/***********************************************************************************\
2
* (c) Copyright 1998-2024 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
15
#include <
GaudiKernel/INamedInterface.h
>
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
:
36
DeclareInterfaceID
(
IAlgTool
, 4, 0 );
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
std::string
STL class.
IAlgTool
Definition:
IAlgTool.h:33
IAlgTool::terminate
virtual StatusCode terminate()=0
Initialization (from CONFIGURED to OFFLINE).
IAlgTool::start
virtual StatusCode start()=0
Start (from INITIALIZED to RUNNING).
IAlgTool::sysFinalize
virtual StatusCode sysFinalize()=0
Finalization of the Tool.
IAlgTool::finalize
virtual StatusCode finalize()=0
Finalize (from INITIALIZED to CONFIGURED).
IAlgTool::DeclareInterfaceID
DeclareInterfaceID(IAlgTool, 4, 0)
InterfaceID.
IAlgTool::sysReinitialize
virtual StatusCode sysReinitialize()=0
Initialization of the Tool.
Gaudi::StateMachine::State
State
Allowed states for classes implementing the state machine (ApplicationMgr, Algorithm,...
Definition:
StateMachine.h:22
INamedInterface.h
IAlgTool::sysRestart
virtual StatusCode sysRestart()=0
Initialization of the Tool.
StatusCode
Definition:
StatusCode.h:65
IAlgorithm
Definition:
IAlgorithm.h:38
IAlgTool::FSMState
virtual Gaudi::StateMachine::State FSMState() const =0
Get the current state.
IStateful.h
IAlgTool::reinitialize
virtual StatusCode reinitialize()=0
Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
IAlgTool::restart
virtual StatusCode restart()=0
Initialization (from RUNNING to RUNNING, via INITIALIZED).
IAlgTool::type
virtual const std::string & type() const =0
The type of an AlgTool, meaning the concrete AlgTool class.
IAlgTool::stop
virtual StatusCode stop()=0
Stop (from RUNNING to INITIALIZED).
IAlgTool::initialize
virtual StatusCode initialize()=0
Initialization (from CONFIGURED to INITIALIZED).
IAlgTool::parent
virtual const IInterface * parent() const =0
The parent of the concrete AlgTool.
INamedInterface
Definition:
INamedInterface.h:25
IAlgTool::sysInitialize
virtual StatusCode sysInitialize()=0
Initialization of the Tool.
IAlgTool::sysStart
virtual StatusCode sysStart()=0
Initialization of the Tool.
IInterface
Definition:
IInterface.h:239
IAlgTool::configure
virtual StatusCode configure()=0
Configuration (from OFFLINE to CONFIGURED).
GAUDI_API
#define GAUDI_API
Definition:
Kernel.h:81
IAlgTool::sysStop
virtual StatusCode sysStop()=0
Initialization of the Tool.
GaudiKernel
include
GaudiKernel
IAlgTool.h
Generated on Thu Dec 19 2024 15:35:01 for The Gaudi Framework by
1.8.18