art::EventID Class Reference

#include "EventID.h"

Classes
struct	FlushFlag

Public Member Functions
constexpr	EventID ()
	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 ()
static EventID	invalidEvent (RunID rID)
static EventID	invalidEvent (SubRunID const &srID)
static constexpr EventID	flushEvent ()
static EventID	flushEvent (RunID rID)
static EventID	flushEvent (SubRunID srID)

Private Member Functions
constexpr	EventID (FlushFlag)
	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 ( )

inline

Definition at line 80 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 84 of file EventID.h.

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

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

inline

Definition at line 88 of file EventID.h.

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

constexpr art::EventID::EventID ( FlushFlag  )

inlineexplicitprivate

Definition at line 283 of file EventID.h.

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

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

inlineprivate

Definition at line 288 of file EventID.h.

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

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

inlineprivate

Definition at line 293 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 117 of file EventID.h.

References event_.

Referenced by lar_pandora::PFParticleTrackAna::analyze(), opdet::OpHitAna::analyze(), opdet::OpFlashMCTruthAna::analyze(), lar_pandora::PFParticleCosmicAna::analyze(), lar_pandora::PFParticleMonitoring::analyze(), lar_pandora::PFParticleAnalysis::analyze(), lar_pandora::PFParticleHitDumper::analyze(), opdet::FlashHypothesisAna::analyze(), cheat::RecoCheckAna::analyze(), opreco::OpticalRecoAna::analyze(), hit::HitAnaModule::analyze(), opdet::TrackTimeAssocAna::analyze(), opdet::OpDigiAna::analyze(), opdet::OpFlashAna::analyze(), larg4::LArG4Ana::analyze(), opdet::FlashPurityCheckAna::analyze(), cluster::ClusterAna::analyze(), pfpf::PFPAna::analyze(), cluster::DBclusterAna::analyze(), hit::GausHitFinderAna::analyze(), hit::HitFinderAna::analyze(), cluster::HoughLineFinderAna::analyze(), opdet::SimPhotonCounter::analyze(), vertex::FeatureVertexFinderAna::analyze(), ems::MultiEMShowers::analyze(), evd::HitSelector::ChangeHit(), evd::GraphClusterAlg::CheckValidity(), t0::IndirectHitParticleAssns::CreateHitParticleAssociations(), art::ClosedRangeSetHandler::do_maybeSplitRange(), recob::DumpPFParticles::DotFileName(), art::EventAuxiliary::event(), art::EventPrincipal::event(), filter::EventFilter::filter(), filt::EmptyFilter::filter(), art::FileIndex::findEventForUnspecifiedSubRun(), rndm::NuRandomServiceHelper::ArtState::getEventSeedInputData(), evd::HeaderDrawer::Header(), recob::DumpPFParticles::MakePFParticleGraph(), art::EventIDMatcher::match(), evdb::DisplayWindow::OpenWindow(), lar_cluster3d::Cluster3D::PrepareEvent(), evdb::EventDisplay::preProcessEvent(), opdet::BoDataFrameInput::produce(), mvapid::MVAPID::produce(), wc::MergeWireCell::produce(), evgen::NUANCEGen::produce(), evgen::NDKGen::produce(), vertex::PrimaryVertexFinder::produce(), vertex::HarrisVertexFinder::produce(), shwf::ShowerReco::produce(), trkf::Track3DKalman::produce(), trkf::Track3DKalmanSPS::produce(), lar_cluster3d::Cluster3D::produce(), ems::MergeEMShower3D::produce(), evd::InfoTransfer::Rebuild(), evdb::ScanFrame::Record(), evd::HitSelector::SaveHits(), evd::HitSelector::SaveSeedLines(), and art::EmptyEvent::setRunAndEventInfo().

{
  return event_;
}

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

inlinestatic

Definition at line 191 of file EventID.h.

References art::SubRunID::firstSubRun().

Referenced by art::EmptyEvent::EmptyEvent(), and art::RootInputFileSequence::RootInputFileSequence().

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

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

inlinestatic

Definition at line 197 of file EventID.h.

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

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

inlinestatic

Definition at line 222 of file EventID.h.

{
  return EventID{FlushFlag()};
}

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

inlinestatic

Definition at line 228 of file EventID.h.

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

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

inlinestatic

Definition at line 234 of file EventID.h.

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

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

inlineprivate

Definition at line 298 of file EventID.h.

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

