#include "EventRange.h"

Public Member Functions
	EventRange ()=default

	EventRange (SubRunNumber_t s, EventNumber_t begin, EventNumber_t end)

bool	operator< (EventRange const &other) const

bool	operator== (EventRange const &other) const

bool	operator!= (EventRange const &other) const

auto	subRun () const

bool	empty () const

auto	begin () const

auto	end () const

auto	size () const

bool	is_valid () const

bool	is_full_subRun () const

bool	contains (SubRunNumber_t s, EventNumber_t e) const

bool	is_same (EventRange const &other) const

bool	is_adjacent (EventRange const &other) const

bool	is_disjoint (EventRange const &other) const

bool	is_subset (EventRange const &other) const

bool	is_superset (EventRange const &other) const

bool	is_overlapping (EventRange const &other) const

bool	merge (EventRange const &other)

void	set_end (EventNumber_t const e)

Static Public Member Functions
static EventRange	invalid ()

static EventRange	forSubRun (SubRunNumber_t s)

static bool	are_valid (EventRange const &l, EventRange const &r)

Private Member Functions
void	require_not_full_SubRun ()

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 16 of file EventRange.h.

Constructor & Destructor Documentation

art::EventRange::EventRange ( )

explicitdefault

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

explicit

Definition at line 30 of file EventRange.cc.

References begin_, e, and end_.

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

Member Function Documentation

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

static

Definition at line 93 of file EventRange.cc.

References is_valid().

Referenced by is_adjacent(), is_disjoint(), is_overlapping(), is_same(), is_subset(), is_superset(), merge(), and size().

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

auto art::EventRange::begin ( ) const

inline

Definition at line 42 of file EventRange.h.

References begin_.

Referenced by art::operator<<().

     {
       return begin_;
     }

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

Definition at line 87 of file EventRange.cc.

References begin_, end_, and subRun_.

Referenced by size().

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

bool art::EventRange::empty ( void ) const

inline

Definition at line 37 of file EventRange.h.

References begin_, and end_.

     {
       return begin_ == end_;
     }

auto art::EventRange::end ( void ) const

inline

Definition at line 47 of file EventRange.h.

References end_.

Referenced by art::operator<<().

     {
       return end_;
     }

EventRange EventRange::forSubRun ( SubRunNumber_t s )

static

Definition at line 25 of file EventRange.cc.

References s.

Referenced by art::RangeSet::forSubRun().

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

EventRange EventRange::invalid ( )

static

Definition at line 19 of file EventRange.cc.

 {
   return EventRange{};
 }

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

Definition at line 112 of file EventRange.cc.

References are_valid(), begin_, end_, and subRun_.

Referenced by merge(), and size().

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

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

Definition at line 120 of file EventRange.cc.

References are_valid(), begin_, end_, and subRun_.

Referenced by is_overlapping(), and size().

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

bool EventRange::is_full_subRun ( ) const

Definition at line 105 of file EventRange.cc.

References begin_, end_, art::is_valid(), and subRun_.

Referenced by art::operator<<(), require_not_full_SubRun(), and size().

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

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

Definition at line 154 of file EventRange.cc.

References are_valid(), is_disjoint(), is_subset(), and is_superset().

Referenced by size().

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

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

Definition at line 128 of file EventRange.cc.

References are_valid(), and operator==().

Referenced by size().

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

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

Definition at line 136 of file EventRange.cc.

References are_valid(), begin_, end_, and subRun_.

Referenced by is_overlapping(), and size().

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

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

Definition at line 145 of file EventRange.cc.

References are_valid(), begin_, end_, and subRun_.

Referenced by is_overlapping(), and size().

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

bool EventRange::is_valid ( ) const

Definition at line 99 of file EventRange.cc.

References art::is_valid(), and subRun_.

Referenced by are_valid(), and size().

 {
   return art::is_valid(subRun_);
 }

bool EventRange::merge ( EventRange const & other )

Definition at line 39 of file EventRange.cc.

References are_valid(), end_, is_adjacent(), and require_not_full_SubRun().

Referenced by size().

 {
   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 EventRange::operator!= ( EventRange const & other ) const

Definition at line 73 of file EventRange.cc.

References operator==().

 {
   return !operator==(other);
 }

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

Definition at line 52 of file EventRange.cc.

References begin_, end_, and subRun_.

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

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

Definition at line 66 of file EventRange.cc.

References begin_, end_, and subRun_.

Referenced by is_same(), and operator!=().

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

void art::EventRange::require_not_full_SubRun ( )

inlineprivate

Definition at line 78 of file EventRange.h.

References is_full_subRun(), and art::errors::LogicError.

Referenced by merge(), and set_end().

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

void EventRange::set_end ( EventNumber_t const e )

Definition at line 79 of file EventRange.cc.

References begin_, e, end_, and require_not_full_SubRun().

Referenced by size().

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

auto art::EventRange::size ( void ) const

inline

Definition at line 52 of file EventRange.h.

References are_valid(), begin_, contains(), e, end_, is_adjacent(), is_disjoint(), is_full_subRun(), is_overlapping(), is_same(), is_subset(), is_superset(), is_valid(), merge(), and set_end().

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

auto art::EventRange::subRun ( ) const

inline

Definition at line 32 of file EventRange.h.

References subRun_.

Referenced by art::operator<<().

     {
       return subRun_;
     }

Member Data Documentation

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

private

Definition at line 87 of file EventRange.h.

Referenced by begin(), contains(), empty(), EventRange(), is_adjacent(), is_disjoint(), is_full_subRun(), is_subset(), is_superset(), operator<(), operator==(), set_end(), and size().

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

private

Definition at line 88 of file EventRange.h.

Referenced by contains(), empty(), end(), EventRange(), is_adjacent(), is_disjoint(), is_full_subRun(), is_subset(), is_superset(), merge(), operator<(), operator==(), set_end(), and size().

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

private

Definition at line 86 of file EventRange.h.

Referenced by contains(), is_adjacent(), is_disjoint(), is_full_subRun(), is_subset(), is_superset(), is_valid(), operator<(), operator==(), and subRun().

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation