RunPrincipal.h

Go to the documentation of this file.

#ifndef FWCore_Framework_RunPrincipal_h
#define FWCore_Framework_RunPrincipal_h

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

RunPrincipal: This is the class responsible for management of
per run EDProducts. It is not seen by reconstruction code;
such code sees the Run class, which is a proxy for RunPrincipal.

The major internal component of the RunPrincipal
is the DataBlock.

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

#include <string>
#include <vector>

#include <memory>

#include "DataFormats/Provenance/interface/RunAuxiliary.h"
#include "DataFormats/Provenance/interface/ProcessHistoryID.h"
#include "FWCore/Utilities/interface/RunIndex.h"
#include "FWCore/Framework/interface/Principal.h"

namespace edm {

  class HistoryAppender;
  class ModuleCallingContext;
  class UnscheduledHandler;

  class RunPrincipal : public Principal {
  public:
    typedef RunAuxiliary Auxiliary;
    typedef Principal Base;

    RunPrincipal(
        std::shared_ptr<RunAuxiliary> aux,
        std::shared_ptr<ProductRegistry const> reg,
        ProcessConfiguration const& pc,
        HistoryAppender* historyAppender,
        unsigned int iRunIndex);
    ~RunPrincipal() {}

    void fillRunPrincipal(ProcessHistoryRegistry const& processHistoryRegistry, DelayedReader* reader = 0);

    RunIndex index() const {
      return index_;
    }
    
    RunAuxiliary const& aux() const {
      return *aux_;
    }

    RunNumber_t run() const {
      return aux().run();
    }
    
    ProcessHistoryID const& reducedProcessHistoryID() const {
      return m_reducedHistoryID;
    }

    RunID const& id() const {
      return aux().id();
    }

    Timestamp const& beginTime() const {
      return aux().beginTime();
    }

    Timestamp const& endTime() const {
      return aux().endTime();
    }

    void setEndTime(Timestamp const& time) {
      aux_->setEndTime(time);
    }

    void mergeAuxiliary(RunAuxiliary const& aux) {
      return aux_->mergeAuxiliary(aux);
    }

    void setUnscheduledHandler(std::shared_ptr<UnscheduledHandler>) {}

    void put(
        BranchDescription const& bd,
        std::unique_ptr<WrapperBase> edp);

    void readImmediate() const;

    void setComplete() {
      complete_ = true;
    }

  private:

    virtual bool isComplete_() const override {return complete_;}

    virtual bool unscheduledFill(std::string const&,
                                 ModuleCallingContext const* mcc) const override {return false;}

    virtual unsigned int transitionIndex_() const override;

    void resolveProductImmediate(ProductHolderBase const& phb) const;

    std::shared_ptr<RunAuxiliary> aux_;
    ProcessHistoryID m_reducedHistoryID;
    RunIndex index_;

    bool complete_;
  };
}
#endif