#include <EventModule.h>

Inheritance diagram for EL::Detail::EventModule:

Collaboration diagram for EL::Detail::EventModule:

Public Member Functions
	EventModule (const std::string &name)
	effects: standard constructor.
	~EventModule ()
	effects: standard destructor.
virtual StatusCode	postFinalize (ModuleData &data) override
	actions after algorithms have been finalized
virtual StatusCode	onFirstInputFile (ModuleData &data) override
	actions after opening a the first input file
virtual StatusCode	onNextInputFile (ModuleData &data) override
	actions after opening an input file after the first one
virtual StatusCode	onNewInputFile (ModuleData &data) override
	actions after opening a new input file
virtual StatusCode	postCloseInputFile (ModuleData &data) override
	actions after CloseInputFile is called on the algorithms
virtual StatusCode	onExecute (ModuleData &data) override
	actions just before execute is called on algorithms
virtual StatusCode	firstInitialize (ModuleData &data)
	action at the the very beginning of the worker job
virtual StatusCode	preFileInitialize (ModuleData &data)
	action before opening the first file in the worker job
virtual StatusCode	onInitialize (ModuleData &data)
	action just before algorithms are initialized
virtual StatusCode	processInputs (ModuleData &data, IInputModuleActions &actions)
	process all input files
virtual StatusCode	postFirstEvent (ModuleData &data)
	action after processing first event
virtual StatusCode	onCloseInputFile (ModuleData &data)
	actions before closing an input file
virtual StatusCode	onFileExecute (ModuleData &data)
	actions just before fileExecute is called on algorithms
virtual StatusCode	onFinalize (ModuleData &data)
	actions just before algorithms are finalized
virtual StatusCode	onWorkerEnd (ModuleData &data)
	action at the end of the worker job
virtual StatusCode	postFileClose (ModuleData &data)
	action at end of the worker job
virtual void	reportInputFailure (ModuleData &data)
	report that we failed to open our input file

Private Attributes
std::unique_ptr< xAOD::Event >	m_event
	description: the event structure used
std::unique_ptr< xAOD::TStore >	m_store
std::unique_ptr< asg::SgEvent >	m_evtStore
Gaudi::Property< bool >	m_useStats {this, "useStats", false}
	description: whether we collect D3PDPerfStats statistics
Gaudi::Property< bool >	m_summaryReport {this, "summaryReport", true}

Detailed Description

Definition at line 31 of file EventModule.h.

Constructor & Destructor Documentation

◆ EventModule()

EL::Detail::EventModule::EventModule ( const std::string & name )

effects: standard constructor.

guarantee: no-fail

Definition at line 40 of file EventModule.cxx.

41 : Module (name)

42 {}

◆ ~EventModule()

EL::Detail::EventModule::~EventModule ( )

effects: standard destructor.

guarantee: no-fail

Definition at line 44 of file EventModule.cxx.

45 {}

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::AlgorithmMemoryModule, EL::Detail::AlgorithmTimerModule, EL::Detail::MemoryMonitorModule, 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 55 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

◆ onExecute()

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

overridevirtual

actions just before execute is called on algorithms

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

Reimplemented from EL::Detail::Module.

Definition at line 131 of file EventModule.cxx.

                                                       {
      // move to next event
      m_store->clear ();
      if (m_event->getEntry (data.m_inputEntry) < 0)
        RCU_THROW_MSG ("failed to read from xAOD");
      return StatusCode::SUCCESS;
    }

◆ onFileExecute()

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

virtualinherited

actions just before fileExecute is called on algorithms

Reimplemented in EL::Detail::AlgorithmStateModule, EL::Detail::FileExecutedModule, and EL::Detail::StopwatchModule.

