ATLAS Offline Software
AnaAlgorithmWrapper.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
3 */
4 
6 
7 
8 
9 #ifndef ANA_ALGORITHM__ANA_ALGORITHM_WRAPPER_H
10 #define ANA_ALGORITHM__ANA_ALGORITHM_WRAPPER_H
11 
12 #include <AnaAlgorithm/Global.h>
13 
17 
18 namespace EL
19 {
21 
23  {
24  public:
25 
28 
30  void testInvariant () const;
31 
34 
37 
38 
39 
42 
43  virtual std::string_view getName () const override;
44 
45  virtual bool hasName (const std::string& name) const override;
46 
47  virtual std::unique_ptr<IAlgorithmWrapper> makeClone() const override;
48 
49  virtual StatusCode initialize (const AlgorithmWorkerData& workerData) override;
50 
51  virtual StatusCode execute () override;
52 
53  virtual StatusCode finalize () override;
54 
56 
58 
60 
61 
62 
65 
66  private:
67 
70 
76  std::unique_ptr<AnaAlgorithm> m_algorithm;
77  };
78 }
79 
80 #endif
EL::AnaAlgorithmWrapper::execute
virtual StatusCode execute() override
call execute on the algorithm
Definition: AnaAlgorithmWrapper.cxx:82
EL::AnaAlgorithmWrapper::beginInputFile
virtual ::StatusCode beginInputFile() override
call beginInputFile on the algorithm
Definition: AnaAlgorithmWrapper.cxx:130
EL::AnaAlgorithmWrapper::AnaAlgorithmWrapper
AnaAlgorithmWrapper()
standard default constructor for serialization
Definition: AnaAlgorithmWrapper.h:33
EL::AnaAlgorithmConfig
an object that can create a AnaAlgorithm
Definition: AnaAlgorithmConfig.h:29
EL::AnaAlgorithmWrapper::endInputFile
virtual ::StatusCode endInputFile() override
call endInputFile on the algorithm
Definition: AnaAlgorithmWrapper.cxx:148
EL::AnaAlgorithmWrapper::testInvariant
void testInvariant() const
test the invariant of this object
Definition: AnaAlgorithmWrapper.cxx:23
AnaAlgorithm.h
EL::AnaAlgorithmWrapper::hasName
virtual bool hasName(const std::string &name) const override
whether this algorithm has the given name
Definition: AnaAlgorithmWrapper.cxx:49
EL::AnaAlgorithmWrapper
an IAlgorithmWrapper for AnaAlgorithm
Definition: AnaAlgorithmWrapper.h:23
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
EL
This module defines the arguments passed from the BATCH driver to the BATCH worker.
Definition: AlgorithmWorkerData.h:24
Global.h
EL::AnaAlgorithmWrapper::initialize
virtual StatusCode initialize(const AlgorithmWorkerData &workerData) override
call initialize on the algorithm
Definition: AnaAlgorithmWrapper.cxx:67
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:195
EL::AnaAlgorithmWrapper::getName
virtual std::string_view getName() const override
Definition: AnaAlgorithmWrapper.cxx:40
EL::AlgorithmWorkerData
all the external components an algorithm needs before initialization (in EventLoop)
Definition: AlgorithmWorkerData.h:34
EL::AnaAlgorithmWrapper::makeClone
virtual std::unique_ptr< IAlgorithmWrapper > makeClone() const override
make a clone of this algorithm
Definition: AnaAlgorithmWrapper.cxx:58
EL::AnaAlgorithmWrapper::m_algorithm
std::unique_ptr< AnaAlgorithm > m_algorithm
the actual algorithm (once instantiated)
Definition: AnaAlgorithmWrapper.h:76
EL::IAlgorithmWrapper
a wrapper around a generic algorithm for use within EventLoop
Definition: IAlgorithmWrapper.h:48
EL::AnaAlgorithmWrapper::finalize
virtual StatusCode finalize() override
call finalize on the algorithm
Definition: AnaAlgorithmWrapper.cxx:97
EL::AnaAlgorithmWrapper::fileExecute
virtual ::StatusCode fileExecute() override
call fileExecute on the algorithm
Definition: AnaAlgorithmWrapper.cxx:112
IAlgorithmWrapper.h
EL::AnaAlgorithmWrapper::m_config
AnaAlgorithmConfig m_config
the algorithm configuration
Definition: AnaAlgorithmWrapper.h:69
AnaAlgorithmConfig.h