art::SubRunAuxiliary Class Reference

#include "SubRunAuxiliary.h"

Public Member Functions
	SubRunAuxiliary ()=default
	SubRunAuxiliary (SubRunID const &theId, Timestamp const &theTime, Timestamp const &theEndTime)
	SubRunAuxiliary (RunNumber_t const theRun, SubRunNumber_t const theSubRun, Timestamp const &theTime, Timestamp const &theEndTime)
void	write (std::ostream &os) const
ProcessHistoryID const &	processHistoryID () const
void	setProcessHistoryID (ProcessHistoryID const &phid) const
SubRunID const &	id () const
RunID const &	runID () const
RunNumber_t	run () const
SubRunNumber_t	subRun () const
Timestamp const &	beginTime () const
Timestamp const &	endTime () const
void	setEndTime (Timestamp const &time)
void	setRangeSetID (unsigned const id) const
auto	rangeSetID () const
bool	mergeAuxiliary (SubRunAuxiliary const &newAux)

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

Static Public Attributes
static constexpr BranchType	branch_type = InSubRun

Detailed Description

Definition at line 18 of file SubRunAuxiliary.h.

Constructor & Destructor Documentation

art::SubRunAuxiliary::SubRunAuxiliary ( )

default

art::SubRunAuxiliary::SubRunAuxiliary ( SubRunID const &  theId, Timestamp const &  theTime, Timestamp const &  theEndTime  )

inline

Definition at line 24 of file SubRunAuxiliary.h.

References beginTime_, and endTime_.

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

art::SubRunAuxiliary::SubRunAuxiliary ( RunNumber_t const  theRun, SubRunNumber_t const  theSubRun, Timestamp const &  theTime, Timestamp const &  theEndTime  )

inline

Definition at line 30 of file SubRunAuxiliary.h.

References beginTime_, endTime_, and write().

    : id_{theRun, theSubRun}, beginTime_{theTime}, endTime_{theEndTime}
  {}

Member Function Documentation

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

inline

Definition at line 73 of file SubRunAuxiliary.h.

References beginTime_.

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

  {
    return beginTime_;
  }

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

inline

Definition at line 79 of file SubRunAuxiliary.h.

References endTime_.

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

  {
    return endTime_;
  }

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

inline

Definition at line 52 of file SubRunAuxiliary.h.

References id_.

Referenced by art::SubRun::id(), art::SubRunPrincipal::id(), mergeAuxiliary(), setRangeSetID(), and art::RootOutputFile::writeSubRun().

  {
    return id_;
  }

bool art::SubRunAuxiliary::mergeAuxiliary

(

SubRunAuxiliary const &

newAux

)

Definition at line 12 of file SubRunAuxiliary.cc.

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

Referenced by rangeSetID().

{
  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

inline

Definition at line 40 of file SubRunAuxiliary.h.

References processHistoryID_.

  {
    return processHistoryID_;
  }

auto art::SubRunAuxiliary::rangeSetID ( ) const

inline

Definition at line 97 of file SubRunAuxiliary.h.

References mergeAuxiliary(), and rangeSetID_.

  {
    return rangeSetID_;
  }

RunNumber_t art::SubRunAuxiliary::run ( ) const

inline

Definition at line 62 of file SubRunAuxiliary.h.

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

Referenced by art::SubRun::run(), and art::SubRunPrincipal::run().

  {
    return id_.run();
  }

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

inline

Definition at line 57 of file SubRunAuxiliary.h.

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

  {
    return id_.runID();
  }

void art::SubRunAuxiliary::setEndTime ( Timestamp const &  time )

inline

Definition at line 85 of file SubRunAuxiliary.h.

References endTime_, and art::Timestamp::invalidTimestamp().

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

  {
    if (endTime_ == Timestamp::invalidTimestamp())
      endTime_ = time;
  }

void art::SubRunAuxiliary::setProcessHistoryID ( ProcessHistoryID const &  phid ) const

inline

Definition at line 46 of file SubRunAuxiliary.h.

References processHistoryID_.

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

  {
    processHistoryID_ = phid;
  }

void art::SubRunAuxiliary::setRangeSetID ( unsigned const  id ) const

inline

Definition at line 92 of file SubRunAuxiliary.h.

References id(), and rangeSetID_.

Referenced by art::RootOutputFile::writeSubRun().

  {
    rangeSetID_ = id;
  }

SubRunNumber_t art::SubRunAuxiliary::subRun ( ) const

inline

Definition at line 67 of file SubRunAuxiliary.h.

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

Referenced by art::SubRun::subRun(), and art::SubRunPrincipal::subRun().

  {
    return id_.subRun();
  }

void art::SubRunAuxiliary::write

(

std::ostream &

os

)

const

Definition at line 5 of file SubRunAuxiliary.cc.

References id_, and processHistoryID_.

Referenced by operator<<(), and SubRunAuxiliary().

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

Member Data Documentation

Timestamp art::SubRunAuxiliary::beginTime_ {}

Definition at line 111 of file SubRunAuxiliary.h.

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

constexpr BranchType art::SubRunAuxiliary::branch_type = InSubRun

static

Definition at line 20 of file SubRunAuxiliary.h.

Timestamp art::SubRunAuxiliary::endTime_ {}

Definition at line 112 of file SubRunAuxiliary.h.

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

SubRunID art::SubRunAuxiliary::id_ {}

Definition at line 109 of file SubRunAuxiliary.h.

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

ProcessHistoryID art::SubRunAuxiliary::processHistoryID_ {}

mutable

Definition at line 106 of file SubRunAuxiliary.h.

Referenced by processHistoryID(), art::SubRunPrincipal::processHistoryID(), setProcessHistoryID(), art::SubRunPrincipal::SubRunPrincipal(), and write().

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

mutable

Definition at line 107 of file SubRunAuxiliary.h.

Referenced by rangeSetID(), and setRangeSetID().

---

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

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