art::EventRange Class Reference

#include <EventRange.h>

Public Member Functions
	~EventRange () noexcept
	EventRange () noexcept
	EventRange (SubRunNumber_t s, EventNumber_t begin, EventNumber_t end)
	EventRange (EventRange const &) noexcept
	EventRange (EventRange &&) noexcept
EventRange &	operator= (EventRange const &) noexcept
EventRange &	operator= (EventRange &&) noexcept
bool	operator< (EventRange const &other) const noexcept
bool	operator== (EventRange const &other) const noexcept
bool	operator!= (EventRange const &other) const noexcept
SubRunNumber_t	subRun () const noexcept
EventNumber_t	begin () const noexcept
EventNumber_t	end () const noexcept
unsigned long long	size () const noexcept
bool	empty () const noexcept
bool	is_valid () const noexcept
bool	is_full_subRun () const noexcept
bool	contains (SubRunNumber_t s, EventNumber_t e) const noexcept
bool	is_same (EventRange const &other) const noexcept
bool	is_adjacent (EventRange const &other) const noexcept
bool	is_disjoint (EventRange const &other) const noexcept
bool	is_subset (EventRange const &other) const noexcept
bool	is_superset (EventRange const &other) const noexcept
bool	is_overlapping (EventRange const &other) const noexcept
bool	merge (EventRange const &other)
void	set_end (EventNumber_t const e)

Static Public Member Functions
static EventRange	invalid () noexcept
static EventRange	forSubRun (SubRunNumber_t s) noexcept
static bool	are_valid (EventRange const &l, EventRange const &r) noexcept

Private Member Functions
void	require_not_full_SubRun () const

Private Attributes
SubRunNumber_t	subRun_ {IDNumber<Level::SubRun>::invalid()}
EventNumber_t	begin_ {IDNumber<Level::Event>::invalid()}
EventNumber_t	end_ {IDNumber<Level::Event>::invalid()}

Detailed Description

Definition at line 17 of file EventRange.h.

Constructor & Destructor Documentation

art::EventRange::~EventRange ( )

defaultnoexcept

art::EventRange::EventRange ( )

explicitdefaultnoexcept

art::EventRange::EventRange ( SubRunNumber_t  s, EventNumber_t  begin, EventNumber_t  end  )

explicit

Definition at line 52 of file EventRange.cc.

    : subRun_{s}, begin_{b}, end_{e}
  {
    require_ordering(begin_, end_);
  }

art::EventRange::EventRange ( EventRange const &  )

defaultnoexcept

art::EventRange::EventRange ( EventRange &&  )

defaultnoexcept

Member Function Documentation

bool art::EventRange::are_valid ( EventRange const &  l, EventRange const &  r  )

staticnoexcept

Definition at line 44 of file EventRange.cc.

  {
    return l.is_valid() && r.is_valid();
  }

EventNumber_t art::EventRange::begin ( ) const

noexcept

Definition at line 105 of file EventRange.cc.

  {
    return begin_;
  }

bool art::EventRange::contains ( SubRunNumber_t  s, EventNumber_t  e  ) const

noexcept

Definition at line 136 of file EventRange.cc.

  {
    return (subRun_ == s) && (e >= begin_) && (e < end_);
  }

bool art::EventRange::empty ( ) const

noexcept

Definition at line 99 of file EventRange.cc.

  {
    return begin_ == end_;
  }

EventNumber_t art::EventRange::end ( ) const

noexcept

Definition at line 111 of file EventRange.cc.

  {
    return end_;
  }

EventRange art::EventRange::forSubRun ( SubRunNumber_t  s )

staticnoexcept

Definition at line 37 of file EventRange.cc.

  {
    return EventRange{s, 0, IDNumber<Level::Event>::invalid()};
  }

EventRange art::EventRange::invalid ( )

staticnoexcept

Definition at line 30 of file EventRange.cc.

  {
    return EventRange{};
  }

bool art::EventRange::is_adjacent ( EventRange const &  other ) const

noexcept

Definition at line 152 of file EventRange.cc.

  {
    if (!are_valid(*this, other)) {
      return false;
    }
    return (subRun_ == other.subRun_) && (end_ == other.begin_);
  }

bool art::EventRange::is_disjoint ( EventRange const &  other ) const

noexcept

