DigiAccumulatorMixMod.h

Go to the documentation of this file.

#ifndef SimGeneral_MixingModule_DigiAccumulatorMixMod_h
#define SimGeneral_MixingModule_DigiAccumulatorMixMod_h
// -*- C++ -*-
//
// Package:     MixingModule
// Class  :     DigiAccumulatorMixMod
//
//
// Original Author:  Werner Sun
//         Created:  Tue Sep 20 17:33:33 CEST 2011
//

// system include files
#include <vector>
#include "SimDataFormats/PileupSummaryInfo/interface/PileupMixingContent.h"
#include "DataFormats/Provenance/interface/EventID.h"

// user include files

// forward declarations

namespace edm {
  class Event;
  class EventPrincipal;
  class EventSetup;
  class LuminosityBlock;
  class Run;
  class StreamID;
}  // namespace edm

class PileUpEventPrincipal;

class DigiAccumulatorMixMod {
public:
  DigiAccumulatorMixMod();

  DigiAccumulatorMixMod(DigiAccumulatorMixMod const&) = delete;  // stop default

  DigiAccumulatorMixMod const& operator=(DigiAccumulatorMixMod const&) = delete;  // stop default

  virtual ~DigiAccumulatorMixMod();

  // ---------- const member functions ---------------------

  // ---------- static member functions --------------------

  // ---------- member functions ---------------------------
  // Perform algorithm setup for each event before any signal/pileup events are processed.
  virtual void initializeEvent(edm::Event const& event, edm::EventSetup const& setup) = 0;

  // Accumulate digis or other data for each signal event.
  virtual void accumulate(edm::Event const& event, edm::EventSetup const& setup) = 0;

  // Accumulate digis or other data for each pileup event, one at a time.
  virtual void accumulate(PileUpEventPrincipal const& event, edm::EventSetup const& setup, edm::StreamID const&) = 0;

  // 1. Finalize digi collections or other data for each event.
  // 2. Put products in Event with appropriate instance labels
  virtual void finalizeEvent(edm::Event& event, edm::EventSetup const& setup) = 0;  // event is non-const

  // Perform any necessary actions before pileup events for a given bunch crossing are processed.
  virtual void initializeBunchCrossing(edm::Event const& event, edm::EventSetup const& setup, int bunchCrossing) {}

  // Perform any necessary actions after pileup events for a given bunch crossing are processed.
  // This may include putting bunch crossing specific products into the event.
  virtual void finalizeBunchCrossing(edm::Event& event, edm::EventSetup const& setup, int bunchCrossing) {}

  virtual void beginRun(edm::Run const& run, edm::EventSetup const& setup) {}
  virtual void endRun(edm::Run const& run, edm::EventSetup const& setup) {}
  virtual void beginLuminosityBlock(edm::LuminosityBlock const& lumi, edm::EventSetup const& setup) {}
  virtual void endLuminosityBlock(edm::LuminosityBlock const& lumi, edm::EventSetup const& setup) {}

  virtual void StorePileupInformation(std::vector<int>& numInteractionList,
                                      std::vector<int>& bunchCrossingList,
                                      std::vector<float>& TrueInteractionList,
                                      std::vector<edm::EventID>& eventList,
                                      int bunchSpace) {}

  virtual PileupMixingContent* getEventPileupInfo() {
    std::cout << " You must override the virtual functions in DigiAccumulatorMixMod in\n"
              << "order to access PileupInformation.  Returning empty object." << std::endl;

    PileupMixingContent* dummyPileupObject = new PileupMixingContent();

    return dummyPileupObject;
  }

private:
  // ---------- member data --------------------------------
};

#endif