art::SubRunAuxiliary Class Reference

#include "SubRunAuxiliary.h"

Public Member Functions
	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 &)

Static Public Attributes
static constexpr BranchType	branch_type = InSubRun

Private Member Functions
	SubRunAuxiliary (SubRunID const &id, Timestamp beginTime, Timestamp endTime, ProcessHistoryID processHistoryID, unsigned rangeSetID)

Private Attributes
ProcessHistoryID	processHistoryID_ {}
unsigned	rangeSetID_ {-1u}
SubRunID	id_ {}
Timestamp	beginTime_ {}
Timestamp	endTime_ {}

Detailed Description

Definition at line 17 of file SubRunAuxiliary.h.

Constructor & Destructor Documentation

art::SubRunAuxiliary::SubRunAuxiliary ( )

default

art::SubRunAuxiliary::SubRunAuxiliary	(	SubRunID const &	theId,
		Timestamp	beginTime,
		Timestamp	endTime
	)

Definition at line 13 of file SubRunAuxiliary.cc.

References beginTime_, and endTime_.

    : id_{theId}, beginTime_{theTime}, endTime_{theEndTime}
  {}

art::SubRunAuxiliary::SubRunAuxiliary	(	RunNumber_t	run,
		SubRunNumber_t	subrun,
		Timestamp	beginTime,
		Timestamp	endTime
	)

Definition at line 19 of file SubRunAuxiliary.cc.

    : SubRunAuxiliary{SubRunID{theRun, theSubRun}, theTime, theEndTime}
  {}

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

private

Definition at line 27 of file SubRunAuxiliary.cc.

References beginTime(), beginTime_, endTime(), endTime_, id_, rangeSetID(), and rangeSetID_.

    : processHistoryID_{processHistoryID}
    , rangeSetID_{rangeSetID}
    , id_{id}
    , beginTime_{beginTime}
    , endTime_{endTime}
  {}

Member Function Documentation

Timestamp const & art::SubRunAuxiliary::beginTime ( ) const

noexcept

Definition at line 90 of file SubRunAuxiliary.cc.

References beginTime_.

Referenced by art::SubRunPrincipal::beginTime(), duplicateWith(), mergeAuxiliary(), and SubRunAuxiliary().

  {
    return beginTime_;
  }

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

Definition at line 40 of file SubRunAuxiliary.cc.

References beginTime(), endTime(), id_, processHistoryID_, and rangeSetID_.

  {
    return SubRunAuxiliary{
      id_, beginTime, endTime, processHistoryID_, rangeSetID_};
  }

Timestamp const & art::SubRunAuxiliary::endTime ( ) const

noexcept

Definition at line 96 of file SubRunAuxiliary.cc.

References endTime_.

Referenced by duplicateWith(), art::SubRunPrincipal::endTime(), mergeAuxiliary(), and SubRunAuxiliary().

  {
    return endTime_;
  }

SubRunID const & art::SubRunAuxiliary::id ( ) const

noexcept

Definition at line 60 of file SubRunAuxiliary.cc.

References id_.

Referenced by mergeAuxiliary(), setRangeSetID(), and art::SubRunPrincipal::subRunID().

  {
    return id_;
  }

bool art::SubRunAuxiliary::mergeAuxiliary

(

SubRunAuxiliary const &

newAux

)

Definition at line 121 of file SubRunAuxiliary.cc.

References beginTime(), beginTime_, endTime(), endTime_, id(), id_, and art::Timestamp::invalidTimestamp().

  {
    if ((beginTime_ == Timestamp::invalidTimestamp()) ||
        (newAux.beginTime() == Timestamp::invalidTimestamp())) {
      beginTime_ = Timestamp::invalidTimestamp();
    } else if (newAux.beginTime() < beginTime_) {
      beginTime_ = newAux.beginTime();
    }
    if ((endTime_ == Timestamp::invalidTimestamp()) ||
        (newAux.endTime() == Timestamp::invalidTimestamp())) {
      endTime_ = Timestamp::invalidTimestamp();
    } else if (newAux.endTime() > endTime_) {
      endTime_ = newAux.endTime();
    }
    // Keep the process history ID that is in the preexisting principal
    // It may have been updated to include the current process.
    // There is one strange other case where the two ProcessHistoryIDs
    // could be different which should not be important and we just ignore.
    // There could have been previous processes which only dropped products.
    // These processes could have dropped the same branches but had different
    // process names ... Ignore this.
    if (id_ != newAux.id()) {
      return false;
    }
    return true;
  }

