art::SubRunID Class Reference

#include "SubRunID.h"

Classes
struct	FlushFlag

Public Member Functions
constexpr	SubRunID () noexcept
	SubRunID (RunID rID, SubRunNumber_t srID)
	SubRunID (RunNumber_t rID, SubRunNumber_t srID)
RunID const &	runID () const
RunNumber_t	run () const
SubRunNumber_t	subRun () const
bool	isValid () const
bool	isFlush () const
SubRunID	next () const
SubRunID	nextRun () const
SubRunID	previous () const
SubRunID	previousRun () const
bool	operator== (SubRunID const &other) const
bool	operator!= (SubRunID const &other) const
bool	operator< (SubRunID const &other) const
bool	operator<= (SubRunID const &other) const
bool	operator> (SubRunID const &other) const
bool	operator>= (SubRunID const &other) const

Static Public Member Functions
static SubRunID	maxSubRun ()
static SubRunID	firstSubRun ()
static SubRunID	firstSubRun (RunID const &rID)
static SubRunID	invalidSubRun (RunID const &rID)
static constexpr SubRunID	flushSubRun () noexcept
static SubRunID	flushSubRun (RunID const &rID)

Private Member Functions
constexpr	SubRunID (FlushFlag) noexcept
	SubRunID (RunID rID, FlushFlag)
SubRunNumber_t	inRangeOrInvalid (SubRunNumber_t sr)
void	checkSane ()

Private Attributes
RunID	run_
SubRunNumber_t	subRun_

Friends
std::ostream &	operator<< (std::ostream &os, SubRunID const &iID)

Detailed Description

Definition at line 19 of file SubRunID.h.

Constructor & Destructor Documentation

constexpr art::SubRunID::SubRunID ( )

inlinenoexcept

Definition at line 68 of file SubRunID.h.

Referenced by next(), and previous().

  : run_(), subRun_(IDNumber<Level::SubRun>::invalid())
{}

art::SubRunID::SubRunID ( RunID  rID, SubRunNumber_t  srID  )

inline

Definition at line 235 of file SubRunID.h.

References checkSane().

  : run_(std::move(rID)), subRun_(inRangeOrInvalid(srID))
{
  checkSane();
}

art::SubRunID::SubRunID ( RunNumber_t  rID, SubRunNumber_t  srID  )

inline

Definition at line 72 of file SubRunID.h.

References checkSane().

  : run_(rID), subRun_(inRangeOrInvalid(srID))
{
  checkSane();
}

constexpr art::SubRunID::SubRunID ( FlushFlag  )

inlineexplicitprivatenoexcept

Definition at line 227 of file SubRunID.h.

  : run_(RunID::flushRun()), subRun_(IDNumber<Level::SubRun>::flush_value())
{}

art::SubRunID::SubRunID ( RunID  rID, FlushFlag    )

inlineprivate

Definition at line 231 of file SubRunID.h.

  : run_(std::move(rID)), subRun_(IDNumber<Level::SubRun>::flush_value())
{}

Member Function Documentation

void art::SubRunID::checkSane ( )

inlineprivate

Definition at line 253 of file SubRunID.h.

References art::errors::InvalidNumber, art::RunID::isValid(), isValid(), and run_.

Referenced by SubRunID().

{
  if (isValid() && !run_.isValid()) {
    throw art::Exception(art::errors::InvalidNumber)
      << "SubRunID is not meaningful with valid subRun and invalid Run.\n";
  }
}

art::SubRunID art::SubRunID::firstSubRun ( )

inlinestatic

Definition at line 153 of file SubRunID.h.

References art::RunID::firstRun().

Referenced by art::EmptyEvent::EmptyEvent(), art::FileIndex::findEventForUnspecifiedSubRun(), and art::EventID::firstEvent().

{
  return SubRunID{RunID::firstRun(), IDNumber<Level::SubRun>::first()};
}

art::SubRunID art::SubRunID::firstSubRun ( RunID const &  rID )

inlinestatic

Definition at line 159 of file SubRunID.h.

