Tool taking care of copying the event format object from file to file. More...

#include <EventFormatMetaDataTool.h>

Inheritance diagram for xAODMaker::EventFormatMetaDataTool:

Collaboration diagram for xAODMaker::EventFormatMetaDataTool:

Public Member Functions
	EventFormatMetaDataTool (const std::string &type, const std::string &name, const IInterface *parent)
	Regular AlgTool constructor. More...

virtual StatusCode	initialize () override
	Function initialising the tool. More...

virtual StatusCode	beginInputFile (const SG::SourceID &) override
	Function collecting the metadata from a new input file. More...

virtual StatusCode	endInputFile (const SG::SourceID &) override
	Function collecting the metadata from a new input file. More...

virtual StatusCode	metaDataStop (const SG::SourceID &)
	Wait for metadata write operations to finish, then returns SUCCESS. More...

virtual StatusCode	beginInputFile ()
	Function called when a new input file is opened. More...

virtual StatusCode	endInputFile ()
	Function called when the currently open input file got completely processed. More...

virtual StatusCode	metaDataStop () override
	Wait for metadata write operations to finish, then return SUCCESS. More...

Private Member Functions
StatusCode	collectMetaData ()
	Function collecting the event format metadata from the input file. More...

Private Attributes
ServiceHandle< ::StoreGateSvc >	m_inputMetaStore
	Connection to the input metadata store. More...

ServiceHandle< IAthMetaDataSvc >	m_outputMetaStore
	Connection to the output metadata store. More...

Gaudi::Property< std::vector< std::string > >	m_keys
	(optional) list of keys to copy, all if empty, default: empty More...

std::mutex	m_outputMutex
	MetaDataStop need to wait for ongoing writes. More...

Detailed Description

Tool taking care of copying the event format object from file to file.

This tool does the heavy lifting when fast-merging DxAOD files to make sure that the xAOD::EventFormat metadata object is propagated correctly from the input files to the output.

Author: Jack Cranshaw crans.nosp@m.haw@.nosp@m.anl.g.nosp@m.ov; Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h; Frank Berghaus fberg.nosp@m.haus.nosp@m.@anl..nosp@m.gov

Definition at line 35 of file EventFormatMetaDataTool.h.

Constructor & Destructor Documentation

◆ EventFormatMetaDataTool()

xAODMaker::EventFormatMetaDataTool::EventFormatMetaDataTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Regular AlgTool constructor.

Definition at line 20 of file EventFormatMetaDataTool.cxx.

22 :

23 base_class(type, name, parent) { }

Member Function Documentation

◆ beginInputFile() [1/2]

StatusCode xAODMaker::EventFormatMetaDataTool::beginInputFile ( )

virtual

Function called when a new input file is opened.

Definition at line 47 of file EventFormatMetaDataTool.cxx.

                                             {
       // lock the tool, so metaDataStop will wait for write to finish
       std::lock_guard< std::mutex > guard(m_outputMutex);
  
       // Create object to hold information from the new file
       auto format = std::make_unique< xAOD::EventFormat >();
  
       ATH_CHECK(collectMetaData());
  
       return StatusCode::SUCCESS;
     }

◆ beginInputFile() [2/2]

virtual StatusCode xAODMaker::EventFormatMetaDataTool::beginInputFile ( const SG::SourceID & )

inlineoverridevirtual

Function collecting the metadata from a new input file.

Definition at line 46 of file EventFormatMetaDataTool.h.

46 {return beginInputFile();}

◆ collectMetaData()

StatusCode xAODMaker::EventFormatMetaDataTool::collectMetaData ( )

private

Function collecting the event format metadata from the input file.

Definition at line 68 of file EventFormatMetaDataTool.cxx.

                                              {
  
       std::vector< std::string > keys = m_keys;
       if (keys.empty()) {
         m_inputMetaStore->keys<xAOD::EventFormat>(keys);
       } else {
         // remove keys not in the InputMetaDataStore
         keys.erase(
             std::remove_if(
                 keys.begin(), keys.end(),
                 [this](std::string& key) {
                   return !m_inputMetaStore->contains<xAOD::EventFormat>(key);
                 }),
             keys.end());
       }
  
       // If the input file doesn't have any event format metadata,
       // then finish right away:
       if (keys.empty()) return StatusCode::SUCCESS;
  
       // Retrieve the input container:
       for (const std::string& key : keys) {
         std::list<SG::ObjectWithVersion<xAOD::EventFormat> > allVersions;
         if (!m_inputMetaStore->retrieveAllVersions(allVersions, key)
                  .isSuccess()) {
           ATH_MSG_DEBUG("Failed to retrieve \""
                         << key << "\" from InputMetaDataStore");
           continue;  // try next key
         }
  
         // get output object
         auto output = m_outputMetaStore->tryRetrieve<xAOD::EventFormat>(key);
         if (!output) {
           auto ef = std::make_unique<xAOD::EventFormat>();
           output = ef.get();
           if (!m_outputMetaStore->record(std::move(ef), key).isSuccess()) {
             ATH_MSG_DEBUG("Failed to create output object \""
                           << key << "\" in MetaDataSvc");
             continue;
           }
         }
  
         ATH_MSG_VERBOSE("Merging all versions of " << key);
         for (auto& version : allVersions) {
           const auto* input = version.dataObject.cptr();
           // Merge the new object into the output one:
           for (const auto& pair : *input) {
             if (!output->exists(pair.second.hash())) {
               output->add(pair.second);
             }
           }
         }
       }
  
       // Return gracefully:
       return StatusCode::SUCCESS;
     }