{
  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 ( )

inlinestatic

Definition at line 203 of file EventID.h.

Referenced by art::TimeTracker::preEventReading(), art::RootOutputFile::writeRun(), and art::RootOutputFile::writeSubRun().

{
  return EventID{};
}

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

inlinestatic

Definition at line 209 of file EventID.h.

References art::SubRunID::invalidSubRun().

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

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

inlinestatic

Definition at line 216 of file EventID.h.

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

bool art::EventID::isFlush ( ) const

inline

Definition at line 129 of file EventID.h.

References event_.

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

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

bool art::EventID::isValid ( ) const

inline

Definition at line 123 of file EventID.h.

References event_, art::SubRunID::isValid(), and subRun_.

Referenced by art::FileIndex::Element::getEntryType(), art::EventIDMatcher::match(), next(), art::Compare_Run_SubRun_EventEntry::operator()(), art::operator<<(), previous(), art::FileStatsCollector::recordEvent(), art::RootInput::seekToEvent(), and art::Source< T >::throwIfInsane_().

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

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

inlinestatic

Definition at line 185 of file EventID.h.

References art::SubRunID::maxSubRun().

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

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

inline

Definition at line 135 of file EventID.h.

References event_, art::errors::InvalidNumber, isValid(), nextSubRun(), and subRun_.

Referenced by art::ClosedRangeSetHandler::do_maybeSplitRange(), art::EmptyEvent::setRunAndEventInfo(), and art::EmptyEvent::skip().

{
  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 154 of file EventID.h.

References art::SubRunID::nextRun(), and subRun_.

Referenced by art::EmptyEvent::setRunAndEventInfo().

{
  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 148 of file EventID.h.

References art::SubRunID::next(), and subRun_.

Referenced by next(), and art::EmptyEvent::setRunAndEventInfo().

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

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

inline

Definition at line 247 of file EventID.h.

References fhicl::other.

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

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

inline

Definition at line 255 of file EventID.h.

References event_, and subRun_.

{
  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 272 of file EventID.h.

References fhicl::other.

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

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

inline

Definition at line 241 of file EventID.h.

References event_, and subRun_.

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

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

inline

Definition at line 266 of file EventID.h.

{
  return (other < *this);
}

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

inline

Definition at line 278 of file EventID.h.

References fhicl::other.

{
  return !(*this < other);
}

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

inline

Definition at line 160 of file EventID.h.

References event_, art::errors::InvalidNumber, isValid(), previousSubRun(), and subRun_.

Referenced by art::EmptyEvent::skip().

{
  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 179 of file EventID.h.

References art::SubRunID::previousRun(), and subRun_.

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

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

inline

Definition at line 173 of file EventID.h.

References art::SubRunID::previous(), and subRun_.

Referenced by previous().

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

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

inline

Definition at line 99 of file EventID.h.

References art::SubRunID::run(), and subRun_.

Referenced by opreco::OpticalRecoAna::analyze(), cluster::HoughLineFinderAna::analyze(), evd::GraphClusterAlg::CheckValidity(), recob::DumpPFParticles::DotFileName(), rndm::NuRandomServiceHelper::ArtState::getEventSeedInputData(), recob::DumpPFParticles::MakePFParticleGraph(), art::EventIDMatcher::match(), evdb::DisplayWindow::OpenWindow(), evdb::EventDisplay::preProcessEvent(), mvapid::MVAPID::produce(), shwf::ShowerReco::produce(), evd::InfoTransfer::Rebuild(), art::EventAuxiliary::run(), art::Event::run(), art::EventPrincipal::run(), art::EmptyEvent::runRangeSetHandler(), art::EmptyEvent::setRunAndEventInfo(), and art::EmptyEvent::subRunRangeSetHandler().

{
  return subRun_.run();
}

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

inline

Definition at line 93 of file EventID.h.

References art::SubRunID::runID(), and subRun_.

Referenced by art::FileIndex::findEventForUnspecifiedSubRun(), art::EmptyEvent::getNextItemType(), art::RootDelayedReader::getProduct_(), art::EventIDMatcher::match(), art::RootInput::nextItemType(), art::RootDelayedReader::openNextSecondaryFile_(), art::EmptyEvent::readRun_(), art::EventAuxiliary::runID(), and art::RootInput::seekToEvent().

{
  return subRun_.runID();
}

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

inline

Definition at line 111 of file EventID.h.

References art::SubRunID::subRun(), and subRun_.

Referenced by evd::GraphClusterAlg::CheckValidity(), art::ClosedRangeSetHandler::do_maybeSplitRange(), recob::DumpPFParticles::DotFileName(), rndm::NuRandomServiceHelper::ArtState::getEventSeedInputData(), recob::DumpPFParticles::MakePFParticleGraph(), art::EventIDMatcher::match(), mvapid::MVAPID::produce(), shwf::ShowerReco::produce(), evd::InfoTransfer::Rebuild(), art::EmptyEvent::setRunAndEventInfo(), art::EventAuxiliary::subRun(), and art::EventPrincipal::subRun().

{
  return subRun_.subRun();
}

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

inline

Definition at line 105 of file EventID.h.

References subRun_.

Referenced by art::FileIndex::Element::getEntryType(), art::EmptyEvent::getNextItemType(), art::RootDelayedReader::getProduct_(), art::EventIDMatcher::match(), art::RootInput::nextItemType(), art::RootDelayedReader::openNextSecondaryFile_(), art::Compare_Run_SubRun_EventEntry::operator()(), art::EmptyEvent::readSubRun_(), art::RootInput::seekToEvent(), art::EventAuxiliary::subRunID(), and art::Source< T >::throwIfInsane_().

{
  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 77 of file EventID.h.

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

SubRunID art::EventID::subRun_

private

Definition at line 76 of file EventID.h.

Referenced by isValid(), next(), nextRun(), nextSubRun(), operator<(), art::operator<<(), operator==(), previous(), previousRun(), previousSubRun(), run(), runID(), subRun(), and subRunID().

---

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

• canvas/Persistency/Provenance/EventID.h