art::RunID Class Reference

#include "RunID.h"

Classes
struct	FlushFlag

Public Member Functions
constexpr	RunID () noexcept
	RunID (RunNumber_t i)
RunNumber_t	run () const
bool	isValid () const
bool	isFlush () const
RunID	next () const
RunID	previous () const
bool	operator== (RunID const &other) const
bool	operator!= (RunID const &other) const
bool	operator< (RunID const &other) const
bool	operator<= (RunID const &other) const
bool	operator> (RunID const &other) const
bool	operator>= (RunID const &other) const

Static Public Member Functions
static RunID	maxRun ()
static RunID	firstRun ()
static constexpr RunID	flushRun () noexcept

Private Member Functions
constexpr	RunID (FlushFlag) noexcept
RunNumber_t	inRangeOrInvalid (RunNumber_t r)

Private Attributes
RunNumber_t	run_

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

Detailed Description

Definition at line 21 of file RunID.h.

Constructor & Destructor Documentation

constexpr art::RunID::RunID ( )

inlinenoexcept

Definition at line 57 of file RunID.h.

Referenced by firstRun(), flushRun(), maxRun(), next(), and previous().

  : run_(IDNumber<Level::Run>::invalid())
{}

art::RunID::RunID ( RunNumber_t  i )

inlineexplicit

Definition at line 61 of file RunID.h.

: run_(inRangeOrInvalid(i)) {}

constexpr art::RunID::RunID ( FlushFlag  )

inlineexplicitprivatenoexcept

Definition at line 181 of file RunID.h.

  : run_{IDNumber<Level::Run>::flush_value()}
{}

Member Function Documentation

art::RunID art::RunID::firstRun ( )

inlinestatic

Definition at line 116 of file RunID.h.

References RunID().

Referenced by art::EmptyEvent::EmptyEvent(), and art::SubRunID::firstSubRun().

{
  return RunID(IDNumber<Level::Run>::first());
}

constexpr art::RunID art::RunID::flushRun ( )

inlinestaticnoexcept

Definition at line 122 of file RunID.h.

References RunID().

{
  return RunID(FlushFlag());
}

art::RunNumber_t art::RunID::inRangeOrInvalid ( RunNumber_t  r )

inlineprivate

Definition at line 168 of file RunID.h.

References art::errors::InvalidNumber, and r.

{
  if (r == IDNumber<Level::Run>::invalid() ||
      (r >= IDNumber<Level::Run>::first() &&
       r <= IDNumber<Level::Run>::max_natural())) {
    return r;
  } else {
    throw Exception(errors::InvalidNumber)
      << "Attempt to construct RunID with an invalid number.\n"
      << "Maybe you want RunID::flushRun()?\n";
  }
}

bool art::RunID::isFlush ( ) const

inline

Definition at line 76 of file RunID.h.

References run_.

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

{
  return (run_ == IDNumber<Level::Run>::flush_value());
}

bool art::RunID::isValid ( ) const

inline

Definition at line 70 of file RunID.h.

References run_.

Referenced by art::SubRunID::checkSane(), art::SubRunID::isValid(), art::EventIDMatcher::match(), next(), art::EmptyEvent::nextItemType_(), art::operator<<(), previous(), art::FileStatsCollector::recordRun(), art::PostCloseFileRenamer::subFilledNumericNoIndex_(), and art::Source< T >::throwIfInsane_().

{
  return (run_ != IDNumber<Level::Run>::invalid());
}

art::RunID art::RunID::maxRun ( )

inlinestatic

Definition at line 110 of file RunID.h.

References RunID().

Referenced by art::SubRunID::maxSubRun().

{
  return RunID(IDNumber<Level::Run>::max_natural());
}

art::RunID art::RunID::next ( ) const

inline

Definition at line 84 of file RunID.h.

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

Referenced by art::SubRunID::nextRun().

{
  if (!isValid()) {
    throw Exception(errors::InvalidNumber)
      << "cannot increment invalid run number.";
  } else if (run_ == IDNumber<Level::Run>::max_natural()) {
    throw Exception(errors::InvalidNumber)
      << "cannot increment maximum run number.";
  }
  return RunID(run_ + 1);
}

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

inline

Definition at line 135 of file RunID.h.

References fhicl::other.

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

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

inline

Definition at line 143 of file RunID.h.

References run_.

{
  static SortInvalidFirst<RunNumber_t> op(IDNumber<Level::Run>::invalid());
  return op(run_, other.run_);
}

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

inline

Definition at line 150 of file RunID.h.

References fhicl::other.

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

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

inline

Definition at line 129 of file RunID.h.

References run_.

{
  return other.run_ == run_;
}

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

inline

Definition at line 156 of file RunID.h.

{
  return (other < *this);
}

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

inline

Definition at line 162 of file RunID.h.

References fhicl::other.

{
  return !(*this < other);
}

art::RunID art::RunID::previous ( ) const

inline

Definition at line 97 of file RunID.h.

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

Referenced by art::SubRunID::previousRun().

{
  if (!isValid()) {
    throw Exception(errors::InvalidNumber)
      << "cannot decrement minimum run number.";
  } else if (run_ == IDNumber<Level::Run>::max_natural()) {
    throw Exception(errors::InvalidNumber)
      << "cannot increment maximum run number.";
  }
  return RunID(run_ - 1);
}

art::RunNumber_t art::RunID::run ( ) const

inline

Definition at line 64 of file RunID.h.

References run_.

Referenced by artg4tk::artg4tkMain::beginRun(), larg4::larg4Main::beginRun(), art::EmptyEvent::EmptyEvent(), art::RangeSet::forRun(), art::SubRunID::run(), art::RunAuxiliary::run(), art::Run::run(), and art::PostCloseFileRenamer::subFilledNumericNoIndex_().

{
  return run_;
}

Friends And Related Function Documentation

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

friend

Member Data Documentation

RunNumber_t art::RunID::run_

private

Definition at line 54 of file RunID.h.

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

---

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

• canvas/Persistency/Provenance/RunID.h