{
  return SubRunID{rID, IDNumber<Level::SubRun>::first()};
}

constexpr art::SubRunID art::SubRunID::flushSubRun ( )

inlinestaticnoexcept

Definition at line 171 of file SubRunID.h.

Referenced by fluxr::PPFXFluxReader::closeCurrentFile().

{
  return SubRunID{FlushFlag()};
}

art::SubRunID art::SubRunID::flushSubRun ( RunID const &  rID )

inlinestatic

Definition at line 177 of file SubRunID.h.

{
  return SubRunID{rID, FlushFlag()};
}

art::SubRunNumber_t art::SubRunID::inRangeOrInvalid ( SubRunNumber_t  sr )

inlineprivate

Definition at line 242 of file SubRunID.h.

References art::errors::InvalidNumber.

{
  if (sr == IDNumber<Level::SubRun>::flush_value()) {
    throw Exception(errors::InvalidNumber)
      << "Attempt to construct SubRunID with an invalid number.\n"
      << "Maybe you want SubRunID::flushSubRun()?\n";
  }
  return sr;
}

art::SubRunID art::SubRunID::invalidSubRun ( RunID const &  rID )

inlinestatic

Definition at line 165 of file SubRunID.h.

Referenced by art::Sampled< T >::get(), art::EventID::invalidEvent(), and evdb::EventDisplay::postProcessEvent().

{
  return SubRunID{rID, IDNumber<Level::SubRun>::invalid()};
}

bool art::SubRunID::isFlush ( ) const

inline

Definition at line 103 of file SubRunID.h.

References subRun_.

Referenced by art::EventIDMatcher::match(), and art::operator<<().

{
  return subRun_ == IDNumber<Level::SubRun>::flush_value();
}

bool art::SubRunID::isValid ( ) const

inline

Definition at line 97 of file SubRunID.h.

References art::RunID::isValid(), run_, and subRun_.

Referenced by checkSane(), art::FileIndex::findEventForUnspecifiedSubRun(), art::FileIndex::Element::getEntryType(), art::EventID::isValid(), art::EventIDMatcher::match(), next(), art::EmptyEvent::nextItemType_(), art::operator<<(), previous(), art::FileStatsCollector::recordSubRun(), art::PostCloseFileRenamer::subFilledNumericNoIndex_(), and art::Source< T >::throwIfInsane_().

{
  return (subRun_ != IDNumber<Level::SubRun>::invalid() && run_.isValid());
}

art::SubRunID art::SubRunID::maxSubRun ( )

inlinestatic

Definition at line 147 of file SubRunID.h.

References art::RunID::maxRun().

Referenced by art::EventID::maxEvent().

{
  return SubRunID{RunID::maxRun(), IDNumber<Level::SubRun>::max_natural()};
}

art::SubRunID art::SubRunID::next ( ) const

inline

Definition at line 111 of file SubRunID.h.

References art::errors::InvalidNumber, isValid(), nextRun(), run_, subRun_, and SubRunID().

Referenced by art::FileIndex::findEventForUnspecifiedSubRun(), and art::EventID::nextSubRun().

{
  if (!isValid()) {
    throw art::Exception(art::errors::InvalidNumber)
      << "cannot increment invalid subrun number.";
  } else if (subRun_ == IDNumber<Level::SubRun>::max_natural()) {
    return nextRun();
  }
  return SubRunID(run_, subRun_ + 1);
}

art::SubRunID art::SubRunID::nextRun ( ) const

inline

Definition at line 123 of file SubRunID.h.

References art::RunID::next(), and run_.

Referenced by next(), and art::EventID::nextRun().

{
  return SubRunID{run_.next(), IDNumber<Level::SubRun>::first()};
}

bool art::SubRunID::operator!= ( SubRunID const &  other ) const

inline

Definition at line 190 of file SubRunID.h.

References fhicl::other.

{
  return !(*this == other);
}

bool art::SubRunID::operator< ( SubRunID const &  other ) const

inline

Definition at line 198 of file SubRunID.h.

References run_, and subRun_.

