The Gaudi Framework
master (123e188a)
Toggle main menu visibility
Loading...
Searching...
No Matches
IStateful.h
Go to the documentation of this file.
1
/***********************************************************************************\
2
* (c) Copyright 1998-2025 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
#pragma once
12
13
#include <
GaudiKernel/IInterface.h
>
14
#include <
GaudiKernel/StateMachine.h
>
15
#include <string>
16
24
class
GAUDI_API
IStateful
:
virtual
public
IInterface
{
25
public
:
27
DeclareInterfaceID
(
IStateful
, 1, 0 );
28
31
virtual
StatusCode
configure
() = 0;
32
35
virtual
StatusCode
initialize
() = 0;
36
39
virtual
StatusCode
start
() = 0;
40
43
virtual
StatusCode
stop
() = 0;
44
47
virtual
StatusCode
finalize
() = 0;
48
51
virtual
StatusCode
terminate
() = 0;
52
55
virtual
StatusCode
reinitialize
() = 0;
56
59
virtual
StatusCode
restart
() = 0;
60
63
virtual
Gaudi::StateMachine::State
FSMState
()
const
= 0;
64
68
virtual
Gaudi::StateMachine::State
targetFSMState
()
const
= 0;
69
};
IInterface.h
GAUDI_API
#define GAUDI_API
Definition
Kernel.h:49
StateMachine.h
IInterface
Definition of the basic interface.
Definition
IInterface.h:225
IStateful
Interface for classes that implement the Gaudi State Machine.
Definition
IStateful.h:24
IStateful::finalize
virtual StatusCode finalize()=0
Finalize (from INITIALIZED to CONFIGURED).
IStateful::configure
virtual StatusCode configure()=0
Configuration (from OFFLINE to CONFIGURED).
IStateful::terminate
virtual StatusCode terminate()=0
Initialization (from CONFIGURED to OFFLINE).
IStateful::restart
virtual StatusCode restart()=0
Initialization (from RUNNING to RUNNING, via 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::start
virtual StatusCode start()=0
Start (from INITIALIZED to RUNNING).
IStateful::stop
virtual StatusCode stop()=0
Stop (from RUNNING to INITIALIZED).
IStateful::FSMState
virtual Gaudi::StateMachine::State FSMState() const =0
Get the current state.
IStateful::DeclareInterfaceID
DeclareInterfaceID(IStateful, 1, 0)
InterfaceID.
IStateful::initialize
virtual StatusCode initialize()=0
Initialization (from CONFIGURED to INITIALIZED).
StatusCode
This class is used for returning status codes from appropriate routines.
Definition
StatusCode.h:64
Gaudi::StateMachine::State
State
Allowed states for classes implementing the state machine (ApplicationMgr, Algorithm,...
Definition
StateMachine.h:21
GaudiKernel
include
GaudiKernel
IStateful.h
Generated on
for The Gaudi Framework by
1.17.0