art::EventID Class Reference

#include <EventID.h>

Classes
struct	FlushFlag

Public Member Functions
constexpr	EventID () noexcept
	EventID (RunNumber_t r, SubRunNumber_t sr, EventNumber_t e)
	EventID (SubRunID const &sID, EventNumber_t e)
RunID const &	runID () const
RunNumber_t	run () const
SubRunID const &	subRunID () const
SubRunNumber_t	subRun () const
EventNumber_t	event () const
bool	isValid () const
bool	isFlush () const
EventID	next () const
EventID	nextSubRun (EventNumber_t first=IDNumber< Level::Event >::first()) const
EventID	nextRun () const
EventID	previous () const
EventID	previousSubRun () const
EventID	previousRun () const
bool	operator== (EventID const &other) const
bool	operator!= (EventID const &other) const
bool	operator< (EventID const &other) const
bool	operator> (EventID const &other) const
bool	operator<= (EventID const &other) const
bool	operator>= (EventID const &other) const

Static Public Member Functions
static EventID	maxEvent ()
static EventID	firstEvent ()
static EventID	firstEvent (SubRunID const &srID)
static constexpr EventID	invalidEvent () noexcept
static EventID	invalidEvent (RunID rID)
static EventID	invalidEvent (SubRunID const &srID)
static constexpr EventID	flushEvent () noexcept
static EventID	flushEvent (RunID rID)
static EventID	flushEvent (SubRunID srID)

Private Member Functions
constexpr	EventID (FlushFlag) noexcept
	EventID (RunID rID, FlushFlag)
	EventID (SubRunID srID, FlushFlag)
EventNumber_t	inRangeOrInvalid (EventNumber_t e)

Private Attributes
SubRunID	subRun_
EventNumber_t	event_

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

Detailed Description

Definition at line 20 of file EventID.h.

Constructor & Destructor Documentation

constexpr art::EventID::EventID ( )

inlinenoexcept

Definition at line 79 of file EventID.h.

  : subRun_(), event_(IDNumber<Level::Event>::invalid())
{}

art::EventID::EventID ( RunNumber_t  r, SubRunNumber_t  sr, EventNumber_t  e  )

inline

Definition at line 83 of file EventID.h.

  : subRun_(r, sr), event_(inRangeOrInvalid(e))
{}

art::EventID::EventID ( SubRunID const &  sID, EventNumber_t  e  )

inline

Definition at line 87 of file EventID.h.

  : subRun_(sID), event_(inRangeOrInvalid(e))
{}

constexpr art::EventID::EventID ( FlushFlag  )

inlineexplicitprivatenoexcept

Definition at line 282 of file EventID.h.

  : subRun_(SubRunID::flushSubRun())
  , event_(IDNumber<Level::Event>::flush_value())
{}

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

inlineprivate

Definition at line 287 of file EventID.h.

  : subRun_(SubRunID::flushSubRun(rID))
  , event_(IDNumber<Level::Event>::flush_value())
{}

art::EventID::EventID ( SubRunID  srID, FlushFlag    )

inlineprivate

Definition at line 292 of file EventID.h.

  : subRun_(std::move(srID)), event_(IDNumber<Level::Event>::flush_value())
{}

Member Function Documentation

art::EventNumber_t art::EventID::event ( ) const

inline

Definition at line 116 of file EventID.h.

{
  return event_;
}

art::EventID art::EventID::firstEvent ( )

inlinestatic

Definition at line 190 of file EventID.h.

{
  return EventID{SubRunID::firstSubRun(), IDNumber<Level::Event>::first()};
}

art::EventID art::EventID::firstEvent ( SubRunID const &  srID )

inlinestatic

Definition at line 196 of file EventID.h.

{
  return EventID{srID, IDNumber<Level::Event>::first()};
}

constexpr art::EventID art::EventID::flushEvent ( )

inlinestaticnoexcept

Definition at line 221 of file EventID.h.

{
  return EventID{FlushFlag()};
}

art::EventID art::EventID::flushEvent ( RunID  rID )

inlinestatic

Definition at line 227 of file EventID.h.

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

art::EventID art::EventID::flushEvent ( SubRunID  srID )

inlinestatic

Definition at line 233 of file EventID.h.

{
  return EventID{srID, FlushFlag()};
}

art::EventNumber_t art::EventID::inRangeOrInvalid ( EventNumber_t  e )

inlineprivate

Definition at line 297 of file EventID.h.

