art::RunAuxiliary Class Reference

#include "RunAuxiliary.h"

Public Member Functions
	RunAuxiliary ()
	RunAuxiliary (RunID const &theId, Timestamp const &theTime, Timestamp const &theEndTime)
	RunAuxiliary (RunNumber_t const &run, Timestamp const &theTime, Timestamp const &theEndTime)
RunAuxiliary	duplicateWith (Timestamp beginTime, Timestamp endTime={}) const
void	write (std::ostream &) const
ProcessHistoryID const &	processHistoryID () const noexcept
void	setProcessHistoryID (ProcessHistoryID const &)
unsigned	rangeSetID () const noexcept
void	setRangeSetID (unsigned const id) const
RunID const &	id () const noexcept
RunID const &	runID () const noexcept
void	runID (RunID const &)
RunNumber_t	run () const noexcept
Timestamp const &	beginTime () const noexcept
Timestamp const &	endTime () const noexcept
bool	mergeAuxiliary (RunAuxiliary const &)

Static Public Attributes
static constexpr BranchType	branch_type = InRun

Private Member Functions
void	mergeNewTimestampsIntoThis_ (RunAuxiliary const &)
	RunAuxiliary (RunID id, Timestamp beginTime, Timestamp endTime, ProcessHistoryID processHistoryID, unsigned rangeSetID)

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

Detailed Description

Definition at line 17 of file RunAuxiliary.h.

Constructor & Destructor Documentation

art::RunAuxiliary::RunAuxiliary ( )

default

art::RunAuxiliary::RunAuxiliary	(	RunID const &	theId,
		Timestamp const &	theTime,
		Timestamp const &	theEndTime
	)

Definition at line 18 of file RunAuxiliary.cc.

References beginTime_, and endTime_.

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

art::RunAuxiliary::RunAuxiliary	(	RunNumber_t const &	run,
		Timestamp const &	theTime,
		Timestamp const &	theEndTime
	)

Definition at line 24 of file RunAuxiliary.cc.

    : RunAuxiliary{RunID{run}, theTime, theEndTime}
  {}

art::RunAuxiliary::RunAuxiliary ( RunID  id, Timestamp  beginTime, Timestamp  endTime, ProcessHistoryID  processHistoryID, unsigned  rangeSetID  )

private

Definition at line 31 of file RunAuxiliary.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::RunAuxiliary::beginTime ( ) const

noexcept

Definition at line 70 of file RunAuxiliary.cc.

References beginTime_.

Referenced by art::RunPrincipal::beginTime(), duplicateWith(), mergeNewTimestampsIntoThis_(), and RunAuxiliary().

  {
    return beginTime_;
  }

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

Definition at line 44 of file RunAuxiliary.cc.

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

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

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

noexcept

Definition at line 76 of file RunAuxiliary.cc.

References endTime_.

Referenced by duplicateWith(), art::RunPrincipal::endTime(), mergeNewTimestampsIntoThis_(), and RunAuxiliary().

  {
    return endTime_;
  }

RunID const & art::RunAuxiliary::id ( ) const

noexcept

Definition at line 64 of file RunAuxiliary.cc.

References id_.

Referenced by mergeAuxiliary(), art::RunPrincipal::runID(), runID(), and setRangeSetID().

  {
    return id_;
  }

bool art::RunAuxiliary::mergeAuxiliary

(

RunAuxiliary const &

newAux

)

Definition at line 119 of file RunAuxiliary.cc.

References id(), id_, and mergeNewTimestampsIntoThis_().

  {
    mergeNewTimestampsIntoThis_(newAux);
    // 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.
    return id_ == newAux.id();
  }

void art::RunAuxiliary::mergeNewTimestampsIntoThis_ ( RunAuxiliary const &  newAux )

private

Definition at line 133 of file RunAuxiliary.cc.

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

Referenced by mergeAuxiliary().

  {
    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();
    }
  }

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

noexcept

Definition at line 52 of file RunAuxiliary.cc.

References processHistoryID_.

Referenced by art::RunPrincipal::RunPrincipal().

  {
    return processHistoryID_;
  }

unsigned art::RunAuxiliary::rangeSetID ( ) const

noexcept

Definition at line 58 of file RunAuxiliary.cc.

References rangeSetID_.

Referenced by RunAuxiliary().

  {
    return rangeSetID_;
  }

RunNumber_t art::RunAuxiliary::run ( ) const

noexcept

Definition at line 100 of file RunAuxiliary.cc.

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

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

  {
    return id_.run();
  }

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

noexcept

Definition at line 88 of file RunAuxiliary.cc.

References id_.

  {
    return id_;
  }

void art::RunAuxiliary::runID

(

RunID const &

id

)

Definition at line 94 of file RunAuxiliary.cc.

References id(), and id_.

  {
    id_ = id;
  }

void art::RunAuxiliary::setProcessHistoryID

(

ProcessHistoryID const &

phid

)

Definition at line 82 of file RunAuxiliary.cc.

References processHistoryID_.

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

  {
    processHistoryID_ = phid;
  }

void art::RunAuxiliary::setRangeSetID

(

unsigned const

id

)

const

Definition at line 106 of file RunAuxiliary.cc.

References id(), and rangeSetID_.

  {
    rangeSetID_ = id;
  }

void art::RunAuxiliary::write

(

std::ostream &

os

)

const

Definition at line 112 of file RunAuxiliary.cc.

References id_, and processHistoryID_.

Referenced by art::operator<<().

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

Member Data Documentation

Timestamp art::RunAuxiliary::beginTime_ {}

private

Definition at line 63 of file RunAuxiliary.h.

Referenced by beginTime(), mergeNewTimestampsIntoThis_(), and RunAuxiliary().

constexpr BranchType art::RunAuxiliary::branch_type = InRun

static

Definition at line 19 of file RunAuxiliary.h.

Timestamp art::RunAuxiliary::endTime_ {}

private

Definition at line 64 of file RunAuxiliary.h.

Referenced by endTime(), mergeNewTimestampsIntoThis_(), and RunAuxiliary().

RunID art::RunAuxiliary::id_ {}

private

Definition at line 62 of file RunAuxiliary.h.

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

ProcessHistoryID art::RunAuxiliary::processHistoryID_ {}

mutableprivate

Definition at line 60 of file RunAuxiliary.h.

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

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

mutableprivate

Definition at line 61 of file RunAuxiliary.h.

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

---

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

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