xAODMaker::FileMetaDataTool Class Reference

Tool propagating xAOD::FileMetaData from input to output. More...

#include <FileMetaDataTool.h>

Inheritance diagram for xAODMaker::FileMetaDataTool:

Collaboration diagram for xAODMaker::FileMetaDataTool:

Public Member Functions
	FileMetaDataTool (const std::string &name="FileMetaDataTool")
	Regular AsgTool constructor. More...
StatusCode	initialize () override
	Function initialising the tool. More...
Functions called by the IMetaDataTool base class
StatusCode	beginInputFile () override
	Collecting file metadata from input and write to output. More...
StatusCode	endInputFile () override
	Does nothing. More...
StatusCode	beginInputFile (const SG::SourceID &) override
	Collecting file metadata from input and write to output. More...
StatusCode	endInputFile (const SG::SourceID &) override
	Does nothing. More...
StatusCode	metaDataStop () override
	Does nothing. More...

Private Member Functions
StatusCode	copy (const std::string &)
void	copyValues (const xAOD::FileMetaData *src, xAOD::FileMetaData *dst, const std::string &var)

Private Attributes
Gaudi::Property< std::vector< std::string > >	m_keys
ServiceHandle< IAthMetaDataSvc >	m_metaDataSvc {"MetaDataSvc", name()}
	Get a handle on the metadata store for the job. More...
std::mutex	m_toolMutex

Detailed Description

Tool propagating xAOD::FileMetaData from input to output.

This tool propagates the xAOD::FileMetaData object from the input files to the MetaDataStore in Athena. It requires the input to contain the information in an xAOD format. The tool will emit a warning if the file metadata between inputs does not match.

Author

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 37 of file FileMetaDataTool.h.

Constructor & Destructor Documentation

FileMetaDataTool()

xAODMaker::FileMetaDataTool::FileMetaDataTool ( const std::string &  name = "FileMetaDataTool" )

explicit

Regular AsgTool constructor.

Definition at line 19 of file FileMetaDataTool.cxx.

      : base_class( name ) { }

Member Function Documentation

beginInputFile() [1/2]

StatusCode xAODMaker::FileMetaDataTool::beginInputFile ( )

override

Collecting file metadata from input and write to output.

Definition at line 33 of file FileMetaDataTool.cxx.

                                     {
      // Previous input file has been processed
      std::lock_guard lock(m_toolMutex);
 
      // get the keys for all metadata in input
      std::vector<std::string> keys = m_keys;
      if (keys.empty()) {
         inputMetaStore()->keys<xAOD::FileMetaData>(keys);
      } else {
        // remove keys not in the InputMetaDataStore
        keys.erase(
            std::remove_if(
                keys.begin(), keys.end(),
                [this](std::string& key) {
                  return !inputMetaStore()->contains<xAOD::FileMetaData>(key);
                }),
            keys.end());
      }
 
      // If the input file doesn't have any event format metadata,
      // then finish right away:
      if (keys.empty()) return StatusCode::SUCCESS;
 
      // Now copy all object to MetaDataStore
      for(const std::string& key : keys) {
#ifdef XAOD_STANDALONE
         ASG_CHECK(copy(key));
#else
         for(const std::string& stream_key : m_metaDataSvc->getPerStreamKeysFor(key) ) {
            ASG_CHECK( copy(stream_key) );
         }
#endif  // XAOD_STANDALONE
      }
      return StatusCode::SUCCESS;
    }

beginInputFile() [2/2]

StatusCode xAODMaker::FileMetaDataTool::beginInputFile ( const SG::SourceID &  )

inlineoverride

Collecting file metadata from input and write to output.

Definition at line 64 of file FileMetaDataTool.h.

{return beginInputFile();};

copy()

StatusCode xAODMaker::FileMetaDataTool::copy ( const std::string &  key )

private