◆ endInputFile() [1/2]

virtual StatusCode xAODMaker::EventFormatMetaDataTool::endInputFile ( )

inlinevirtual

Function called when the currently open input file got completely processed.

Definition at line 59 of file EventFormatMetaDataTool.h.

59 {return StatusCode::SUCCESS;}

◆ endInputFile() [2/2]

virtual StatusCode xAODMaker::EventFormatMetaDataTool::endInputFile ( const SG::SourceID & )

inlineoverridevirtual

Function collecting the metadata from a new input file.

Definition at line 49 of file EventFormatMetaDataTool.h.

49 {return endInputFile();}

◆ initialize()

StatusCode xAODMaker::EventFormatMetaDataTool::initialize ( )

overridevirtual

Function initialising the tool.

Definition at line 26 of file EventFormatMetaDataTool.cxx.

                                         {
       // Greet the user:
       ATH_MSG_VERBOSE("Initialising");
       ATH_MSG_VERBOSE("  " << m_inputMetaStore);
       ATH_MSG_VERBOSE("  " << m_outputMetaStore);
       if (!m_keys.empty()) {
         ATH_MSG_VERBOSE("Asked to copy EventFormat with keys:");
         for (const std::string& key : m_keys) {
           ATH_MSG_VERBOSE("  - " << key);
         }
       }
  
       // Connect to the metadata stores:
       ATH_CHECK(m_inputMetaStore.retrieve());
       ATH_CHECK(m_outputMetaStore.retrieve());
  
       // Return gracefully:
       return StatusCode::SUCCESS;
     }

◆ metaDataStop() [1/2]

StatusCode xAODMaker::EventFormatMetaDataTool::metaDataStop ( )

overridevirtual

Wait for metadata write operations to finish, then return SUCCESS.

Definition at line 60 of file EventFormatMetaDataTool.cxx.

                                           {
       // wait for threads currently writing to finish
       std::lock_guard< std::mutex > guard(m_outputMutex);
  
       return StatusCode::SUCCESS;
     }

◆ metaDataStop() [2/2]

virtual StatusCode xAODMaker::EventFormatMetaDataTool::metaDataStop ( const SG::SourceID & )

inlinevirtual

Wait for metadata write operations to finish, then returns SUCCESS.

Definition at line 52 of file EventFormatMetaDataTool.h.

52 {return metaDataStop();}

Member Data Documentation

◆ m_inputMetaStore

ServiceHandle< ::StoreGateSvc > xAODMaker::EventFormatMetaDataTool::m_inputMetaStore

private

Initial value:

{this, "InputMetaStore",

"StoreGateSvc/InputMetaDataStore", name()}

Connection to the input metadata store.

Definition at line 69 of file EventFormatMetaDataTool.h.

◆ m_keys

Gaudi::Property<std::vector<std::string> > xAODMaker::EventFormatMetaDataTool::m_keys

private

Initial value:

{ this, "Keys", {},

"(optional) list of keys to copy, all if empty. default: empty"}

(optional) list of keys to copy, all if empty, default: empty

Definition at line 77 of file EventFormatMetaDataTool.h.

◆ m_outputMetaStore

ServiceHandle< IAthMetaDataSvc > xAODMaker::EventFormatMetaDataTool::m_outputMetaStore

private

Initial value:

{this, "MetaDataSvc",

"MetaDataSvc", name()}

Connection to the output metadata store.

Definition at line 73 of file EventFormatMetaDataTool.h.

◆ m_outputMutex

std::mutex xAODMaker::EventFormatMetaDataTool::m_outputMutex

private

MetaDataStop need to wait for ongoing writes.

Definition at line 81 of file EventFormatMetaDataTool.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EventFormatMetaDataTool()

Member Function Documentation

◆ beginInputFile() [1/2]

◆ beginInputFile() [2/2]

◆ collectMetaData()

◆ endInputFile() [1/2]

◆ endInputFile() [2/2]

◆ initialize()

◆ metaDataStop() [1/2]

◆ metaDataStop() [2/2]

Member Data Documentation

◆ m_inputMetaStore

◆ m_keys

◆ m_outputMetaStore

◆ m_outputMutex