![]() |
ATLAS Offline Software
|
#include <FormulaSvc.h>
Public Member Functions | |
void | testInvariant () const |
effects: test the invariant of this object guarantee: no-fail More... | |
FormulaSvc () | |
effects: standard default constructor guarantee: no-fail More... | |
~FormulaSvc () | |
effects: standard destructor guarantee: no-fail More... | |
const Formula * | addForm (const std::string &formula) |
effects: add another formula returns: the formula guarantee: strong failures: out of memory II failures: not in initialization stage requires: !formula.empty() More... | |
IWorker * | wk () const |
description: the worker that is controlling us guarantee: no-fail More... | |
void | book (const TH1 &hist) |
book the given histogram More... | |
TH1 * | hist (const std::string &name) const |
get the histogram with the given name More... | |
asg::SgTEvent * | evtStore () const |
get the (main) event store for this algorithm More... | |
virtual const std::string & | name () const |
Static Public Attributes | |
static const std::string | name |
description: the name of the service More... | |
Private Member Functions | |
virtual const char * | GetName () const |
effects: return the name of this algorithm guarantee: no-fail More... | |
virtual EL::StatusCode | changeInput (bool firstFile) |
effects: do all changes to work with a new input file, e.g. More... | |
virtual EL::StatusCode | execute () |
effects: process the next event guarantee: basic failures: algorithm dependent rationale: the virtual part of Algorithm::process More... | |
ClassDef (FormulaSvc, 1) | |
virtual StatusCode | setupJob (Job &job) |
effects: give the algorithm a chance to intialize the job with anything this algorithm needs. More... | |
virtual StatusCode | fileExecute () |
effects: do all the processing that needs to be done once per file More... | |
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 | initialize () |
effects: do everything that needs to be done before running the algorithm, e.g. More... | |
virtual StatusCode | histInitialize () |
effects: this is a pre-initialization routine that is called before changeInput is called. 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 StatusCode | 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 More... | |
virtual StatusCode | histFinalize () |
effects: this is a post-initialization routine that is called after finalize has been called. 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... | |
Private Attributes | |
TTree * | m_tree |
description: the tree we are connected to More... | |
std::vector< Formula * > | m_vars |
description: the list of variables used More... | |
IWorker * | m_wk |
asg::SgTEvent * | m_evtStorePtr = nullptr |
the value of evtStore More... | |
asg::SgTEvent | m_evtStore |
when configured, the object returned by evtStore More... | |
MsgStream * | m_msg = nullptr |
the message stream, if it has been instantiated More... | |
std::string | m_msgName |
the algorithm name for which the message stream has been instantiated More... | |
int | m_msgLevel = 3 |
the message level configured More... | |
std::string | m_nameCache |
the cache for name More... | |
Definition at line 53 of file FormulaSvc.h.
MD::FormulaSvc::FormulaSvc | ( | ) |
effects: standard default constructor guarantee: no-fail
MD::FormulaSvc::~FormulaSvc | ( | ) |
effects: standard destructor guarantee: no-fail
effects: add another formula returns: the formula guarantee: strong failures: out of memory II failures: not in initialization stage requires: !formula.empty()
book the given histogram
|
privatevirtual |
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.
|
private |
|
privatevirtualinherited |
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.
|
inherited |
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.
|
privatevirtual |
effects: process the next event guarantee: basic failures: algorithm dependent rationale: the virtual part of Algorithm::process
Reimplemented from EL::Algorithm.
|
privatevirtualinherited |
effects: do all the processing that needs to be done once per file
Warning: The user should not expect this to be called at any particular point in execution. If a file is split between multiple jobs this will be called in only one of these jobs, and not the others. It usually gets called before the first event in a file, but that is not guaranteed and relying on this is a bug. Take a look at changeInput if you want something that is guaranteed to be executed at the beginning of each input file.
Warning: The execution order of changeInput and fileExecute is currently unspecified.
guarantee: basic failures: algorithm dependent rationale: this is to read per-file accounting data, e.g. the list of lumi-blocks processed
Reimplemented in EL::UnitTestAlg1, EL::UnitTestAlg, EL::UnitTestAlgXAOD, and EL::MetricsSvc.
|
privatevirtualinherited |
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
Reimplemented in EL::UnitTestAlg1, EL::UnitTestAlg, and EL::UnitTestAlgXAOD.
|
privatevirtual |
effects: return the name of this algorithm guarantee: no-fail
|
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.
get the histogram with the given name
|
privatevirtualinherited |
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 in EL::UnitTestAlg1, EL::UnitTestAlg, EL::UnitTestAlgXAOD, and EL::MetricsSvc.
|
privatevirtualinherited |
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 in EL::UnitTestAlg1, EL::UnitTestAlg, EL::UnitTestAlgXAOD, EL::MetricsSvc, and EL::VomsProxySvc.
|
privatevirtualinherited |
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 in EL::DuplicateChecker, EL::UnitTestAlg1, EL::UnitTestAlg, EL::UnitTestAlgXAOD, EL::NTupleSvc, EL::AlgSelect, MD::AlgHist, MD::AlgCFlow, and EL::UnitTestSkim.
|
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
|
inherited |
the message stream for this object, configured for the given level
|
inherited |
whether we are configured to print messages at the given level
|
virtualinherited |
|
privatevirtualinherited |
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.
|
inherited |
set the message level for the message stream for this object
|
privatevirtualinherited |
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 in EL::DuplicateChecker, EL::UnitTestAlg1, EL::UnitTestAlg, EL::UnitTestAlgXAOD, EL::VomsProxySvc, EL::NTupleSvc, EL::AlgSelect, MD::AlgHist, and MD::AlgCFlow.
|
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.
void MD::FormulaSvc::testInvariant | ( | ) | const |
effects: test the invariant of this object guarantee: no-fail
|
inherited |
description: the worker that is controlling us guarantee: no-fail
|
mutableprivateinherited |
when configured, the object returned by evtStore
Definition at line 329 of file Algorithm.h.
|
mutableprivateinherited |
the value of evtStore
Definition at line 325 of file Algorithm.h.
|
mutableprivateinherited |
the message stream, if it has been instantiated
Definition at line 333 of file Algorithm.h.
|
privateinherited |
the message level configured
Definition at line 342 of file Algorithm.h.
|
mutableprivateinherited |
the algorithm name for which the message stream has been instantiated
Definition at line 338 of file Algorithm.h.
|
mutableprivateinherited |
the cache for name
Definition at line 346 of file Algorithm.h.
|
private |
description: the tree we are connected to
Definition at line 127 of file FormulaSvc.h.
|
private |
description: the list of variables used
Definition at line 131 of file FormulaSvc.h.
|
privateinherited |
Definition at line 321 of file Algorithm.h.
|
static |
description: the name of the service
Definition at line 61 of file FormulaSvc.h.