Definition at line 77 of file Module.cxx.

    {
      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 101 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

◆ onFirstInputFile()

StatusCode EL::Detail::EventModule::onFirstInputFile ( ModuleData & data )

overridevirtual

actions after opening a the first input file

Reimplemented from EL::Detail::Module.

Definition at line 48 of file EventModule.cxx.

                                                              {
 
      if (m_event != nullptr || m_store != nullptr) {
        ANA_MSG_ERROR ("module initialized twice");
        return StatusCode::FAILURE;
      }
      if (data.m_event != nullptr || data.m_tstore != nullptr) {
        ANA_MSG_ERROR ("duplicate EventModule??");
        return StatusCode::FAILURE;
      }
 
      // Perform a sanity check.
      if (!data.m_inputFile) {
        ANA_MSG_ERROR ("File is not available during initialization?!?");
        return StatusCode::FAILURE;
      }
 
      // Set up the reading from the first input file. This is the generic
      // interface for both TTree and RNTuple reading.  But note that no event is loaded with getEntry(...)
      // yet, as we don't want to allow users to access the first event
      // during initialisation. Only the in-file metadata...
      m_event = xAOD::Event::createAndReadFrom(*data.m_inputFile.get());
      if (!m_event) {
          ATH_MSG_ERROR( "cannot read from file: " << *data.m_inputFile->GetName());
          return StatusCode::FAILURE;
      }
      // Set event in module data
      data.m_event = m_event.get();
      ATH_MSG_DEBUG( "EventModule::onFirstInputFile: opened " << data.m_inputFile->GetName());
      if (!m_summaryReport.value())
        xAOD::TFileAccessTracer::instance().enableDataSubmission (false);
 
      m_store.reset (new xAOD::TStore);
 
      m_evtStore = std::make_unique<asg::SgEvent> (m_event.get(), m_store.get());
 
      if (m_useStats.value())
        xAOD::PerfStats::instance().start();
 
      data.m_tstore   = m_store.get();
      data.m_evtStore = m_evtStore.get();
      return StatusCode::SUCCESS;
    }

◆ onInitialize()

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

virtualinherited

action just before algorithms are initialized

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

Reimplemented in EL::Detail::AlgorithmStateModule, EL::Detail::FactoryPreloadModule, EL::Detail::FileExecutedModule, EL::Detail::MemoryMonitorModule, and EL::Detail::WorkerConfigModule.

Definition at line 89 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

◆ onNewInputFile()

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

overridevirtual

actions after opening a new input file

Reimplemented from EL::Detail::Module.

Definition at line 104 of file EventModule.cxx.

    {
      if (m_event == nullptr || m_store == nullptr) {
        ANA_MSG_ERROR ("module not inititalized");
        return StatusCode::FAILURE;
      }
      // readFrom has already been done in onFirstInputFile or onNextInputFile
      // Here we only need to make sure getEntry(0) is called
      if ((m_event->getEntries() > 0) && (m_event->getEntry (0) < 0)) {
        ANA_MSG_ERROR ("Failed to load first entry from file");
        return StatusCode::FAILURE;
      }
      m_store->clear ();
      return StatusCode::SUCCESS;
    }

◆ onNextInputFile()

StatusCode EL::Detail::EventModule::onNextInputFile ( ModuleData & data )

overridevirtual

actions after opening an input file after the first one

Reimplemented from EL::Detail::Module.

Definition at line 93 of file EventModule.cxx.

                                                             {
 
      if (m_event == nullptr || m_store == nullptr) {
        ANA_MSG_ERROR ("module not inititalized");
        return StatusCode::FAILURE;
      }
      ANA_CHECK (m_event->readFrom (*data.m_inputFile.get()));
      m_store->clear ();
      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::LeakCheckModule, EL::Detail::MemoryMonitorModule, and EL::Detail::StopwatchModule.

Definition at line 113 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

◆ postCloseInputFile()

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

overridevirtual

actions after CloseInputFile is called on the algorithms

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

Reimplemented from EL::Detail::Module.

Definition at line 120 of file EventModule.cxx.

                                                             {
 
      if (m_event == nullptr || m_store == nullptr) {
        ANA_MSG_ERROR ("module not inititalized");
        return StatusCode::FAILURE;
      }
      // Nothing to do post close input file
      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 119 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

◆ postFinalize()

StatusCode EL::Detail::EventModule::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 140 of file EventModule.cxx.

                                                          {
 
      if (m_useStats.value())       {
        xAOD::PerfStats::instance().stop();
        std::unique_ptr<xAOD::ReadStats> stats
          (new xAOD::ReadStats (xAOD::IOStats::instance().stats()));
        stats->SetName (Job::optXAODReadStats.c_str());
        stats->Print ();
        data.addOutput (std::move (stats));
      }
      data.m_evtStore = nullptr;
      data.m_event    = nullptr;
      data.m_tstore   = nullptr;
      m_evtStore.reset ();
      m_event.reset ();
      m_store.reset ();
      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::LeakCheckModule, and EL::Detail::MemoryMonitorModule.

Definition at line 67 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 95 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 73 of file Module.cxx.

75 {}

Member Data Documentation

◆ m_event

std::unique_ptr<xAOD::Event> EL::Detail::EventModule::m_event

private

description: the event structure used

Definition at line 69 of file EventModule.h.

◆ m_evtStore

std::unique_ptr<asg::SgEvent> EL::Detail::EventModule::m_evtStore

private

Definition at line 71 of file EventModule.h.

◆ m_store

std::unique_ptr<xAOD::TStore> EL::Detail::EventModule::m_store

private

Definition at line 70 of file EventModule.h.

◆ m_summaryReport

Gaudi::Property<bool> EL::Detail::EventModule::m_summaryReport {this, "summaryReport", true}

private

Definition at line 76 of file EventModule.h.

76{this, "summaryReport", true};

◆ m_useStats

Gaudi::Property<bool> EL::Detail::EventModule::m_useStats {this, "useStats", false}

private

description: whether we collect D3PDPerfStats statistics

Definition at line 75 of file EventModule.h.

75{this, "useStats", false};

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EventModule()

◆ ~EventModule()

Member Function Documentation

◆ firstInitialize()

◆ onCloseInputFile()

◆ onExecute()

◆ onFileExecute()

◆ onFinalize()

◆ onFirstInputFile()

◆ onInitialize()

◆ onNewInputFile()

◆ onNextInputFile()

◆ onWorkerEnd()

◆ postCloseInputFile()

◆ postFileClose()

◆ postFinalize()

◆ postFirstEvent()

◆ preFileInitialize()

◆ processInputs()

◆ reportInputFailure()

Member Data Documentation

◆ m_event

◆ m_evtStore

◆ m_store

◆ m_summaryReport

◆ m_useStats