{
  constexpr SortInvalidFirst<SubRunNumber_t> op{
    IDNumber<Level::SubRun>::invalid()};
  if (run_ == other.run_) {
    return op(subRun_, other.subRun_);
  } else {
    return run_ < other.run_;
  }
}

bool art::SubRunID::operator<= ( SubRunID const &  other ) const

inline

Definition at line 210 of file SubRunID.h.

References fhicl::other.

{
  return (*this < other) || (*this == other);
}

bool art::SubRunID::operator== ( SubRunID const &  other ) const

inline

Definition at line 184 of file SubRunID.h.

References run_, and subRun_.

{
  return other.run_ == run_ && other.subRun_ == subRun_;
}

bool art::SubRunID::operator> ( SubRunID const &  other ) const

inline

Definition at line 216 of file SubRunID.h.

{
  return (other < *this);
}

bool art::SubRunID::operator>= ( SubRunID const &  other ) const

inline

Definition at line 222 of file SubRunID.h.

References fhicl::other.

{
  return !(*this < other);
}

art::SubRunID art::SubRunID::previous ( ) const

inline

Definition at line 129 of file SubRunID.h.

References art::errors::InvalidNumber, isValid(), previousRun(), run_, subRun_, and SubRunID().

Referenced by art::EventID::previousSubRun().

{
  if (!isValid()) {
    throw art::Exception(art::errors::InvalidNumber)
      << "cannot decrement invalid subrun number.";
  } else if (subRun_ == IDNumber<Level::SubRun>::first()) {
    return previousRun();
  }
  return SubRunID(run_, subRun_ - 1);
}

art::SubRunID art::SubRunID::previousRun ( ) const

inline

Definition at line 141 of file SubRunID.h.

References art::RunID::previous(), and run_.

Referenced by previous(), and art::EventID::previousRun().

{
  return SubRunID{run_.previous(), IDNumber<Level::SubRun>::max_natural()};
}

art::RunNumber_t art::SubRunID::run ( ) const

inline

Definition at line 85 of file SubRunID.h.

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

Referenced by art::EmptyEvent::EmptyEvent(), art::RangeSet::forSubRun(), fluxr::PPFXFluxReader::readNext(), lris::LArRawInputDriverLongBo::readNext(), lris::LArRawInputDriverShortBo::readNext(), lris::LArRawInputDriver::readNext(), art::EventID::run(), art::SubRunAuxiliary::run(), and art::SubRun::run().

{
  return run_.run();
}

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

inline

Definition at line 79 of file SubRunID.h.

References run_.

Referenced by fluxr::PPFXFluxReader::readNext(), art::FileStatsCollector::recordRun(), art::EventID::runID(), art::SubRunAuxiliary::runID(), and art::Source< T >::throwIfInsane_().

{
  return run_;
}

art::SubRunNumber_t art::SubRunID::subRun ( ) const

inline

Definition at line 91 of file SubRunID.h.

References subRun_.

Referenced by art::EmptyEvent::EmptyEvent(), art::RangeSet::forSubRun(), fluxr::PPFXFluxReader::readNext(), lris::LArRawInputDriverShortBo::readNext(), lris::LArRawInputDriverLongBo::readNext(), lris::LArRawInputDriver::readNext(), art::PostCloseFileRenamer::subFilledNumericNoIndex_(), art::EventID::subRun(), art::SubRunAuxiliary::subRun(), and art::SubRun::subRun().

{
  return subRun_;
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, SubRunID const &  iID  )

friend

Member Data Documentation

RunID art::SubRunID::run_

private

Definition at line 64 of file SubRunID.h.

Referenced by checkSane(), isValid(), next(), nextRun(), operator<(), art::operator<<(), operator==(), previous(), previousRun(), run(), and runID().

SubRunNumber_t art::SubRunID::subRun_

private

Definition at line 65 of file SubRunID.h.

Referenced by isFlush(), isValid(), next(), operator<(), art::operator<<(), operator==(), previous(), and subRun().

---

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

• canvas/Persistency/Provenance/SubRunID.h