The Gaudi Framework  master (37c0b60a)
IStateful.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_ISTATEFUL_H
12 #define GAUDIKERNEL_ISTATEFUL_H
13 
14 // Include Files
15 #include <GaudiKernel/IInterface.h>
17 #include <string>
18 
26 class GAUDI_API IStateful : virtual public IInterface {
27 public:
30 
33  virtual StatusCode configure() = 0;
34 
37  virtual StatusCode initialize() = 0;
38 
41  virtual StatusCode start() = 0;
42 
45  virtual StatusCode stop() = 0;
46 
49  virtual StatusCode finalize() = 0;
50 
53  virtual StatusCode terminate() = 0;
54 
57  virtual StatusCode reinitialize() = 0;
58 
61  virtual StatusCode restart() = 0;
62 
65  virtual Gaudi::StateMachine::State FSMState() const = 0;
66 
71 };
72 
73 #endif // GAUDIKERNEL_ISTATEFUL_H
IStateful
Definition: IStateful.h:26
IStateful::start
virtual StatusCode start()=0
Start (from INITIALIZED to RUNNING).
IStateful::DeclareInterfaceID
DeclareInterfaceID(IStateful, 1, 0)
InterfaceID.
IStateful::stop
virtual StatusCode stop()=0
Stop (from RUNNING to INITIALIZED).
IStateful::reinitialize
virtual StatusCode reinitialize()=0
Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
IStateful::targetFSMState
virtual Gaudi::StateMachine::State targetFSMState() const =0
When we are in the middle of a transition, get the state where the transition is leading us.
IStateful::terminate
virtual StatusCode terminate()=0
Initialization (from CONFIGURED to OFFLINE).
StateMachine.h
Gaudi::StateMachine::State
State
Allowed states for classes implementing the state machine (ApplicationMgr, Algorithm,...
Definition: StateMachine.h:22
StatusCode
Definition: StatusCode.h:65
IInterface.h
IStateful::initialize
virtual StatusCode initialize()=0
Initialization (from CONFIGURED to INITIALIZED).
IInterface
Definition: IInterface.h:239
IStateful::configure
virtual StatusCode configure()=0
Configuration (from OFFLINE to CONFIGURED).
IStateful::FSMState
virtual Gaudi::StateMachine::State FSMState() const =0
Get the current state.
IStateful::restart
virtual StatusCode restart()=0
Initialization (from RUNNING to RUNNING, via INITIALIZED).
IStateful::finalize
virtual StatusCode finalize()=0
Finalize (from INITIALIZED to CONFIGURED).
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:81