a Module recording when FileExecuted was called More...

#include <FileExecutedModule.h>

Inheritance diagram for EL::Detail::FileExecutedModule:

Collaboration diagram for EL::Detail::FileExecutedModule:

Public Member Functions
virtual	~FileExecutedModule () noexcept

virtual StatusCode	onInitialize (ModuleData &data) override
	action just before algorithms are initialized More...

virtual StatusCode	onFileExecute (ModuleData &data) override
	actions just before `fileExecute` is called on algorithms More...

virtual StatusCode	postFinalize (ModuleData &data) override
	actions after algorithms have been finalized More...

virtual StatusCode	firstInitialize (ModuleData &data)
	action at the the very beginning of the worker job More...

virtual StatusCode	preFileInitialize (ModuleData &data)
	action before opening the first file in the worker job More...

virtual StatusCode	processInputs (ModuleData &data, IInputModuleActions &actions)
	process all input files More...

virtual StatusCode	postFirstEvent (ModuleData &data)
	action after processing first event More...

virtual StatusCode	onNewInputFile (ModuleData &data)
	actions after opening a new input file More...

virtual StatusCode	onCloseInputFile (ModuleData &data)
	actions before closing an input file More...

virtual StatusCode	postCloseInputFile (ModuleData &data)
	actions after `CloseInputFile` is called on the algorithms More...

virtual StatusCode	onExecute (ModuleData &data)
	actions just before `execute` is called on algorithms More...

virtual StatusCode	onFinalize (ModuleData &data)
	actions just before algorithms are finalized More...

virtual StatusCode	onWorkerEnd (ModuleData &data)
	action at the end of the worker job More...

virtual StatusCode	postFileClose (ModuleData &data)
	action at end of the worker job More...

virtual void	reportInputFailure (ModuleData &data)
	report that we failed to open our input file More...

Private Attributes
std::unique_ptr< TTree >	m_fileExecutedTree
	the tree containing the list of files for which fileExecute has been called More...

TString *	m_fileExecutedName {nullptr}
	the name of the file being executed, to be stored inside m_fileExecutedTree More...

Detailed Description

a Module recording when FileExecuted was called

Definition at line 26 of file FileExecutedModule.h.

Constructor & Destructor Documentation

◆ ~FileExecutedModule()

EL::Detail::FileExecutedModule::~FileExecutedModule ( )

virtualnoexcept

Definition at line 27 of file FileExecutedModule.cxx.

     {
       m_fileExecutedTree.release ();
       delete m_fileExecutedName;
     }

Member Function Documentation

◆ firstInitialize()

StatusCode EL::Detail::Module::firstInitialize ( ModuleData & data )

virtualinherited

action at the the very beginning of the worker job

This gets called as early as possible in the worker initialization. Essentially all that should happen before this is to load all the modules. The main purpose is to start any benchmarks that are meant to capture the initialization process as well.

Reimplemented in EL::Detail::MemoryMonitorModule, EL::Detail::AlgorithmMemoryModule, EL::Detail::AlgorithmTimerModule, and EL::Detail::StopwatchModule.

Definition at line 25 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ onCloseInputFile()

StatusCode EL::Detail::Module::onCloseInputFile ( ModuleData & data )

virtualinherited

actions before closing an input file

Reimplemented in EL::Detail::AlgorithmStateModule, and EL::Detail::TreeCacheModule.

Definition at line 43 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ onExecute()

StatusCode EL::Detail::Module::onExecute ( ModuleData & data )

virtualinherited

actions just before execute is called on algorithms

For now that is mostly used to point input modules to the right event

Reimplemented in EL::Detail::TEventModule, EL::Detail::AlgorithmStateModule, EL::Detail::MemoryMonitorModule, and EL::Detail::GridReportingModule.

Definition at line 71 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ onFileExecute()

StatusCode EL::Detail::FileExecutedModule::onFileExecute ( ModuleData & data )

overridevirtual

actions just before fileExecute is called on algorithms

Reimplemented from EL::Detail::Module.

Definition at line 49 of file FileExecutedModule.cxx.

     {
       auto split = data.m_inputFileUrl.rfind ('/');
       if (split != std::string::npos)
         *m_fileExecutedName = data.m_inputFileUrl.substr (split + 1);
       else
         *m_fileExecutedName = data.m_inputFileUrl;
       m_fileExecutedTree->Fill ();
       return StatusCode::SUCCESS;
     }

◆ onFinalize()

StatusCode EL::Detail::Module::onFinalize ( ModuleData & data )

virtualinherited

actions just before algorithms are finalized

Reimplemented in EL::Detail::AlgorithmStateModule, and EL::Detail::MemoryMonitorModule.

Definition at line 89 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ onInitialize()

StatusCode EL::Detail::FileExecutedModule::onInitialize ( ModuleData & data )

overridevirtual

action just before algorithms are initialized

This is typically used for any setup that this module needs to do.

