StoredMergeableRunProductMetadata.h

Go to the documentation of this file.

#ifndef DataFormats_Provenance_StoredMergeableRunProductMetadata_h
#define DataFormats_Provenance_StoredMergeableRunProductMetadata_h

#include "DataFormats/Provenance/interface/RunLumiEventNumber.h"

#include <string>
#include <vector>

namespace edm {

  class StoredMergeableRunProductMetadata {
  public:

    // This constructor exists for ROOT I/O
    StoredMergeableRunProductMetadata();

    // This constructor is used when creating a new object
    // each time an output file is opened.
    StoredMergeableRunProductMetadata(std::vector<std::string> const& processesWithMergeableRunProducts);

    std::vector<std::string> const& processesWithMergeableRunProducts() const {
      return processesWithMergeableRunProducts_;
    }

    class SingleRunEntry {
    public:

      SingleRunEntry();
      SingleRunEntry(unsigned long long iBeginProcess, unsigned long long iEndProcess);

      unsigned long long beginProcess() const { return beginProcess_; }
      unsigned long long endProcess() const { return endProcess_; }

    private:

      // indexes into singleRunEntryAndProcesses_ for a single run entry
      unsigned long long beginProcess_;
      unsigned long long endProcess_;
    };

    class SingleRunEntryAndProcess {
    public:

      SingleRunEntryAndProcess();
      SingleRunEntryAndProcess(unsigned long long iBeginLumi,
                               unsigned long long iEndLumi,
                               unsigned int iProcess,
                               bool iValid,
                               bool iUseIndexIntoFile);


      unsigned long long beginLumi() const { return beginLumi_; }
      unsigned long long endLumi() const { return endLumi_; }

      unsigned int process() const { return process_; }

      bool valid() const { return valid_; }
      bool useIndexIntoFile() const { return useIndexIntoFile_; }

    private:

      // indexes into lumis_ for products created in one process and
      // written into a single run entry.
      unsigned long long beginLumi_;
      unsigned long long endLumi_;

      // index into processesWithMergeableRunProducts_
      unsigned int process_;

      // If false this indicates the way files were split and merged
      // has created run products that are invalid and probably
      // double count some of their content.
      bool valid_;

      // If true the lumi numbers can be obtained from IndexIntoFile
      // and are not stored in the vector named lumis_
      bool useIndexIntoFile_;
    };

    // These four functions are called by MergeableRunProductMetadata which
    // fills the vectors.
    std::vector<SingleRunEntry>& singleRunEntries() { return singleRunEntries_; }
    std::vector<SingleRunEntryAndProcess>& singleRunEntryAndProcesses() { return singleRunEntryAndProcesses_; }
    std::vector<LuminosityBlockNumber_t>& lumis() { return lumis_; }
    bool& allValidAndUseIndexIntoFile() { return allValidAndUseIndexIntoFile_; }

    // Called by RootOutputFile immediately before writing the object
    // when an output file is closed.
    void optimizeBeforeWrite();

    bool getLumiContent(unsigned long long runEntry,
                        std::string const& process,
                        bool& valid,
                        std::vector<LuminosityBlockNumber_t>::const_iterator & lumisBegin,
                        std::vector<LuminosityBlockNumber_t>::const_iterator & lumisEnd) const;

  private:

    std::vector<std::string> processesWithMergeableRunProducts_;
    std::vector<SingleRunEntry> singleRunEntries_;  // index is the run entry
    std::vector<SingleRunEntryAndProcess> singleRunEntryAndProcesses_;
    std::vector<LuminosityBlockNumber_t> lumis_;
    bool allValidAndUseIndexIntoFile_;
  };
}
#endif