IOVDbMetaDataTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef IOVDBMETADATATOOLS_IOVDBMETADATATOOL_H
#define IOVDBMETADATATOOLS_IOVDBMETADATATOOL_H

 
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/IIncidentListener.h"
#include "IOVDbMetaDataTools/IIOVDbMetaDataTool.h"
 
#include <string>
#include <shared_mutex>
 
class StoreGateSvc;
class IOVMetaDataContainer;

 
class IOVDbMetaDataTool : public extends<AthAlgTool,
                                         IIncidentListener, IIOVDbMetaDataTool>
{
public:    
    // Constructor
    IOVDbMetaDataTool(const std::string& type, 
                      const std::string& name, 
                      const IInterface* parent); 
    // Standard Destructor
    virtual ~IOVDbMetaDataTool();

    virtual StatusCode initialize() override;

    virtual StatusCode finalize() override;

    virtual StatusCode beginInputFile(const SG::SourceID&) override;

    virtual StatusCode endInputFile(const SG::SourceID&) override;

    virtual StatusCode metaDataStop() override;

    virtual void handle(const Incident& incident) override;

    virtual StatusCode  registerFolder(const std::string& folderName, 
                                       const std::string& folderDescription) const override;
    
    virtual StatusCode registerFolder(const std::string& folderName) const override;

    virtual StatusCode addPayload(const std::string& folderName,
                   CondAttrListCollection* payload) const override;

    virtual StatusCode processInputFileMetaData(const std::string& fileName) override;
 
    virtual IOVMetaDataContainer* findMetaDataContainer(const std::string& folderName) const override final;
 
    // ILockableTool API implementation
    virtual void lock_shared() const override final { m_mutex.lock_shared(); }
    virtual void unlock_shared() const override final { m_mutex.unlock_shared(); }
 
private:

    IOVMetaDataContainer* getMetaDataContainer(const std::string& folderName, 
                                               const std::string& folderDescription) const;

    void        checkOverrideRunNumber();

    StatusCode  overrideIOV (CondAttrListCollection*& coll) const;

    StatusCode  modifyPayload (const std::string& folderName,
                               CondAttrListCollection*& payload) const;

    std::string serializeContainerToJSON(const IOVMetaDataContainer* container) const;

    StatusCode serializeIOVMetadataToBSMetadata();

    typedef ServiceHandle<StoreGateSvc> StoreGateSvc_t;
    StoreGateSvc_t   m_metaDataStore;
    StoreGateSvc_t   m_inputStore;
    StoreGateSvc_t   m_condStore;
 
    // Flag to check whether we need to override run number for MC
    // events in incoming file meta data. This is needed for example
    // for incoming simulation or digitization parameters.
    bool             m_overrideRunNumber;
    bool             m_overrideMinMaxRunNumber;
 
    // Values for changing run number
    unsigned int     m_newRunNumber;
    unsigned int     m_oldRunNumber;
 
    unsigned int     m_minRunNumber;
    unsigned int     m_maxRunNumber;
 
    // Files already processed, maintain a set
    std::set<std::string> m_filesProcessed;
 
    UnsignedIntegerArrayProperty m_minMaxRunNumbers{this, "MinMaxRunNumbers", {}, "Min/max run numbers for overriding meta data IOV"};
    StringArrayProperty  m_foldersToBeModified{this, "FoldersToBeModified", {"/Simulation/Parameters"}};
    StringArrayProperty  m_attributesToBeRemoved{this, "AttributesToBeRemoved", {"RandomSeedOffset"}};
    bool                 m_modifyFolders;
 
    // Property for direct payload registration without intermediate files
    // Format: flat map with "folder:key" -> "value"
    // Special keys: "folder:beginRun" and "folder:endRun" specify IOV range
    Gaudi::Property<std::map<std::string, std::string>> m_payloads{
        this, "Payloads", {}, "Direct payload registration (format: {folder:key: value})"};
 
    // Folders to serialize to ByteStream metadata
    Gaudi::Property<std::vector<std::string>> m_foldersToSerializeToBSMetadata{
        this, "FoldersToSerializeToBSMetadata", {},
        "List of folder names to serialize to ByteStream metadata as JSON"};
 
    // mutex for R/W locking of the entire tool (and supposedly all metadata objects it works with)
    mutable std::shared_mutex    m_mutex;
};
 
#endif // IOVDBMETADATATOOLS_IOVDBMETADATATOOL_H