Definition at line 70 of file FileMetaDataTool.cxx.

                                               {
      ATH_MSG_DEBUG("Copying \"" << key << "\" from InputMetaDataStore");
      // Quit gracefully if there is nothing to do
      if (!inputMetaStore()->contains< xAOD::FileMetaData >(key)) {
        ATH_MSG_INFO("No \"" << key << "\" in the input file");
        return StatusCode::SUCCESS;
      }
 
      // Get the FileMetaData object from the input file
      const xAOD::FileMetaData * input = nullptr;
      ASG_CHECK(inputMetaStore()->retrieve(input, key));
 
      // Emit a warning if the FileMetaData from previous files does not
      // match that of the new input file
#ifdef XAOD_STANDALONE
      if (outputMetaStore()->contains< xAOD::FileMetaData >(key)) {
         xAOD::FileMetaData * output = nullptr;
         ASG_CHECK(outputMetaStore()->retrieve(output, key));
#else
      if (m_metaDataSvc->contains< xAOD::FileMetaData >(key)) {
         auto *output = m_metaDataSvc->tryRetrieve< xAOD::FileMetaData >(key);
         if (!output) return StatusCode::FAILURE;
#endif  // XAOD_STANDALONE
 
         copyValues(input, output, "runNumbers");
         copyValues(input, output, "lumiBlocks");
 
         const std::set<std::string>  ignore { "runNumbers", "lumiBlocks" };
         if( !input->compareWith(*output, ignore) )
            ATH_MSG_WARNING("Inconsistent input file MetaData");
 
         return StatusCode::SUCCESS;
      }
 
      ATH_MSG_DEBUG("Creating output objects");
      auto output = std::make_unique< xAOD::FileMetaData >();
      auto outputAux = std::make_unique< xAOD::FileMetaDataAuxInfo >();
      output->setStore(outputAux.get());
 
      // Copy input object
      *output = *input;
 
 
#ifdef XAOD_STANDALONE
      ASG_CHECK(
          outputMetaStore()->record< xAOD::FileMetaData >(
              std::move(output), key));
 
      ASG_CHECK(
          outputMetaStore()->record< xAOD::FileMetaDataAuxInfo >(
              std::move(outputAux), key + "Aux."));
#else
      ASG_CHECK(
          m_metaDataSvc->record< xAOD::FileMetaData >(
              std::move(output), key));
 
      ASG_CHECK(
          m_metaDataSvc->record< xAOD::FileMetaDataAuxInfo >(
              std::move(outputAux), key + "Aux."));
#endif  // XAOD_STANDALONE
 
      ATH_MSG_INFO("Copied \"" << key << "\" to MetaDataStore");
 
      // Return gracefully:
      return StatusCode::SUCCESS;
    }

copyValues()

void xAODMaker::FileMetaDataTool::copyValues ( const xAOD::FileMetaData *  src, xAOD::FileMetaData *  dst, const std::string &  var  )

private

Definition at line 138 of file FileMetaDataTool.cxx.

{
   std::vector<uint32_t> src_vec, dst_vec;
   src->value(var, src_vec);
   dst->value(var, dst_vec);
   bool updated = false;
 
   for( auto val : src_vec ) {
      // we want a sorted list of unique values (without using std::set)
      auto it = std::lower_bound( dst_vec.begin(), dst_vec.end(), val );
      if( it == dst_vec.end() || (*it) != val ) {
         dst_vec.insert(it, val);
         updated = true;
         ATH_MSG_DEBUG("added " << val << " to list of " << var);
      }
   }
   if( updated ) {
      if( !dst->setValue(var, dst_vec) ) {
         ATH_MSG_WARNING("error updating values for " + var);
      }
   }
}

endInputFile() [1/2]

StatusCode xAODMaker::FileMetaDataTool::endInputFile ( )

inlineoverride

Does nothing.

Definition at line 60 of file FileMetaDataTool.h.

{return StatusCode::SUCCESS;};

endInputFile() [2/2]

StatusCode xAODMaker::FileMetaDataTool::endInputFile ( const SG::SourceID &  )

inlineoverride

Does nothing.

Definition at line 67 of file FileMetaDataTool.h.

{return StatusCode::SUCCESS;};

initialize()

StatusCode xAODMaker::FileMetaDataTool::initialize ( )

override

Function initialising the tool.

Definition at line 23 of file FileMetaDataTool.cxx.

                                 {
#ifndef XAOD_STANDALONE
      ASG_CHECK(m_metaDataSvc.retrieve());
#endif  // XAOD_STANDALONE
 
      // Return gracefully:
      return StatusCode::SUCCESS;
    }

metaDataStop()

StatusCode xAODMaker::FileMetaDataTool::metaDataStop ( )

inlineoverride

Does nothing.

Definition at line 71 of file FileMetaDataTool.h.

{return StatusCode::SUCCESS;};

Member Data Documentation

m_keys

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

private

Initial value:

{
    this,
    "Keys",
    {},
    "(optional) List of keys to copy. Copy all keys if empty"}

Definition at line 76 of file FileMetaDataTool.h.

m_metaDataSvc

ServiceHandle< IAthMetaDataSvc > xAODMaker::FileMetaDataTool::m_metaDataSvc {"MetaDataSvc", name()}

private

Get a handle on the metadata store for the job.

Definition at line 84 of file FileMetaDataTool.h.

m_toolMutex

std::mutex xAODMaker::FileMetaDataTool::m_toolMutex

private

Definition at line 88 of file FileMetaDataTool.h.

---

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

• FileMetaDataTool.h
• FileMetaDataTool.cxx