EventFormatStreamHelperTool.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
/* Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration */
#ifndef XAODEVENTFORMATCNV_EVENTFORMATSTREAMHELPERTOOL
#define XAODEVENTFORMATCNV_EVENTFORMATSTREAMHELPERTOOL
 
#include <mutex>
#include <regex>
#include <set>
#include <string>
#include <vector>
 
// Gaudi/Athena include(s).
#include "Gaudi/Property.h"
#include "GaudiKernel/ServiceHandle.h"
#include "AthenaBaseComps/AthAlgTool.h"
#include "AthenaKernel/IAthenaOutputTool.h"
#include "AthenaKernel/IAthMetaDataSvc.h"
#include "CxxUtils/checker_macros.h"
 
namespace xAODMaker {
class EventFormatStreamHelperTool : public extends< AthAlgTool, IAthenaOutputTool > {
 public:
  using sgkey_t = SG::sgkey_t;
 
  // Inherit the base class's constructor(s).
  using extends::extends;


  StatusCode initialize() override;



  StatusCode postInitialize() override {return StatusCode::SUCCESS;}

  StatusCode preExecute() override {return StatusCode::SUCCESS;}

  StatusCode postExecute() override;

  StatusCode preFinalize() override {return StatusCode::SUCCESS;}

  StatusCode preStream() override {return StatusCode::SUCCESS;}

 
 private:
  ServiceHandle< IAthMetaDataSvc > m_metadataStore{ this, "MetaDataSvc",
    "MetaDataSvc", "The metadata service use to record the xAOD::EventFormat" };

  ServiceHandle< IClassIDSvc > m_clidSvc{ this, "ClassIDSvc", "ClassIDSvc",
    "The ClassID service instance to use" };
 
  Gaudi::Property< std::string > m_key{ this, "Key", "EventInfo",
    "Key for EventFormat object in metadata store" };

  Gaudi::Property< std::vector< std::string > > m_typeNames{ this,
    "TypeNames", { ".*xAOD::.*", "DataVector<SG::AuxElement>" },
    "Type names for which metadata entries are added" };

  Gaudi::Property< std::vector< std::string > > m_ignoreKeys{ this,
    "IgnoreKeys", { "HLTAutoKey_.*" },
    "SG keys that should be ignored during the metadata collection" };
 
  Gaudi::Property< std::string > m_dataHeaderKey{this, "DataHeaderKey", "",
    "Key of DataHeader produced by output stream" };
 
  StatusCode collectFormatMetadata();

  std::vector< std::regex > m_ignoreKeyRegexes;
  std::vector< std::regex > m_typeNameRegexes;

  sgkey_t lookUpHash(
    CLID primaryClassID,
    const std::set< CLID >& classIDs,
    const std::vector< sgkey_t >& hashes) const;

  std::set< CLID > m_warnedCLIDs;
  std::mutex m_warnedCLIDsMutex;

  mutable std::mutex m_efMutex;
};  // class EventFormatStreamHelperTool
}  // namespace xAODMaker
 
#endif  // XAODEVENTFORMATCNV_EVENTFORMATSTREAMHELPERTOOL