SubRunAuxiliary.h

Go to the documentation of this file.

#ifndef canvas_Persistency_Provenance_SubRunAuxiliary_h
#define canvas_Persistency_Provenance_SubRunAuxiliary_h
// vim: set sw=2 expandtab :

#include "canvas/Persistency/Provenance/BranchType.h"
#include "canvas/Persistency/Provenance/ProcessHistoryID.h"
#include "canvas/Persistency/Provenance/RunID.h"
#include "canvas/Persistency/Provenance/SubRunID.h"
#include "canvas/Persistency/Provenance/Timestamp.h"

#include <iosfwd>

// Auxiliary subRun data that is persistent

namespace art {

  class SubRunAuxiliary {
  public:
    static constexpr BranchType branch_type = InSubRun;

    SubRunAuxiliary();

    SubRunAuxiliary(SubRunID const& theId,
                    Timestamp beginTime,
                    Timestamp endTime);

    SubRunAuxiliary(RunNumber_t run,
                    SubRunNumber_t subrun,
                    Timestamp beginTime,
                    Timestamp endTime);

    SubRunAuxiliary duplicateWith(Timestamp beginTime,
                                  Timestamp endTime = {}) const;

    void write(std::ostream& os) const;

    ProcessHistoryID const& processHistoryID() const noexcept;
    void setProcessHistoryID(ProcessHistoryID const& phid);

    SubRunID const& id() const noexcept;
    SubRunID const& subRunID() const noexcept;
    RunID const& runID() const noexcept;
    RunNumber_t run() const noexcept;
    SubRunNumber_t subRun() const noexcept;

    Timestamp const& beginTime() const noexcept;
    Timestamp const& endTime() const noexcept;

    void setRangeSetID(unsigned const id) const;
    unsigned rangeSetID() const noexcept;

    bool mergeAuxiliary(SubRunAuxiliary const&);

  private:
    SubRunAuxiliary(SubRunID const& id,
                    Timestamp beginTime,
                    Timestamp endTime,
                    ProcessHistoryID processHistoryID,
                    unsigned rangeSetID);

    mutable ProcessHistoryID processHistoryID_{};
    mutable unsigned rangeSetID_{-1u};
    SubRunID id_{};
    Timestamp beginTime_{};
    Timestamp endTime_{};
  };

  std::ostream& operator<<(std::ostream&, SubRunAuxiliary const&);

} // namespace art

#endif /* canvas_Persistency_Provenance_SubRunAuxiliary_h */

// Local Variables:
// mode: c++
// End: