#include <Algorithm.h>

Inherits TNamed, and INamedInterface.

Inherited by EL::AlgSelect, EL::DuplicateChecker, EL::MetricsSvc, EL::NTupleSvc, EL::UnitTestAlg, EL::UnitTestAlg1, EL::UnitTestAlgXAOD, EL::UnitTestSkim, EL::VomsProxySvc, EL::WhiteBoardSvc, MD::AlgCFlow, MD::AlgHist, and MD::FormulaSvc.

Collaboration diagram for EL::Algorithm:

Public Member Functions
void	testInvariant () const
	effects: test the invariant of this object guarantee: no-fail More...

	Algorithm ()
	effects: standard default constructor guarantee: strong failures: low level errors I More...

	~Algorithm ()
	effects: standard destructor guarantee: no-fail 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

Private Member Functions
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	changeInput (bool firstFile)
	effects: do all changes to work with a new input file, e.g. 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	execute ()
	effects: process the next event guarantee: basic failures: algorithm dependent 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...

	ClassDef (Algorithm, 1)

Private Attributes
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...

Friends
class	AlgorithmWrapper
	rationale: the worker is essentially controlling the algorithm. More...

class	Job

Detailed Description

Definition at line 21 of file Algorithm.h.

Constructor & Destructor Documentation

◆ Algorithm()

EL::Algorithm::Algorithm ( )

effects: standard default constructor guarantee: strong failures: low level errors I

◆ ~Algorithm()

EL::Algorithm::~Algorithm ( )

effects: standard destructor guarantee: no-fail

Member Function Documentation

◆ book()

void EL::Algorithm::book ( const TH1 & hist )

book the given histogram

Guarantee: strong

Failures: histogram booking error

◆ changeInput()

virtual StatusCode EL::Algorithm::changeInput ( bool firstFile )

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

Warning: If a file is split across multiple jobs this will be called more than once. This only happens for specific batch drivers and/or if it is explicitly configured by the user. With PROOF it could even happen multiple times within the same job, and while PROOF is no longer supported that behavior may come back if support for a similar framework is added in the future. As such, this method should not be used for accounting that relies to be called exactly once per file, take a look at fileExecute() if you want something that is guaranteed to be executed exactly once per input file.

Warning: The execution order of changeInput and fileExecute is currently unspecified.

guarantee: basic failures: algorithm dependent

Reimplemented in EL::DuplicateChecker, EL::UnitTestAlg1, EL::UnitTestAlg, EL::UnitTestAlgXAOD, EL::NTupleSvc, MD::FormulaSvc, and EL::UnitTestSkim.

◆ ClassDef()

EL::Algorithm::ClassDef	(	Algorithm	,
		1
	)

private

◆ endOfFile()

virtual StatusCode EL::Algorithm::endOfFile ( )

privatevirtual

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()

asg::SgTEvent* EL::Algorithm::evtStore ( ) const

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()

virtual StatusCode EL::Algorithm::execute ( )

privatevirtual

effects: process the next event guarantee: basic failures: algorithm dependent

Reimplemented in EL::DuplicateChecker, EL::UnitTestAlg1, EL::UnitTestAlg, EL::UnitTestAlgXAOD, EL::MetricsSvc, EL::NTupleSvc, EL::AlgSelect, MD::FormulaSvc, MD::AlgHist, MD::AlgCFlow, and EL::UnitTestSkim.

◆ fileExecute()

virtual StatusCode EL::Algorithm::fileExecute ( )

privatevirtual

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.

◆ finalize()

virtual StatusCode EL::Algorithm::finalize ( )

privatevirtual

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.

◆ hasName()

virtual bool EL::Algorithm::hasName ( const std::string & name ) const

privatevirtual

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

get the histogram with the given name

Guarantee: strong

Failures: histogram not found

◆ histFinalize()

virtual StatusCode EL::Algorithm::histFinalize ( )

privatevirtual

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.

◆ histInitialize()

virtual StatusCode EL::Algorithm::histInitialize ( )

privatevirtual

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.

◆ initialize()

virtual StatusCode EL::Algorithm::initialize ( )

privatevirtual

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.

◆ msg() [1/2]

MsgStream& EL::Algorithm::msg ( ) const

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

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

whether we are configured to print messages at the given level

Guarantee: no-fail

◆ name()

virtual const std::string& EL::Algorithm::name ( ) const

virtual

◆ postExecute()

virtual StatusCode EL::Algorithm::postExecute ( )

privatevirtual

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 )

set the message level for the message stream for this object

Guarantee: no-fail

◆ setupJob()

virtual StatusCode EL::Algorithm::setupJob ( Job & job )

privatevirtual

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.

◆ sysSetupJob()

void EL::Algorithm::sysSetupJob ( Job & job )

private

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::Algorithm::testInvariant ( ) const

effects: test the invariant of this object guarantee: no-fail

◆ wk()

IWorker* EL::Algorithm::wk ( ) const

description: the worker that is controlling us guarantee: no-fail

Friends And Related Function Documentation

◆ AlgorithmWrapper

AlgorithmWrapper

friend

rationale: the worker is essentially controlling the algorithm.

this allows it to do it without having to duplicate most of the interface.

Definition at line 291 of file Algorithm.h.

◆ Job

friend class Job

friend

Definition at line 292 of file Algorithm.h.

Member Data Documentation

◆ m_evtStore

asg::SgTEvent EL::Algorithm::m_evtStore

mutableprivate

when configured, the object returned by evtStore

Definition at line 329 of file Algorithm.h.

◆ m_evtStorePtr

asg::SgTEvent* EL::Algorithm::m_evtStorePtr = nullptr

mutableprivate

the value of evtStore

Definition at line 325 of file Algorithm.h.

◆ m_msg

MsgStream* EL::Algorithm::m_msg = nullptr

mutableprivate

the message stream, if it has been instantiated

Definition at line 333 of file Algorithm.h.

◆ m_msgLevel

int EL::Algorithm::m_msgLevel = 3

private

the message level configured

Definition at line 342 of file Algorithm.h.

◆ m_msgName

std::string EL::Algorithm::m_msgName

mutableprivate

the algorithm name for which the message stream has been instantiated

Definition at line 338 of file Algorithm.h.

◆ m_nameCache

std::string EL::Algorithm::m_nameCache

mutableprivate

the cache for name

Definition at line 346 of file Algorithm.h.

◆ m_wk

IWorker* EL::Algorithm::m_wk

private

Definition at line 321 of file Algorithm.h.

The documentation for this class was generated from the following file:

Algorithm.h

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Algorithm()

◆ ~Algorithm()

Member Function Documentation

◆ book()

◆ changeInput()

◆ ClassDef()

◆ endOfFile()

◆ evtStore()

◆ execute()

◆ fileExecute()

◆ finalize()

◆ hasName()

◆ hist()

◆ histFinalize()

◆ histInitialize()

◆ initialize()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ name()

◆ postExecute()

◆ setMsgLevel()

◆ setupJob()

◆ sysSetupJob()

◆ testInvariant()

◆ wk()

Friends And Related Function Documentation

◆ AlgorithmWrapper

◆ Job

Member Data Documentation

◆ m_evtStore

◆ m_evtStorePtr

◆ m_msg

◆ m_msgLevel

◆ m_msgName

◆ m_nameCache

◆ m_wk