ChainEvent.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:     FWLite
// Class  :     ChainEvent
//
// Implementation:
//     <Notes on implementation>
//
// Original Author:  Chris Jones
//         Created:  Sat Jun 16 06:48:39 EDT 2007
//

// system include files

// user include files
#include "DataFormats/FWLite/interface/ChainEvent.h"
#include "DataFormats/Provenance/interface/BranchType.h"
#include "DataFormats/Provenance/interface/ProcessHistory.h"
#include "TFile.h"
#include "TTree.h"
#include "TROOT.h"

namespace fwlite {
  //
  // constants, enums and typedefs
  //

  //
  // static data member definitions
  //

  //
  // constructors and destructor
  //
  ChainEvent::ChainEvent(std::vector<std::string> const& iFileNames)
      : fileNames_(), file_(), event_(), eventIndex_(0), accumulatedSize_() {
    Long64_t summedSize = 0;
    accumulatedSize_.reserve(iFileNames.size() + 1);
    fileNames_.reserve(iFileNames.size());

    for (auto const& fileName : iFileNames) {
      TFile* tfilePtr = TFile::Open(fileName.c_str());
      if (nullptr == tfilePtr) {
        throw cms::Exception("FileOpenFailed") << "TFile::Open of " << fileName << " failed";
      }
      file_ = std::shared_ptr<TFile>(tfilePtr);
      gROOT->GetListOfFiles()->Remove(tfilePtr);
      TTree* tree = dynamic_cast<TTree*>(file_->Get(edm::poolNames::eventTreeName().c_str()));
      if (nullptr == tree) {
        throw cms::Exception("NotEdmFile")
            << "The file " << fileName << " has no 'Events' TTree and therefore is not an EDM ROOT file";
      }
      Long64_t nEvents = tree->GetEntries();
      if (nEvents > 0) {  // skip empty files
        fileNames_.push_back(fileName);
        // accumulatedSize_ is the entry # at the beginning of this file
        accumulatedSize_.push_back(summedSize);
        summedSize += nEvents;
      }
    }
    // total accumulated size (last enry + 1) at the end of last file
    accumulatedSize_.push_back(summedSize);

    if (!fileNames_.empty())
      switchToFile(0);
  }

  // ChainEvent::ChainEvent(ChainEvent const& rhs)
  // {
  //    // do actual copying here;
  // }

  ChainEvent::~ChainEvent() {}

  //
  // assignment operators
  //
  // ChainEvent const& ChainEvent::operator=(ChainEvent const& rhs)
  // {
  //   //An exception safe implementation is
  //   ChainEvent temp(rhs);
  //   swap(rhs);
  //
  //   return *this;
  // }

  //
  // member functions
  //

  ChainEvent const& ChainEvent::operator++() {
    if (eventIndex_ != static_cast<Long64_t>(fileNames_.size()) - 1) {
      ++(*event_);
      if (event_->atEnd()) {
        switchToFile(++eventIndex_);
      }
    } else {
      if (*event_) {
        ++(*event_);
      }
    }
    return *this;
  }

  bool ChainEvent::to(Long64_t iIndex) {
    if (iIndex >= accumulatedSize_.back()) {
      // if we're here, then iIndex was not valid
      return false;
    }

    Long64_t offsetIndex = eventIndex_;

    // we're going backwards, so start from the beginning
    if (iIndex < accumulatedSize_[offsetIndex]) {
      offsetIndex = 0;
    }

    // is it past the end of this file?
    while (iIndex >= accumulatedSize_[offsetIndex + 1]) {
      ++offsetIndex;
    }

    if (offsetIndex != eventIndex_) {
      switchToFile(eventIndex_ = offsetIndex);
    }

    // adjust to entry # in this file
    return event_->to(iIndex - accumulatedSize_[offsetIndex]);
  }

  bool ChainEvent::to(const edm::EventID& id) { return to(id.run(), id.luminosityBlock(), id.event()); }

  bool ChainEvent::to(edm::RunNumber_t run, edm::LuminosityBlockNumber_t lumi, edm::EventNumber_t event) {
    // First try this file
    if (event_->to(run, lumi, event)) {
      // found it, return
      return true;
    } else {
      // Did not find it, try the other files sequentially.
      // Someday I can make this smarter. For now... we get something working.
      Long64_t thisFile = eventIndex_;
      std::vector<std::string>::const_iterator filesBegin = fileNames_.begin(), filesEnd = fileNames_.end(),
                                               ifile = filesBegin;
      for (; ifile != filesEnd; ++ifile) {
        // skip the "first" file that we tried
        if (ifile - filesBegin != thisFile) {
          // switch to the next file
          switchToFile(ifile - filesBegin);
          // check that tree for the desired event
          if (event_->to(run, lumi, event)) {
            // found it, return
            return true;
          }
        }  // end ignore "first" file that we tried
      }    // end loop over files

      // did not find the event with id "id".
      return false;
    }  // end if we did not find event id in "first" file
  }

