FileMetaData.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <TObject.h>
 
#include <iosfwd>
#include <vector>
#include <string>
#include <map>
 
namespace Belle2 {

  class FileMetaData : public TObject {
  public:
    FileMetaData();

    const std::string& getLfn() const {return m_lfn;}

    unsigned int getNEvents() const {return m_nEvents;}

    unsigned int getNFullEvents() const {return m_nFullEvents;}

    int getExperimentLow() const {return m_experimentLow;}

    int getRunLow() const {return m_runLow;}

    unsigned int getEventLow() const {return m_eventLow;}

    int getExperimentHigh() const {return m_experimentHigh;}

    int getRunHigh() const {return m_runHigh;}

    unsigned int getEventHigh() const {return m_eventHigh;}

    bool containsEvent(int experiment, int run, unsigned int event) const;

    int getNParents() const {return m_parentLfns.size();}

    const std::string& getParent(int iParent) const {return m_parentLfns[iParent];}

    const std::string& getDate() const {return m_date;}

    const std::string& getSite() const {return m_site;}

    const std::string& getUser() const {return m_user;}

    const std::string& getRandomSeed() const {return m_randomSeed;}

    const std::string& getRelease() const {return m_release;}

    const std::string& getSteering() const {return m_steering;}

    bool isMC() const {return m_isMC;}

    unsigned int getMcEvents() const {return m_mcEvents;}

    const std::string& getDatabaseGlobalTag() const { return m_databaseGlobalTag; }

    const std::map<std::string, std::string>& getDataDescription() const { return m_dataDescription; }

    void setLfn(const std::string& lfn) {m_lfn = lfn;}

    void setNEvents(unsigned int nEvents) {m_nEvents = nEvents;}

    void setNFullEvents(unsigned int nEvents) {m_nFullEvents = nEvents;}

    void setLow(int experiment, int run, unsigned int event) {m_experimentLow = experiment; m_runLow = run; m_eventLow = event;}

    void setHigh(int experiment, int run, unsigned int event) {m_experimentHigh = experiment; m_runHigh = run; m_eventHigh = event;}

    void setParents(const std::vector<std::string>& parents) {m_parentLfns = parents;}

    void setCreationData(const std::string& date, const std::string& site, const std::string& user, const std::string& release)
    {m_date = date; m_site = site; m_user = user; m_release = release;}

    void setRandomSeed(const std::string& seed) {m_randomSeed = seed;}

    void setRelease(const std::string& release) {m_release = release;}

    void setSteering(const std::string& steering) {m_steering = steering;}

    void setMcEvents(unsigned int nEvents) {m_mcEvents = nEvents;}

    void setDatabaseGlobalTag(const std::string& globalTag) { m_databaseGlobalTag = globalTag; }

    void setDataDescription(const std::string& key, const std::string& value) { m_dataDescription[key] = value; }

    void removeDataDescription(const std::string& key) { m_dataDescription.erase(key); }

    static void exposePythonAPI();

    virtual void Print(Option_t* option = "") const override;

    bool read(std::istream& input, std::string& physicalFileName);

    bool write(std::ostream& output, const std::string& physicalFileName) const;

    std::string getJsonStr() const;
 
  private:
 
    std::string m_lfn; 
 
    unsigned int m_nEvents; 
 
    unsigned int m_nFullEvents; 
 
    int m_experimentLow; 
 
    int m_runLow; 
 
    unsigned int m_eventLow; 
 
    int m_experimentHigh; 
 
    int m_runHigh; 
 
    unsigned int m_eventHigh; 
 
    std::vector<std::string> m_parentLfns; 
 
    std::string m_date; 
 
    std::string m_site; 
 
    std::string m_user; 
 
    std::string m_randomSeed; 
 
    std::string m_release; 
 
    std::string m_steering; 
 
    bool m_isMC; 
 
    unsigned int m_mcEvents; 
 
    std::string m_databaseGlobalTag; 
 
    std::map<std::string, std::string> m_dataDescription; 

    void declareRealData() {m_isMC = false;}
 
    friend class SeqRootInputModule;
    friend class RootInputModule;
    friend class RootOutputModule;
    friend class B2BIIMdstInputModule;
    friend class BeamBkgHitRateMonitorModule;
    friend class StorageRootOutputModule;
    friend class VariablesToNtupleModule;
 
    ClassDefOverride(FileMetaData, 11); 
 
  }; //class

} // namespace Belle2