The Gaudi Framework  master (37c0b60a)
IAppMgrUI.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_IAPPMGRUI_H
12 #define GAUDIKERNEL_IAPPMGRUI_H 1
13 
14 // Include files
17 #include <GaudiKernel/StatusCode.h>
18 
19 #include <string>
20 
21 namespace Gaudi::Monitoring {
22  struct Hub;
23 }
24 
34 class GAUDI_API IAppMgrUI : virtual public INamedInterface {
35 public:
39  virtual StatusCode run() = 0;
41  virtual StatusCode configure() = 0;
43  virtual StatusCode terminate() = 0;
45  virtual StatusCode initialize() = 0;
47  virtual StatusCode finalize() = 0;
49  virtual StatusCode nextEvent( int maxevt ) = 0;
50 
52  virtual StatusCode start() = 0;
53 
55  virtual StatusCode stop() = 0;
56 
58  virtual StatusCode reinitialize() = 0;
59 
61  virtual StatusCode restart() = 0;
62 
64  virtual Gaudi::StateMachine::State FSMState() const = 0;
65 
67  virtual void outputLevelUpdate() = 0;
68 
70  throw GaudiException( "IAppMgrUI", "monitoringHub access not implemented", StatusCode::FAILURE );
71  }
72 };
73 #endif // KERNEL_IAPPMGRUI_H
IAppMgrUI::restart
virtual StatusCode restart()=0
Initialization (from RUNNING to RUNNING, via INITIALIZED).
IAppMgrUI::terminate
virtual StatusCode terminate()=0
Terminate the job.
GaudiException
Definition: GaudiException.h:31
Gaudi::Monitoring
Definition: JSONSink.cpp:19
IAppMgrUI::reinitialize
virtual StatusCode reinitialize()=0
Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
IAppMgrUI::stop
virtual StatusCode stop()=0
Stop (from RUNNING to INITIALIZED).
StatusCode.h
IAppMgrUI::start
virtual StatusCode start()=0
Start (from INITIALIZED to RUNNING).
StateMachine.h
Gaudi::StateMachine::State
State
Allowed states for classes implementing the state machine (ApplicationMgr, Algorithm,...
Definition: StateMachine.h:22
INamedInterface.h
StatusCode
Definition: StatusCode.h:65
IAppMgrUI::monitoringHub
virtual Gaudi::Monitoring::Hub & monitoringHub()
Definition: IAppMgrUI.h:69
IAppMgrUI::run
virtual StatusCode run()=0
Run the complete job (from initialize to terminate)
IAppMgrUI
Definition: IAppMgrUI.h:34
INamedInterface
Definition: INamedInterface.h:25
IAppMgrUI::configure
virtual StatusCode configure()=0
Configure the job.
IAppMgrUI::DeclareInterfaceID
DeclareInterfaceID(IAppMgrUI, 4, 1)
InterfaceID.
IAppMgrUI::finalize
virtual StatusCode finalize()=0
Finalize the job.
IAppMgrUI::outputLevelUpdate
virtual void outputLevelUpdate()=0
Function to call to update the outputLevel of the components (after a change in MessageSvc).
IAppMgrUI::nextEvent
virtual StatusCode nextEvent(int maxevt)=0
Process the next maxevt events.
Gaudi::Monitoring::Hub
Central entity in a Gaudi application that manages monitoring objects (i.e.
Definition: MonitoringHub.h:50
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition: StatusCode.h:101
IAppMgrUI::FSMState
virtual Gaudi::StateMachine::State FSMState() const =0
Get the current state.
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:81
IAppMgrUI::initialize
virtual StatusCode initialize()=0
Initialize the job.