ProcessHistoryID const & art::SubRunAuxiliary::processHistoryID ( ) const

noexcept

Definition at line 48 of file SubRunAuxiliary.cc.

References processHistoryID_.

Referenced by art::SubRunPrincipal::SubRunPrincipal().

  {
    return processHistoryID_;
  }

unsigned art::SubRunAuxiliary::rangeSetID ( ) const

noexcept

Definition at line 108 of file SubRunAuxiliary.cc.

References rangeSetID_.

Referenced by SubRunAuxiliary().

  {
    return rangeSetID_;
  }

RunNumber_t art::SubRunAuxiliary::run ( ) const

noexcept

Definition at line 78 of file SubRunAuxiliary.cc.

References id_, and art::SubRunID::run().

Referenced by art::SubRunPrincipal::run().

  {
    return id_.run();
  }

RunID const & art::SubRunAuxiliary::runID ( ) const

noexcept

Definition at line 72 of file SubRunAuxiliary.cc.

References id_, and art::SubRunID::runID().

Referenced by art::SubRunPrincipal::runID().

  {
    return id_.runID();
  }

void art::SubRunAuxiliary::setProcessHistoryID

(

ProcessHistoryID const &

phid

)

Definition at line 54 of file SubRunAuxiliary.cc.

References processHistoryID_.

Referenced by art::SubRunPrincipal::createGroupsForProducedProducts().

  {
    processHistoryID_ = phid;
  }

void art::SubRunAuxiliary::setRangeSetID

(

unsigned const

id

)

const

Definition at line 102 of file SubRunAuxiliary.cc.

References id(), and rangeSetID_.

  {
    rangeSetID_ = id;
  }

SubRunNumber_t art::SubRunAuxiliary::subRun ( ) const

noexcept

Definition at line 84 of file SubRunAuxiliary.cc.

References id_, and art::SubRunID::subRun().

Referenced by art::SubRunPrincipal::subRun().

  {
    return id_.subRun();
  }

SubRunID const & art::SubRunAuxiliary::subRunID ( ) const

noexcept

Definition at line 66 of file SubRunAuxiliary.cc.

References id_.

  {
    return id_;
  }

void art::SubRunAuxiliary::write

(

std::ostream &

os

)

const

Definition at line 114 of file SubRunAuxiliary.cc.

References id_, and processHistoryID_.

Referenced by art::operator<<().

  {
    os << "Process History ID = " << processHistoryID_ << endl;
    os << id_ << endl;
  }

Member Data Documentation

Timestamp art::SubRunAuxiliary::beginTime_ {}

private

Definition at line 64 of file SubRunAuxiliary.h.

Referenced by beginTime(), mergeAuxiliary(), and SubRunAuxiliary().

constexpr BranchType art::SubRunAuxiliary::branch_type = InSubRun

static

Definition at line 19 of file SubRunAuxiliary.h.

Timestamp art::SubRunAuxiliary::endTime_ {}

private

Definition at line 65 of file SubRunAuxiliary.h.

Referenced by endTime(), mergeAuxiliary(), and SubRunAuxiliary().

SubRunID art::SubRunAuxiliary::id_ {}

private

Definition at line 63 of file SubRunAuxiliary.h.

Referenced by duplicateWith(), id(), mergeAuxiliary(), run(), runID(), subRun(), SubRunAuxiliary(), subRunID(), and write().

ProcessHistoryID art::SubRunAuxiliary::processHistoryID_ {}

mutableprivate

Definition at line 61 of file SubRunAuxiliary.h.

Referenced by duplicateWith(), processHistoryID(), setProcessHistoryID(), and write().

unsigned art::SubRunAuxiliary::rangeSetID_ {-1u}

mutableprivate

Definition at line 62 of file SubRunAuxiliary.h.

Referenced by duplicateWith(), rangeSetID(), setRangeSetID(), and SubRunAuxiliary().

---

The documentation for this class was generated from the following files:

• canvas/Persistency/Provenance/SubRunAuxiliary.h
• canvas/Persistency/Provenance/SubRunAuxiliary.cc