  bool ChainEvent::to(edm::RunNumber_t run, edm::EventNumber_t event) { return to(run, 0U, event); }

  ChainEvent const& ChainEvent::toBegin() {
    if (!size())
      return *this;
    if (eventIndex_ != 0) {
      switchToFile(0);
    }
    event_->toBegin();
    return *this;
  }

  void ChainEvent::switchToFile(Long64_t iIndex) {
    eventIndex_ = iIndex;
    TFile* tfilePtr = TFile::Open(fileNames_[iIndex].c_str());
    file_ = std::shared_ptr<TFile>(tfilePtr);
    gROOT->GetListOfFiles()->Remove(tfilePtr);
    event_ = std::make_shared<Event>(file_.get());
  }

  //
  // const member functions
  //
  std::string const ChainEvent::getBranchNameFor(std::type_info const& iType,
                                                 char const* iModule,
                                                 char const* iInstance,
                                                 char const* iProcess) const {
    return event_->getBranchNameFor(iType, iModule, iInstance, iProcess);
  }

  std::vector<edm::BranchDescription> const& ChainEvent::getBranchDescriptions() const {
    return event_->getBranchDescriptions();
  }

  std::vector<std::string> const& ChainEvent::getProcessHistory() const { return event_->getProcessHistory(); }

  edm::ProcessHistory const& ChainEvent::processHistory() const { return event_->processHistory(); }

  edm::EventAuxiliary const& ChainEvent::eventAuxiliary() const { return event_->eventAuxiliary(); }

  fwlite::LuminosityBlock const& ChainEvent::getLuminosityBlock() { return event_->getLuminosityBlock(); }

  fwlite::Run const& ChainEvent::getRun() { return event_->getRun(); }

  bool ChainEvent::getByLabel(std::type_info const& iType,
                              char const* iModule,
                              char const* iInstance,
                              char const* iProcess,
                              void* iValue) const {
    return event_->getByLabel(iType, iModule, iInstance, iProcess, iValue);
  }

  bool ChainEvent::getByTokenImp(edm::EDGetToken iToken, edm::WrapperBase const*& iValue) const {
    return event_->getByTokenImp(iToken, iValue);
  }

  edm::WrapperBase const* ChainEvent::getByProductID(edm::ProductID const& iID) const {
    return event_->getByProductID(iID);
  }

  std::optional<std::tuple<edm::WrapperBase const*, unsigned int>> ChainEvent::getThinnedProduct(
      edm::ProductID const& pid, unsigned int key) const {
    return event_->getThinnedProduct(pid, key);
  }

  void ChainEvent::getThinnedProducts(edm::ProductID const& pid,
                                      std::vector<edm::WrapperBase const*>& foundContainers,
                                      std::vector<unsigned int>& keys) const {
    event_->getThinnedProducts(pid, foundContainers, keys);
  }

  edm::OptionalThinnedKey ChainEvent::getThinnedKeyFrom(edm::ProductID const& parent,
                                                        unsigned int key,
                                                        edm::ProductID const& thinned) const {
    return event_->getThinnedKeyFrom(parent, key, thinned);
  }

  bool ChainEvent::isValid() const { return event_->isValid(); }
  ChainEvent::operator bool() const { return *event_; }

  bool ChainEvent::atEnd() const {
    if (!size())
      return true;
    if (eventIndex_ == static_cast<Long64_t>(fileNames_.size()) - 1) {
      return event_->atEnd();
    }
    return false;
  }

  Long64_t ChainEvent::size() const { return accumulatedSize_.empty() ? 0 : accumulatedSize_.back(); }

  edm::TriggerNames const& ChainEvent::triggerNames(edm::TriggerResults const& triggerResults) const {
    return event_->triggerNames(triggerResults);
  }

  edm::ParameterSet const* ChainEvent::parameterSet(edm::ParameterSetID const& psID) const {
    return event_->parameterSet(psID);
  }

  void ChainEvent::fillParameterSetRegistry() const { event_->fillParameterSetRegistry(); }

  edm::TriggerResultsByName ChainEvent::triggerResultsByName(edm::TriggerResults const& triggerResults) const {
    return event_->triggerResultsByName(triggerResults);
  }

  //
  // static member functions
  //
  void ChainEvent::throwProductNotFoundException(std::type_info const& iType,
                                                 char const* iModule,
                                                 char const* iInstance,
                                                 char const* iProcess) {
    Event::throwProductNotFoundException(iType, iModule, iInstance, iProcess);
  }
}  // namespace fwlite