The Gaudi Framework
master (9f3f8895)
Toggle main menu visibility
Loading...
Searching...
No Matches
IAppMgrUI.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/INamedInterface.h
>
14
#include <
GaudiKernel/StateMachine.h
>
15
#include <
GaudiKernel/StatusCode.h
>
16
#include <string>
17
18
namespace
Gaudi::Monitoring
{
19
struct
Hub
;
20
}
21
30
31
class
GAUDI_API
IAppMgrUI
:
virtual
public
INamedInterface
{
32
public
:
34
DeclareInterfaceID
(
IAppMgrUI
, 4, 1 );
36
virtual
StatusCode
run
() = 0;
38
virtual
StatusCode
configure
() = 0;
40
virtual
StatusCode
terminate
() = 0;
42
virtual
StatusCode
initialize
() = 0;
44
virtual
StatusCode
finalize
() = 0;
46
virtual
StatusCode
nextEvent
(
int
maxevt ) = 0;
47
49
virtual
StatusCode
start
() = 0;
50
52
virtual
StatusCode
stop
() = 0;
53
55
virtual
StatusCode
reinitialize
() = 0;
56
58
virtual
StatusCode
restart
() = 0;
59
61
virtual
Gaudi::StateMachine::State
FSMState
()
const
= 0;
62
64
virtual
void
outputLevelUpdate
() = 0;
65
66
virtual
Gaudi::Monitoring::Hub
&
monitoringHub
() {
67
throw
GaudiException
(
"IAppMgrUI"
,
"monitoringHub access not implemented"
,
StatusCode::FAILURE
);
68
}
69
};
INamedInterface.h
GAUDI_API
#define GAUDI_API
Definition
Kernel.h:49
StateMachine.h
StatusCode.h
GaudiException
Define general base for Gaudi exception.
Definition
GaudiException.h:29
IAppMgrUI
Application Manager User Interface.
Definition
IAppMgrUI.h:31
IAppMgrUI::terminate
virtual StatusCode terminate()=0
Terminate the job.
IAppMgrUI::DeclareInterfaceID
DeclareInterfaceID(IAppMgrUI, 4, 1)
InterfaceID.
IAppMgrUI::reinitialize
virtual StatusCode reinitialize()=0
Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
IAppMgrUI::monitoringHub
virtual Gaudi::Monitoring::Hub & monitoringHub()
Definition
IAppMgrUI.h:66
IAppMgrUI::FSMState
virtual Gaudi::StateMachine::State FSMState() const =0
Get the current state.
IAppMgrUI::initialize
virtual StatusCode initialize()=0
Initialize the job.
IAppMgrUI::finalize
virtual StatusCode finalize()=0
Finalize the job.
IAppMgrUI::configure
virtual StatusCode configure()=0
Configure the job.
IAppMgrUI::restart
virtual StatusCode restart()=0
Initialization (from RUNNING to RUNNING, via INITIALIZED).
IAppMgrUI::stop
virtual StatusCode stop()=0
Stop (from RUNNING to INITIALIZED).
IAppMgrUI::nextEvent
virtual StatusCode nextEvent(int maxevt)=0
Process the next maxevt events.
IAppMgrUI::start
virtual StatusCode start()=0
Start (from INITIALIZED to RUNNING).
IAppMgrUI::outputLevelUpdate
virtual void outputLevelUpdate()=0
Function to call to update the outputLevel of the components (after a change in MessageSvc).
IAppMgrUI::run
virtual StatusCode run()=0
Run the complete job (from initialize to terminate).
INamedInterface
IInterface compliant class extending IInterface with the name() method.
Definition
INamedInterface.h:23
StatusCode
This class is used for returning status codes from appropriate routines.
Definition
StatusCode.h:64
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition
StatusCode.h:100
Gaudi::Monitoring
Definition
JSONSink.cpp:19
Gaudi::StateMachine::State
State
Allowed states for classes implementing the state machine (ApplicationMgr, Algorithm,...
Definition
StateMachine.h:21
Gaudi::Monitoring::Hub
Central entity in a Gaudi application that manages monitoring objects (i.e.
Definition
MonitoringHub.h:47
GaudiKernel
include
GaudiKernel
IAppMgrUI.h
Generated on
for The Gaudi Framework by
1.17.0