{
  if (e == IDNumber<Level::Event>::invalid() ||
      e <= IDNumber<Level::Event>::max_natural()) {
    return e;
  } else {
    throw Exception(errors::InvalidNumber)
      << "Attempt to construct an EventID with an invalid number.\n"
      << "Maybe you want EventID::flushEvent()?\n";
  }
}

constexpr art::EventID art::EventID::invalidEvent ( )

inlinestaticnoexcept

Definition at line 202 of file EventID.h.

{
  return EventID{};
}

art::EventID art::EventID::invalidEvent ( RunID  rID )

inlinestatic

Definition at line 208 of file EventID.h.

{
  return EventID{SubRunID::invalidSubRun(rID),
                 IDNumber<Level::Event>::invalid()};
}

art::EventID art::EventID::invalidEvent ( SubRunID const &  srID )

inlinestatic

Definition at line 215 of file EventID.h.

{
  return EventID{srID, IDNumber<Level::Event>::invalid()};
}

bool art::EventID::isFlush ( ) const

inline

Definition at line 128 of file EventID.h.

{
  return event_ == IDNumber<Level::Event>::flush_value();
}

bool art::EventID::isValid ( ) const

inline

Definition at line 122 of file EventID.h.

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

art::EventID art::EventID::maxEvent ( )

inlinestatic

Definition at line 184 of file EventID.h.

{
  return EventID{SubRunID::maxSubRun(), IDNumber<Level::Event>::max_natural()};
}

art::EventID art::EventID::next ( ) const

inline

Definition at line 134 of file EventID.h.

{
  if (!isValid()) {
    throw art::Exception{art::errors::InvalidNumber}
      << "Cannot increment invalid event number.\n";
  } else if (event_ == IDNumber<Level::Event>::max_natural()) {
    return nextSubRun();
  } else {
    return EventID{subRun_, event_ + 1u};
  }
}

art::EventID art::EventID::nextRun ( ) const

inline

Definition at line 153 of file EventID.h.

{
  return EventID{subRun_.nextRun(), IDNumber<Level::Event>::first()};
}

art::EventID art::EventID::nextSubRun ( EventNumber_t  first = IDNumber<Level::Event>::first() ) const

inline

Definition at line 147 of file EventID.h.

{
  return EventID{subRun_.next(), first};
}

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

inline

Definition at line 246 of file EventID.h.

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

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

inline

Definition at line 254 of file EventID.h.

{
  static SortInvalidFirst<EventNumber_t> op(IDNumber<Level::Event>::invalid());
  if (subRun_ == other.subRun_) {
    return op(event_, other.event_);
  } else {
    return subRun_ < other.subRun_;
  }
}

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

inline

Definition at line 271 of file EventID.h.

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

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

inline

Definition at line 240 of file EventID.h.

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

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

inline

Definition at line 265 of file EventID.h.

{
  return (other < *this);
}

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

inline

Definition at line 277 of file EventID.h.

{
  return !(*this < other);
}

art::EventID art::EventID::previous ( ) const

inline

Definition at line 159 of file EventID.h.

{
  if (!isValid()) {
    throw art::Exception(art::errors::InvalidNumber)
      << "cannot decrement invalid event number.";
  } else if (event_ == IDNumber<Level::Event>::first()) {
    return previousSubRun();
  } else {
    return EventID{subRun_, event_ - 1u};
  }
}

art::EventID art::EventID::previousRun ( ) const

inline

Definition at line 178 of file EventID.h.

{
  return EventID{subRun_.previousRun(), IDNumber<Level::Event>::max_natural()};
}

art::EventID art::EventID::previousSubRun ( ) const

inline

Definition at line 172 of file EventID.h.

{
  return EventID{subRun_.previous(), IDNumber<Level::Event>::max_natural()};
}

art::RunNumber_t art::EventID::run ( ) const

inline

Definition at line 98 of file EventID.h.

{
  return subRun_.run();
}

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

inline

Definition at line 92 of file EventID.h.

{
  return subRun_.runID();
}

art::SubRunNumber_t art::EventID::subRun ( ) const

inline

Definition at line 110 of file EventID.h.

{
  return subRun_.subRun();
}

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

inline

Definition at line 104 of file EventID.h.

{
  return subRun_;
}

Friends And Related Function Documentation

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

friend

Member Data Documentation

EventNumber_t art::EventID::event_

private

Definition at line 76 of file EventID.h.

SubRunID art::EventID::subRun_

private

Definition at line 75 of file EventID.h.

---

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

• canvas/canvas/Persistency/Provenance/EventID.h