#include <UnitTestAlgXAOD.h>

Inheritance diagram for EL::UnitTestAlgXAOD:

Collaboration diagram for EL::UnitTestAlgXAOD:

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

	UnitTestAlgXAOD ()
	effects: standard constructor guarantee: strong failures: low level errors II More...

virtual	~UnitTestAlgXAOD ()
	effects: non-standard destructor guarantee: basic failures: not fully finalized 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 Types
enum	State { State::START, State::HIST_INITIALIZED, State::INPUT_CHANGED, State::INITIALIZED, State::FINALIZED, State::HIST_FINALIZED }
	the state we ought to be in More...

Private Member Functions
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...

StatusCode	testWorkerState (bool validEvent, std::set< State > validStates) const
	check if the state of inputs on the worker is valid right now More...

	ClassDef (UnitTestAlgXAOD, 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...

Private Attributes
State	m_state {State::START}

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

Detailed Description

Definition at line 22 of file UnitTestAlgXAOD.h.

Member Enumeration Documentation

◆ State

enum EL::UnitTestAlgXAOD::State

strongprivate

the state we ought to be in

Enumerator
START
HIST_INITIALIZED
INPUT_CHANGED
INITIALIZED
FINALIZED
HIST_FINALIZED

Definition at line 137 of file UnitTestAlgXAOD.h.

     {
       START,
       HIST_INITIALIZED,
       INPUT_CHANGED,
       INITIALIZED,
       FINALIZED,
       HIST_FINALIZED
     };

Constructor & Destructor Documentation

◆ UnitTestAlgXAOD()

EL::UnitTestAlgXAOD::UnitTestAlgXAOD ( )

effects: standard constructor guarantee: strong failures: low level errors II

◆ ~UnitTestAlgXAOD()

virtual EL::UnitTestAlgXAOD::~UnitTestAlgXAOD ( )

virtual

effects: non-standard destructor guarantee: basic failures: not fully finalized

Member Function Documentation

◆ book()

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

inherited

book the given histogram

Guarantee: strong

Failures: histogram booking error

◆ changeInput()

virtual StatusCode EL::UnitTestAlgXAOD::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()

EL::UnitTestAlgXAOD::ClassDef	(	UnitTestAlgXAOD	,
		1
	)

private

◆ endOfFile()

virtual StatusCode EL::Algorithm::endOfFile ( )

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.

◆ evtStore()

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

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.

Guarantee: strong

Failures: out of memory I
job not configured for xAODs

◆ execute()

virtual StatusCode EL::UnitTestAlgXAOD::execute ( )

overrideprivatevirtual

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

virtual StatusCode EL::UnitTestAlgXAOD::finalize ( )

overrideprivatevirtual

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.

◆ 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::UnitTestAlgXAOD::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::UnitTestAlgXAOD::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::UnitTestAlgXAOD::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()

virtual StatusCode EL::Algorithm::postExecute ( )

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.

◆ setMsgLevel()

void EL::Algorithm::setMsgLevel ( int level )

inherited

set the message level for the message stream for this object

Guarantee: no-fail

◆ setupJob()

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

overrideprivatevirtual

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

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

◆ testWorkerState()

StatusCode EL::UnitTestAlgXAOD::testWorkerState	(	bool	validEvent,
		std::set< State >	validStates
	)		const

private

check if the state of inputs on the worker is valid right now

◆ wk()

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

inherited

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

Member Data Documentation

◆ m_evtStore

asg::SgTEvent EL::Algorithm::m_evtStore

mutableprivateinherited

when configured, the object returned by evtStore

Definition at line 329 of file Algorithm.h.

◆ m_evtStorePtr

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

mutableprivateinherited

the value of evtStore

Definition at line 325 of file Algorithm.h.

◆ 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_nameCache

std::string EL::Algorithm::m_nameCache

mutableprivateinherited

the cache for name

Definition at line 346 of file Algorithm.h.

◆ m_state

State EL::UnitTestAlgXAOD::m_state {State::START}

private

Definition at line 147 of file UnitTestAlgXAOD.h.

◆ m_wk

IWorker* EL::Algorithm::m_wk

privateinherited

Definition at line 321 of file Algorithm.h.

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

UnitTestAlgXAOD.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ UnitTestAlgXAOD()

◆ ~UnitTestAlgXAOD()

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

◆ testWorkerState()

◆ wk()

Member Data Documentation

◆ m_evtStore

◆ m_evtStorePtr

◆ m_msg

◆ m_msgLevel

◆ m_msgName

◆ m_nameCache

◆ m_state

◆ m_wk