RunLumiEventChecker.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:    Modules
// Class:      RunLumiEventChecker
//
//
// Original Author:  Chris Jones
//         Created:  Tue Jun 16 15:42:17 CDT 2009
//
//

// user include files
#include "DataFormats/Provenance/interface/EventID.h"
#include "FWCore/Framework/interface/global/EDAnalyzer.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/LuminosityBlock.h"
#include "FWCore/Framework/interface/MakerMacros.h"
#include "FWCore/Framework/interface/Run.h"
#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
#include "FWCore/Utilities/interface/UnixSignalHandlers.h"
#include "FWCore/Utilities/interface/propagate_const.h"

// system include files
#include <algorithm>
#include <map>
#include <memory>
#include <vector>
#include <map>

//
// class decleration
//
namespace rlec {
  struct Cache {};
}  // namespace rlec

class RunLumiEventChecker
    : public edm::global::EDAnalyzer<edm::RunCache<rlec::Cache>, edm::LuminosityBlockCache<rlec::Cache>> {
public:
  explicit RunLumiEventChecker(edm::ParameterSet const&);
  ~RunLumiEventChecker() override;
  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);

private:
  void beginJob() override;
  void analyze(edm::StreamID, edm::Event const&, edm::EventSetup const&) const override;
  void endJob() override;

  std::shared_ptr<rlec::Cache> globalBeginRun(edm::Run const& run, edm::EventSetup const& es) const override;
  void globalEndRun(edm::Run const& run, edm::EventSetup const& es) const override;

  std::shared_ptr<rlec::Cache> globalBeginLuminosityBlock(edm::LuminosityBlock const& lumi,
                                                          edm::EventSetup const& es) const override;
  void globalEndLuminosityBlock(edm::LuminosityBlock const& lumi, edm::EventSetup const& es) const override;

  void check(edm::EventID const& iID, bool isEvent) const;

  // ----------member data ---------------------------
  std::vector<edm::EventID> ids_;
  mutable std::atomic<unsigned int> index_;
  unsigned int minNEvents_ = 0;
  unsigned int maxNEvents_ = 0;
  bool unorderedEvents_;
};

//
// constants, enums and typedefs
//

//
// static data member definitions
//

//
// constructors and destructor
//
RunLumiEventChecker::RunLumiEventChecker(edm::ParameterSet const& iConfig)
    : ids_(iConfig.getUntrackedParameter<std::vector<edm::EventID>>("eventSequence")),
      index_(0),
      minNEvents_(iConfig.getUntrackedParameter<unsigned int>("minNumberOfEvents")),
      maxNEvents_(iConfig.getUntrackedParameter<unsigned int>("maxNumberOfEvents")),
      unorderedEvents_(iConfig.getUntrackedParameter<bool>("unorderedEvents")) {
  //now do what ever initialization is needed
}

RunLumiEventChecker::~RunLumiEventChecker() {
  // do anything here that needs to be done at desctruction time
  // (e.g. close files, deallocate resources etc.)
}

//
// member functions
//

void RunLumiEventChecker::check(edm::EventID const& iEventID, bool iIsEvent) const {
  if (index_ >= ids_.size()) {
    throw cms::Exception("TooManyEvents")
        << "Was passes " << ids_.size() << " EventIDs but have processed more events than that\n";
  }
  if (unorderedEvents_) {
    auto itFound = std::find(ids_.begin(), ids_.end(), iEventID);
    if (itFound == ids_.end()) {
      throw cms::Exception("UnexpecedEvent") << "The event " << iEventID << " was not expected.";
    }
  } else {
    if (iEventID != ids_[index_]) {
      throw cms::Exception("WrongEvent") << "Was expecting event " << ids_[index_] << " but was given " << iEventID
                                         << "\n";
    }
  }
  ++index_;
}

// ------------ method called to for each event  ------------
void RunLumiEventChecker::analyze(edm::StreamID, edm::Event const& iEvent, edm::EventSetup const&) const {
  check(iEvent.id(), true);
}

std::shared_ptr<rlec::Cache> RunLumiEventChecker::globalBeginRun(edm::Run const& run, edm::EventSetup const&) const {
  check(edm::EventID(run.id().run(), 0, 0), false);
  return std::shared_ptr<rlec::Cache>{};
}
void RunLumiEventChecker::globalEndRun(edm::Run const& run, edm::EventSetup const&) const {
  check(edm::EventID(run.id().run(), 0, 0), false);
}

std::shared_ptr<rlec::Cache> RunLumiEventChecker::globalBeginLuminosityBlock(edm::LuminosityBlock const& lumi,
                                                                             edm::EventSetup const&) const {
  check(edm::EventID(lumi.id().run(), lumi.id().luminosityBlock(), 0), false);
  return std::shared_ptr<rlec::Cache>{};
}

void RunLumiEventChecker::globalEndLuminosityBlock(edm::LuminosityBlock const& lumi, edm::EventSetup const&) const {
  check(edm::EventID(lumi.id().run(), lumi.id().luminosityBlock(), 0), false);
}

// ------------ method called once each job just before starting event loop  ------------
void RunLumiEventChecker::beginJob() {}

// ------------ method called once each job just after ending the event loop  ------------
void RunLumiEventChecker::endJob() {
  if (maxNEvents_ == 0 and index_ != ids_.size()) {
    throw cms::Exception("WrongNumberOfEvents")
        << "Saw " << index_ << " (begin runs)+(begin lumis)+events+(end lumis)+(end runs) but was supposed to see "
        << ids_.size() << "\n";
  }
  if (maxNEvents_ != 0 and (index_ < minNEvents_ or index_ > maxNEvents_)) {
    throw cms::Exception("WrongNumberOfEvents")
        << "Saw " << index_
        << " (begin runs)+(begin lumis)+events+(end lumis)+(end runs) but was supposed to see between " << minNEvents_
        << " and " << maxNEvents_;
  }
}

// ------------ method called once each job for validation
void RunLumiEventChecker::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
  edm::ParameterSetDescription desc;
  desc.addUntracked<std::vector<edm::EventID>>("eventSequence");
  desc.addUntracked<unsigned int>("minNumberOfEvents", 0)
      ->setComment(
          "minimum number of Events that must be seen. If max is 0 then this will be ignored and all Events must be "
          "present");
  desc.addUntracked<unsigned int>("maxNumberOfEvents", 0)
      ->setComment("maximum number of Events that must be seen. If set to 0, min and max are ignored");
  desc.addUntracked<bool>("unorderedEvents", false)
      ->setComment("set to true if events are not guaranteed to be in same order as 'eventSequence' specifies.");
  descriptions.add("runLumiEventIDChecker", desc);
}

//define this as a plug-in
DEFINE_FWK_MODULE(RunLumiEventChecker);