ProducerSourceBase.h

Go to the documentation of this file.

#ifndef Framework_Sources_ProducerSourceBase_h
#define Framework_Sources_ProducerSourceBase_h

/*----------------------------------------------------------------------
----------------------------------------------------------------------*/

#include "FWCore/Framework/interface/InputSource.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "DataFormats/Provenance/interface/EventAuxiliary.h"
#include "DataFormats/Provenance/interface/EventID.h"
#include "DataFormats/Provenance/interface/Timestamp.h"
#include "DataFormats/Provenance/interface/RunID.h"
#include "DataFormats/Provenance/interface/RunLumiEventNumber.h"

#include <memory>

namespace edm {
  class ParameterSet;
  class ParameterSetDescription;
  class ProducerSourceBase : public InputSource {
  public:
    explicit ProducerSourceBase(ParameterSet const& pset, InputSourceDescription const& desc, bool realData);
    virtual ~ProducerSourceBase() noexcept(false);

    unsigned int numberEventsInRun() const {return numberEventsInRun_;} 
    unsigned int numberEventsInLumi() const {return numberEventsInLumi_;} 
    TimeValue_t presentTime() const {return presentTime_;}
    unsigned int timeBetweenEvents() const {return timeBetweenEvents_;}
    unsigned int eventCreationDelay() const {return eventCreationDelay_;}
    unsigned int numberEventsInThisRun() const {return numberEventsInThisRun_;}
    unsigned int numberEventsInThisLumi() const {return numberEventsInThisLumi_;}
    EventID const& eventID() const {return eventID_;}
    RunNumber_t run() const {return eventID_.run();}
    EventNumber_t event() const {return eventID_.event();}
    LuminosityBlockNumber_t luminosityBlock() const {return eventID_.luminosityBlock();}

    static void fillDescription(ParameterSetDescription& desc);

  protected:

  private:
    virtual ItemType getNextItemType() override final;
    virtual void initialize(EventID& id, TimeValue_t& time, TimeValue_t& interval);
    virtual bool setRunAndEventInfo(EventID& id, TimeValue_t& time, EventAuxiliary::ExperimentType& etype) = 0;
    virtual void produce(Event& e) = 0;
    virtual bool noFiles() const;
    virtual size_t fileIndex() const;
    virtual void beginJob() override;
    virtual void beginRun(Run&) override;
    virtual void endRun(Run&) override;
    virtual void beginLuminosityBlock(LuminosityBlock&) override;
    virtual void endLuminosityBlock(LuminosityBlock&) override;
    virtual void readEvent_(EventPrincipal& eventPrincipal) override;
    virtual std::shared_ptr<LuminosityBlockAuxiliary> readLuminosityBlockAuxiliary_() override;
    virtual std::shared_ptr<RunAuxiliary> readRunAuxiliary_() override;
    virtual void skip(int offset) override;
    virtual void rewind_() override;

    void advanceToNext(EventID& eventID, TimeValue_t& time);
    void retreatToPrevious(EventID& eventID, TimeValue_t& time);

    unsigned int numberEventsInRun_;
    unsigned int numberEventsInLumi_;
    TimeValue_t presentTime_;
    TimeValue_t origTime_;
    TimeValue_t timeBetweenEvents_;
    unsigned int eventCreationDelay_;  /* microseconds */

    unsigned int numberEventsInThisRun_;
    unsigned int numberEventsInThisLumi_;
    EventNumber_t const zerothEvent_;
    EventID eventID_;
    EventID origEventID_;
    bool isRealData_;
    EventAuxiliary::ExperimentType eType_;
  };
}
#endif