#include <UnitTestAlg1.h>
|
| virtual StatusCode | setupJob (Job &job) override |
| | effects: give the algorithm a chance to intialize the job with anything this algorithm needs. More...
|
| |
| virtual StatusCode | changeInput (bool firstFile) override |
| | effects: do all changes to work with a new input file, e.g. More...
|
| |
| virtual StatusCode | initialize () override |
| | effects: do everything that needs to be done before running the algorithm, e.g. More...
|
| |
| virtual StatusCode | histInitialize () override |
| | effects: this is a pre-initialization routine that is called before changeInput is called. More...
|
| |
| virtual StatusCode | execute () override |
| | effects: process the next event guarantee: basic failures: algorithm dependent rationale: the virtual part of Algorithm::process More...
|
| |
| virtual StatusCode | fileExecute () override |
| | effects: do all the processing that needs to be done once per file guarantee: basic failures: algorithm dependent rationale: this is to read per-file accounting data, e.g. More...
|
| |
| virtual StatusCode | finalize () override |
| | effects: do everything that needs to be done after completing work on this worker guarantee: basic failures: algorithm dependent rationale: currently there is no use foreseen, but this routine is provided regardless rationale: the virtual part of Algorithm::process More...
|
| |
| virtual StatusCode | histFinalize () override |
| | effects: this is a post-initialization routine that is called after finalize has been called. More...
|
| |
| TH1 * | getCallbacks () |
| |
| | ClassDef (UnitTestAlg1, 1) |
| |
| virtual StatusCode | endOfFile () |
| | effects: do the post-processing for each input file guarantee: basic failures: algorithm dependent rationale: this is mainly used for specialized services that need to save partial results for each input file More...
|
| |
| virtual StatusCode | postExecute () |
| | effects: do the post-processing for the event guarantee: basic failures: algorithm dependent rationale: this is mainly used for specialized services that need to get input from subsequent algorithms before filling their event data More...
|
| |
| virtual bool | hasName (const std::string &name) const |
| | returns: whether this algorithm has the given name guarantee: basic failures: algorithm dependent rationale: this is to allow an algorithm to be known by multiple names. More...
|
| |
| void | sysSetupJob (Job &job) |
| | effects: give the algorithm a chance to intialize the job with anything this algorithm needs. More...
|
| |
Definition at line 33 of file UnitTestAlg1.h.
◆ CallBack
the various callbacks we use
| Enumerator |
|---|
| CB_CHANGE_INPUT_FIRST | |
| CB_CHANGE_INPUT_OTHER | |
| CB_INITIALIZE | |
| CB_HIST_INITIALIZE | |
| CB_EXECUTE | |
| CB_FILE_EXECUTE | |
| CB_FINALIZE | |
| CB_HIST_FINALIZE | |
Definition at line 60 of file UnitTestAlg1.h.
◆ UnitTestAlg1()
| EL::UnitTestAlg1::UnitTestAlg1 |
( |
const std::string & |
branchName = "el_n" | ) |
|
effects: standard constructor.
initialize with a branch of type Int_t guarantee: strong failures: low level errors II
◆ book()
| void EL::Algorithm::book |
( |
const TH1 & |
hist | ) |
|
|
inherited |
book the given histogram
- Guarantee
- strong
- Failures
- histogram booking error
◆ changeInput()
| virtual StatusCode EL::UnitTestAlg1::changeInput |
( |
bool |
firstFile | ) |
|
|
overrideprivatevirtual |
effects: do all changes to work with a new input file, e.g.
set new branch addresses. if firstFile is set, this method is called just before init() is called guarantee: basic failures: algorithm dependent
Reimplemented from EL::Algorithm.
◆ ClassDef()
◆ endOfFile()
effects: do the post-processing for each input file guarantee: basic failures: algorithm dependent rationale: this is mainly used for specialized services that need to save partial results for each input file
Reimplemented in EL::MetricsSvc.
◆ evtStore()
get the (main) event store for this algorithm
This is mostly to mirror the method of the same name in AthAlgorithm, allowing to make the tutorial instructions more dual-use.
- Guarantee
- strong
- Failures
- out of memory I
job not configured for xAODs
◆ execute()
effects: process the next event guarantee: basic failures: algorithm dependent rationale: the virtual part of Algorithm::process
Reimplemented from EL::Algorithm.
◆ fileExecute()
| virtual StatusCode EL::UnitTestAlg1::fileExecute |
( |
| ) |
|
|
overrideprivatevirtual |
effects: do all the processing that needs to be done once per file guarantee: basic failures: algorithm dependent rationale: this is to read per-file accounting data, e.g.
the list of lumi-blocks processed
Reimplemented from EL::Algorithm.
◆ finalize()
effects: do everything that needs to be done after completing work on this worker guarantee: basic failures: algorithm dependent rationale: currently there is no use foreseen, but this routine is provided regardless rationale: the virtual part of Algorithm::process
Reimplemented from EL::Algorithm.
◆ getCallbacks()
| TH1* EL::UnitTestAlg1::getCallbacks |
( |
| ) |
|
|
private |
◆ hasName()
| virtual bool EL::Algorithm::hasName |
( |
const std::string & |
name | ) |
const |
|
privatevirtualinherited |
returns: whether this algorithm has the given name guarantee: basic failures: algorithm dependent rationale: this is to allow an algorithm to be known by multiple names.
this is needed for NTupleSvc, so that it can be located with and without the output tree name.
Reimplemented in EL::NTupleSvc.
◆ hist()
| TH1* EL::Algorithm::hist |
( |
const std::string & |
name | ) |
const |
|
inherited |
get the histogram with the given name
- Guarantee
- strong
- Failures
- histogram not found
◆ histFinalize()
| virtual StatusCode EL::UnitTestAlg1::histFinalize |
( |
| ) |
|
|
overrideprivatevirtual |
effects: this is a post-initialization routine that is called after finalize has been called.
guarantee: basic failures: algorithm dependent rationale: unlike finalize(), this method is called all the time, even on empty input files.
Reimplemented from EL::Algorithm.
◆ histInitialize()
| virtual StatusCode EL::UnitTestAlg1::histInitialize |
( |
| ) |
|
|
overrideprivatevirtual |
effects: this is a pre-initialization routine that is called before changeInput is called.
guarantee: basic failures: algorithm dependent rationale: unlike initialize(), this method is called all the time, even on empty input files. so you should create any histograms or n-tuples here that subsequent code expects
Reimplemented from EL::Algorithm.
◆ initialize()
| virtual StatusCode EL::UnitTestAlg1::initialize |
( |
| ) |
|
|
overrideprivatevirtual |
effects: do everything that needs to be done before running the algorithm, e.g.
create output n-tuples and histograms. this method is called only once right after changeInput(true) is called guarantee: basic failures: algorithm dependent rationale: in principle all this work could be done on changeInput(true). However, providing this method should make it easier for the user to set up all his outputs and to do so only once.
Reimplemented from EL::Algorithm.
◆ msg() [1/2]
| MsgStream& EL::Algorithm::msg |
( |
| ) |
const |
|
inherited |
messaging interface
this is the interface to work with the standard messaging macros from AsgTools. Instead of enums I pass ints, so that I can avoid the include dependency (forward declarations are only allowed for enum classes AFAIK).
the standard message stream for this object
- Guarantee
- strong
- Failures
- code not compiled with AsgTools support
◆ msg() [2/2]
| MsgStream& EL::Algorithm::msg |
( |
int |
level | ) |
const |
|
inherited |
the message stream for this object, configured for the given level
- Guarantee
- strong
- Failures
- code not compiled with AsgTools support
◆ msgLvl()
| bool EL::Algorithm::msgLvl |
( |
int |
lvl | ) |
const |
|
inherited |
whether we are configured to print messages at the given level
- Guarantee
- no-fail
◆ name()
| virtual const std::string& EL::Algorithm::name |
( |
| ) |
const |
|
virtualinherited |
◆ postExecute()
effects: do the post-processing for the event guarantee: basic failures: algorithm dependent rationale: this is mainly used for specialized services that need to get input from subsequent algorithms before filling their event data
Reimplemented in EL::NTupleSvc.
◆ setMsgLevel()
| void EL::Algorithm::setMsgLevel |
( |
int |
level | ) |
|
|
inherited |
set the message level for the message stream for this object
- Guarantee
- no-fail
◆ setupJob()
effects: give the algorithm a chance to intialize the job with anything this algorithm needs.
this method is automatically called before the algorithm is actually added to the job. guarantee: basic failures: algorithm dependent rationale: this is currently used to give algorithms a chance to register their output datasets, but can also be used for other stuff.
Reimplemented from EL::Algorithm.
◆ sysSetupJob()
| void EL::Algorithm::sysSetupJob |
( |
Job & |
job | ) |
|
|
privateinherited |
effects: give the algorithm a chance to intialize the job with anything this algorithm needs.
this method is automatically called before the algorithm is actually added to the job. guarantee: basic failures: algorithm dependent rationale: this is currently used to give algorithms a chance to register their output datasets, but can also be used for other stuff.
◆ testInvariant()
| void EL::UnitTestAlg1::testInvariant |
( |
| ) |
const |
effects: test the invariant of this object guarantee: no-fail
◆ wk()
| IWorker* EL::Algorithm::wk |
( |
| ) |
const |
|
inherited |
description: the worker that is controlling us guarantee: no-fail
◆ m_branch
| TBranch* EL::UnitTestAlg1::m_branch |
|
private |
◆ m_callbacks
| TH1* EL::UnitTestAlg1::m_callbacks = nullptr |
|
private |
◆ m_calls
| unsigned EL::UnitTestAlg1::m_calls = 0 |
|
private |
◆ m_evtStore
◆ m_evtStorePtr
◆ m_fileName
| std::string EL::UnitTestAlg1::m_fileName |
|
private |
the name of the file (for testing changeInput)
Definition at line 182 of file UnitTestAlg1.h.
◆ m_hasHistInitialize
| bool EL::UnitTestAlg1::m_hasHistInitialize |
|
private |
whether histInitialize has been called
Definition at line 190 of file UnitTestAlg1.h.
◆ m_hasInitialize
| bool EL::UnitTestAlg1::m_hasInitialize |
|
private |
◆ m_msg
| MsgStream* EL::Algorithm::m_msg = nullptr |
|
mutableprivateinherited |
the message stream, if it has been instantiated
Definition at line 333 of file Algorithm.h.
◆ m_msgLevel
| int EL::Algorithm::m_msgLevel = 3 |
|
privateinherited |
the message level configured
Definition at line 342 of file Algorithm.h.
◆ m_msgName
| std::string EL::Algorithm::m_msgName |
|
mutableprivateinherited |
the algorithm name for which the message stream has been instantiated
Definition at line 338 of file Algorithm.h.
◆ m_name
| std::string EL::UnitTestAlg1::m_name |
|
private |
description: the name of the variable we are using
Definition at line 162 of file UnitTestAlg1.h.
◆ m_nameCache
| std::string EL::Algorithm::m_nameCache |
|
mutableprivateinherited |
◆ m_tree
| TTree* EL::UnitTestAlg1::m_tree |
|
private |
description: the histogram we are creating
description: the tree we are creating
Definition at line 178 of file UnitTestAlg1.h.
◆ m_value
| Int_t EL::UnitTestAlg1::m_value |
|
private |
description: the value we are reading from the branch
Definition at line 170 of file UnitTestAlg1.h.
◆ m_wk
◆ makeOutput
| bool EL::UnitTestAlg1::makeOutput |
description: whether I create an output n-tuple
Definition at line 55 of file UnitTestAlg1.h.
The documentation for this class was generated from the following file:
1.8.18