EDLooperBase.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:     <package>
// Module:      EDLooperBase
// 
// Author:      Valentin Kuznetsov
// Created:     Wed Jul  5 11:44:26 EDT 2006

#include "FWCore/Framework/interface/EDLooperBase.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/EventPrincipal.h"
#include "FWCore/Framework/interface/LuminosityBlock.h"
#include "FWCore/Framework/interface/LuminosityBlockPrincipal.h"
#include "FWCore/Framework/interface/ModuleContextSentry.h"
#include "DataFormats/Provenance/interface/ModuleDescription.h"
#include "FWCore/Framework/interface/Run.h"
#include "FWCore/Framework/interface/RunPrincipal.h"
#include "FWCore/Framework/interface/EventSetupProvider.h"
#include "FWCore/Utilities/interface/Algorithms.h"
#include "FWCore/MessageLogger/interface/ExceptionMessages.h"
#include "FWCore/Framework/interface/ExceptionActions.h"
#include "FWCore/Utilities/interface/Exception.h"
#include "FWCore/Framework/interface/ScheduleInfo.h"
#include "FWCore/ServiceRegistry/interface/GlobalContext.h"
#include "FWCore/ServiceRegistry/interface/ModuleCallingContext.h"
#include "FWCore/ServiceRegistry/interface/ParentContext.h"
#include "FWCore/ServiceRegistry/interface/StreamContext.h"

namespace edm {

  EDLooperBase::EDLooperBase() : iCounter_(0), act_table_(nullptr), moduleChanger_(nullptr),
                                 moduleDescription_("Looper", "looper"),
                                 moduleCallingContext_(&moduleDescription_)
 { }
  EDLooperBase::~EDLooperBase() noexcept(false) { }

  void
  EDLooperBase::doStartingNewLoop() {
    startingNewLoop(iCounter_);
  }

  EDLooperBase::Status
  EDLooperBase::doDuringLoop(edm::EventPrincipal& eventPrincipal, const edm::EventSetup& es,
                             edm::ProcessingController& ioController, StreamContext* streamContext) {

    streamContext->setTransition(StreamContext::Transition::kEvent);
    streamContext->setEventID(eventPrincipal.id());
    streamContext->setRunIndex(eventPrincipal.luminosityBlockPrincipal().runPrincipal().index());
    streamContext->setLuminosityBlockIndex(eventPrincipal.luminosityBlockPrincipal().index());
    streamContext->setTimestamp(eventPrincipal.time());
    ParentContext parentContext(streamContext);
    ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
    Event event(eventPrincipal, moduleDescription_, &moduleCallingContext_);

    Status status = kContinue;
    try {
      status = duringLoop(event, es, ioController);
    }
    catch(cms::Exception& e) {
      e.addContext("Calling the 'duringLoop' method of a looper");
      exception_actions::ActionCodes action = (act_table_->find(e.category()));
      if (action != exception_actions::Rethrow) {
        edm::printCmsExceptionWarning("SkipEvent", e);
      }
      else {
        throw;
      }
    }
    return status;
  }

  EDLooperBase::Status
  EDLooperBase::doEndOfLoop(const edm::EventSetup& es) {
    return endOfLoop(es, iCounter_);
  }

  void
  EDLooperBase::prepareForNextLoop(eventsetup::EventSetupProvider* esp) {
    ++iCounter_;

    std::set<edm::eventsetup::EventSetupRecordKey> const& keys = modifyingRecords();
    for_all(keys,
      std::bind(&eventsetup::EventSetupProvider::resetRecordPlusDependentRecords,
                  esp, std::placeholders::_1));
  }

  void EDLooperBase::beginOfJob(const edm::EventSetup&) { beginOfJob();}
  void EDLooperBase::beginOfJob() { }

  void EDLooperBase::endOfJob() { }

  void EDLooperBase::doBeginRun(RunPrincipal& iRP, EventSetup const& iES, ProcessContext* processContext) {
        GlobalContext globalContext(GlobalContext::Transition::kBeginRun,
                                    LuminosityBlockID(iRP.run(), 0),
                                    iRP.index(),
                                    LuminosityBlockIndex::invalidLuminosityBlockIndex(),
                                    iRP.beginTime(),
                                    processContext);
        ParentContext parentContext(&globalContext);
        ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
        Run run(iRP, moduleDescription_, &moduleCallingContext_);
        beginRun(run,iES);
  }

  void EDLooperBase::doEndRun(RunPrincipal& iRP, EventSetup const& iES, ProcessContext* processContext){
        GlobalContext globalContext(GlobalContext::Transition::kEndRun,
                                    LuminosityBlockID(iRP.run(), 0),
                                    iRP.index(),
                                    LuminosityBlockIndex::invalidLuminosityBlockIndex(),
                                    iRP.endTime(),
                                    processContext);
        ParentContext parentContext(&globalContext);
        ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
        Run run(iRP, moduleDescription_, &moduleCallingContext_);
        endRun(run,iES);
  }
  void EDLooperBase::doBeginLuminosityBlock(LuminosityBlockPrincipal& iLB, EventSetup const& iES, ProcessContext* processContext){
    GlobalContext globalContext(GlobalContext::Transition::kBeginLuminosityBlock,
                                iLB.id(),
                                iLB.runPrincipal().index(),
                                iLB.index(),
                                iLB.beginTime(),
                                processContext);
    ParentContext parentContext(&globalContext);
    ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
    LuminosityBlock luminosityBlock(iLB, moduleDescription_, &moduleCallingContext_);
    beginLuminosityBlock(luminosityBlock,iES);
  }
  void EDLooperBase::doEndLuminosityBlock(LuminosityBlockPrincipal& iLB, EventSetup const& iES, ProcessContext* processContext){
    GlobalContext globalContext(GlobalContext::Transition::kEndLuminosityBlock,
                                iLB.id(),
                                iLB.runPrincipal().index(),
                                iLB.index(),
                                iLB.beginTime(),
                                processContext);
    ParentContext parentContext(&globalContext);
    ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
    LuminosityBlock luminosityBlock(iLB, moduleDescription_, &moduleCallingContext_);
    endLuminosityBlock(luminosityBlock,iES);
  }

  void EDLooperBase::beginRun(Run const&, EventSetup const&){}
  void EDLooperBase::endRun(Run const&, EventSetup const&){}
  void EDLooperBase::beginLuminosityBlock(LuminosityBlock const&, EventSetup const&){}
  void EDLooperBase::endLuminosityBlock(LuminosityBlock const&, EventSetup const&){}

  void EDLooperBase::attachTo(ActivityRegistry&){}
   

  std::set<eventsetup::EventSetupRecordKey> 
  EDLooperBase::modifyingRecords() const
  {
    return std::set<eventsetup::EventSetupRecordKey> ();
  }
   
  void 
  EDLooperBase::copyInfo(const ScheduleInfo& iInfo){
    scheduleInfo_ = std::make_unique<ScheduleInfo>(iInfo);
  }
  void 
  EDLooperBase::setModuleChanger(ModuleChanger* iChanger) {
    moduleChanger_ = iChanger;
  }

  ModuleChanger* EDLooperBase::moduleChanger() {
    return moduleChanger_;
  }
  const ScheduleInfo* EDLooperBase::scheduleInfo() const {
    return scheduleInfo_.get();
  }
  
}