Reimplemented from EL::Detail::Module.

Definition at line 36 of file FileExecutedModule.cxx.

     {
       m_fileExecutedTree = std::make_unique<TTree>
         ("EventLoop_FileExecuted", "executed files");
       m_fileExecutedTree->SetDirectory (nullptr);
       m_fileExecutedName = new TString;
       m_fileExecutedTree->Branch ("file", &m_fileExecutedName);
       return StatusCode::SUCCESS;
     }

◆ onNewInputFile()

StatusCode EL::Detail::Module::onNewInputFile ( ModuleData & data )

virtualinherited

actions after opening a new input file

Reimplemented in EL::Detail::TEventModule, EL::Detail::AlgorithmStateModule, EL::Detail::GridReportingModule, and EL::Detail::TreeCacheModule.

Definition at line 37 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ onWorkerEnd()

StatusCode EL::Detail::Module::onWorkerEnd ( ModuleData & data )

virtualinherited

action at the end of the worker job

This is mostly meant/used to print job summary statements at the very end of worker job, and actually have them show up at or at least near the end of any log file.

Reimplemented in EL::Detail::MemoryMonitorModule, EL::Detail::StopwatchModule, and EL::Detail::LeakCheckModule.

Definition at line 101 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ postCloseInputFile()

StatusCode EL::Detail::Module::postCloseInputFile ( ModuleData & data )

virtualinherited

actions after CloseInputFile is called on the algorithms

Right now that is only used to disconnect the TEvent object from the input file.

Reimplemented in EL::Detail::TEventModule.

Definition at line 49 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ postFileClose()

StatusCode EL::Detail::Module::postFileClose ( ModuleData & data )

virtualinherited

action at end of the worker job

Executed just right before worker exit successfully at this stage all outputs have been created

Reimplemented in EL::Detail::GridReportingModule, and EL::Detail::PostClosedOutputsModule.

Definition at line 107 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ postFinalize()

StatusCode EL::Detail::FileExecutedModule::postFinalize ( ModuleData & data )

overridevirtual

actions after algorithms have been finalized

This is usually used to calculate some job summary information that is to be stored it in the histogram output file.

Reimplemented from EL::Detail::Module.

Definition at line 63 of file FileExecutedModule.cxx.

     {
       data.addOutput (std::move (m_fileExecutedTree));
       return StatusCode::SUCCESS;
     }

◆ postFirstEvent()

StatusCode EL::Detail::Module::postFirstEvent ( ModuleData & data )

virtualinherited

action after processing first event

This is mostly meant to set up benchmarks that record per-event performance. While a lot of initialization happens during initialize() there is a fair amount of initialization that happens on the first event, so when recording per-event performance the first event is sort of "special" and may need to be omitted.

Reimplemented in EL::Detail::MemoryMonitorModule, and EL::Detail::LeakCheckModule.

Definition at line 55 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ preFileInitialize()

StatusCode EL::Detail::Module::preFileInitialize ( ModuleData & data )

virtualinherited

action before opening the first file in the worker job

This is mostly meant to allow loading the dictionaries before any files and associated information is loaded.

Definition at line 31 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ processInputs()

StatusCode EL::Detail::Module::processInputs	(	ModuleData &	data,
		IInputModuleActions &	actions
	)

virtualinherited

process all input files

This deviates slightly from the usual pattern for module functions in that I pass in the possible actions as an argument. See IInputModuleActions for details.

Reimplemented in EL::Detail::BatchInputModule, and EL::Detail::DirectInputModule.

Definition at line 83 of file Module.cxx.

     {
       return ::StatusCode::SUCCESS;
     }

◆ reportInputFailure()

void EL::Detail::Module::reportInputFailure ( ModuleData & data )

virtualinherited

report that we failed to open our input file

Reimplemented in EL::Detail::GridReportingModule.

Definition at line 61 of file Module.cxx.

63 {}

Member Data Documentation

◆ m_fileExecutedName

TString* EL::Detail::FileExecutedModule::m_fileExecutedName {nullptr}

private

the name of the file being executed, to be stored inside m_fileExecutedTree

Definition at line 56 of file FileExecutedModule.h.

◆ m_fileExecutedTree

std::unique_ptr<TTree> EL::Detail::FileExecutedModule::m_fileExecutedTree

private

the tree containing the list of files for which fileExecute has been called

Definition at line 51 of file FileExecutedModule.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~FileExecutedModule()

Member Function Documentation

◆ firstInitialize()

◆ onCloseInputFile()

◆ onExecute()

◆ onFileExecute()

◆ onFinalize()

◆ onInitialize()

◆ onNewInputFile()

◆ onWorkerEnd()

◆ postCloseInputFile()

◆ postFileClose()

◆ postFinalize()

◆ postFirstEvent()

◆ preFileInitialize()

◆ processInputs()

◆ reportInputFailure()

Member Data Documentation

◆ m_fileExecutedName

◆ m_fileExecutedTree