Definition at line 161 of file EventRange.cc.

  {
    if (!are_valid(*this, other)) {
      return false;
    }
    return (subRun_ == other.subRun_) ? (end_ <= other.begin_) : true;
  }

bool art::EventRange::is_full_subRun ( ) const

noexcept

Definition at line 129 of file EventRange.cc.

  {
    return ::art::is_valid(subRun_) && (begin_ == 0) &&
           (end_ == IDNumber<Level::Event>::invalid());
  }

bool art::EventRange::is_overlapping ( EventRange const &  other ) const

noexcept

Definition at line 190 of file EventRange.cc.

  {
    if (!are_valid(*this, other)) {
      return false;
    }
    return !is_disjoint(other) && !is_subset(other) && !is_superset(other);
  }

bool art::EventRange::is_same ( EventRange const &  other ) const

noexcept

Definition at line 143 of file EventRange.cc.

  {
    if (!are_valid(*this, other)) {
      return false;
    }
    return operator==(other);
  }

bool art::EventRange::is_subset ( EventRange const &  other ) const

noexcept

Definition at line 170 of file EventRange.cc.

  {
    if (!are_valid(*this, other)) {
      return false;
    }
    return (subRun_ == other.subRun_) && (begin_ >= other.begin_) &&
           (end_ <= other.end_);
  }

bool art::EventRange::is_superset ( EventRange const &  other ) const

noexcept

Definition at line 180 of file EventRange.cc.

  {
    if (!are_valid(*this, other)) {
      return false;
    }
    return (subRun_ == other.subRun_) && (begin_ <= other.begin_) &&
           (end_ >= other.end_);
  }

bool art::EventRange::is_valid ( ) const

noexcept

Definition at line 117 of file EventRange.cc.

  {
    return ::art::is_valid(subRun_);
  }

bool art::EventRange::merge

(

EventRange const &

other

)

Definition at line 199 of file EventRange.cc.

  {
    require_not_full_SubRun();
    if (!are_valid(*this, other)) {
      return false;
    }
    bool const mergeable = is_adjacent(other);
    if (mergeable) {
      end_ = other.end_;
    }
    return mergeable;
  }

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

noexcept

Definition at line 87 of file EventRange.cc.

  {
    return !operator==(other);
  }

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

noexcept

Definition at line 68 of file EventRange.cc.

  {
    if (subRun_ == other.subRun_) {
      if (begin_ == other.begin_) {
        return end_ < other.end_;
      }
      return begin_ < other.begin_;
    }
    return subRun_ < other.subRun_;
  }

EventRange & art::EventRange::operator= ( EventRange const &  )

defaultnoexcept

EventRange & art::EventRange::operator= ( EventRange &&  )

defaultnoexcept

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

noexcept

Definition at line 80 of file EventRange.cc.

  {
    return (subRun_ == other.subRun_) && (begin_ == other.begin_) &&
           (end_ == other.end_);
  }

void art::EventRange::require_not_full_SubRun ( ) const

private

Definition at line 221 of file EventRange.cc.

  {
    if (is_full_subRun()) {
      throw Exception{errors::LogicError} << "\nAn EventRange created using "
                                             "EventRange::forSubRun cannot be "
                                             "modified.\n";
    }
  }

void art::EventRange::set_end

(

EventNumber_t const

e

)

Definition at line 213 of file EventRange.cc.

  {
    require_not_full_SubRun();
    require_ordering(begin_, e);
    end_ = e;
  }

unsigned long long art::EventRange::size ( ) const

noexcept

Definition at line 123 of file EventRange.cc.

  {
    return is_valid() ? (end_ - begin_) : -1ull;
  }

SubRunNumber_t art::EventRange::subRun ( ) const

noexcept

Definition at line 93 of file EventRange.cc.

  {
    return subRun_;
  }

Member Data Documentation

EventNumber_t art::EventRange::begin_ {IDNumber<Level::Event>::invalid()}

private

Definition at line 72 of file EventRange.h.

EventNumber_t art::EventRange::end_ {IDNumber<Level::Event>::invalid()}

private

Definition at line 73 of file EventRange.h.

SubRunNumber_t art::EventRange::subRun_ {IDNumber<Level::SubRun>::invalid()}

private

Definition at line 71 of file EventRange.h.

---

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

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