art::RootInput Class Reference

#include "RootInput.h"

Inheritance diagram for art::RootInput:

Classes
class	AccessState
struct	Config

Public Types
using	Parameters = fhicl::WrappedTable< Config, Config::KeysToIgnore >
enum	ProcessingMode { Runs, RunsAndSubRuns, RunsSubRunsAndEvents }

Public Member Functions
	RootInput (Parameters const &, InputSourceDescription &)
template<typename T >
bool	seekToEvent (T eventSpec, bool exact=false)
std::unique_ptr< EventPrincipal >	readEvent (EventID const &) override
	Read a specific event. More...
void	closeFile () override
	close current file More...
void	skipEvents (int offset) override
void	rewind () override
	Begin again at the first event. More...
void	issueReports (EventID const &eventID)
	issue an event report More...
void	repeat_ ()
	Reset the remaining number of events/subRuns to the maximum number. More...
int	maxEvents () const
int	remainingEvents () const
int	maxSubRuns () const
int	remainingSubRuns () const
void	doBeginJob () override
	Called by framework at beginning of job. More...
void	doEndJob () override
	Called by framework at end of job. More...
Timestamp const &	timestamp () const
	Accessor for the current time, as seen by the input source. More...
ProcessingMode	processingMode () const
	RunsSubRunsAndEvents (default), RunsAndSubRuns, or Runs. More...
auto const &	moduleDescription () const
auto const &	processConfiguration () const

Protected Member Functions
void	setTimestamp (Timestamp const &theTime)
	To set the current time, as seen by the input source. More...
input::ItemType	state () const
cet::exempt_ptr< RunPrincipal >	runPrincipalExemptPtr ()
cet::exempt_ptr< SubRunPrincipal >	subRunPrincipalExemptPtr ()
std::unique_ptr< RunPrincipal >	runPrincipal ()
std::unique_ptr< SubRunPrincipal >	subRunPrincipal ()
std::unique_ptr< EventPrincipal >	eventPrincipal ()
void	setRunPrincipal (std::unique_ptr< RunPrincipal > &&rp)
void	setSubRunPrincipal (std::unique_ptr< SubRunPrincipal > &&srp)
void	setEventPrincipal (std::unique_ptr< EventPrincipal > &&ep)
void	resetRunPrincipal ()
void	resetSubRunPrincipal ()
void	resetEventPrincipal ()
void	reset ()

Private Types
typedef input::EntryNumber	EntryNumber

Private Member Functions
void	finish () override
input::ItemType	nextItemType () override
std::unique_ptr< EventPrincipal >	readEvent (cet::exempt_ptr< SubRunPrincipal const >) override
std::unique_ptr< EventPrincipal >	readEvent_ () override
std::unique_ptr< EventPrincipal >	readEvent_ (cet::exempt_ptr< SubRunPrincipal const >)
std::unique_ptr< SubRunPrincipal >	readSubRun (cet::exempt_ptr< RunPrincipal const >) override
	Read next subRun. More...
std::unique_ptr< SubRunPrincipal >	readSubRun_ () override
std::unique_ptr< RunPrincipal >	readRun () override
	Read next run. More...
std::unique_ptr< RunPrincipal >	readRun_ () override
std::unique_ptr< FileBlock >	readFile () override
	Read next file. More...
std::unique_ptr< FileBlock >	readFile_ () override
std::unique_ptr< RangeSetHandler >	runRangeSetHandler () override
std::unique_ptr< RangeSetHandler >	subRunRangeSetHandler () override
void	closeFile_ () override
void	endJob () override
input::ItemType	getNextItemType () override
void	rewind_ () override
template<typename T >
std::enable_if_t< std::is_convertible< T, off_t >::value, EventID >	postSeekChecks (EventID const &foundID, T eventSpec)
template<typename T >
std::enable_if_t<!std::is_convertible< T, off_t >::value, EventID >	postSeekChecks (EventID const &foundID, T eventSpec)

Private Attributes
InputFileCatalog	catalog_
std::unique_ptr< RootInputFileSequence >	primaryFileSequence_
AccessState	accessState_

Detailed Description

Definition at line 26 of file RootInput.h.

Member Typedef Documentation

typedef input::EntryNumber art::RootInput::EntryNumber

private

Definition at line 104 of file RootInput.h.

using art::RootInput::Parameters = fhicl::WrappedTable<Config, Config::KeysToIgnore>

Definition at line 44 of file RootInput.h.

Member Enumeration Documentation

enum art::InputSource::ProcessingMode

inherited

Enumerator
Runs
RunsAndSubRuns
RunsSubRunsAndEvents

Definition at line 52 of file InputSource.h.

{ Runs, RunsAndSubRuns, RunsSubRunsAndEvents };

Constructor & Destructor Documentation

RootInput::RootInput	(	RootInput::Parameters const &	config,
		InputSourceDescription &	desc
	)

Definition at line 55 of file RootInput_source.cc.

References accessState_, catalog_, art::InputSourceDescription::moduleDescription, primaryFileSequence_, art::InputSource::processConfiguration(), and art::DecrepitRelicInputSourceImplementation::processingMode().

  : DecrepitRelicInputSourceImplementation{config().drisi_config,
                                           desc.moduleDescription}
  , catalog_{config().ifc_config}
  , primaryFileSequence_{std::make_unique<RootInputFileSequence>(
      config().rifs_config,
      catalog_,
      FastCloningInfoProvider(cet::exempt_ptr<RootInput>(this)),
      processingMode(),
      desc.productRegistry,
      processConfiguration())}
  , accessState_{}
{}

Member Function Documentation

void art::DecrepitRelicInputSourceImplementation::closeFile ( )

overridevirtualinherited

close current file

Implements art::InputSource.

Definition at line 225 of file DecrepitRelicInputSourceImplementation.cc.

References art::DecrepitRelicInputSourceImplementation::closeFile_().

  {
    return closeFile_();
  }

void RootInput::closeFile_ ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 77 of file RootInput_source.cc.

References primaryFileSequence_.

{
  primaryFileSequence_->closeFile_();
}

void art::DecrepitRelicInputSourceImplementation::doBeginJob ( )

overridevirtualinherited

Called by framework at beginning of job.

Reimplemented from art::InputSource.

Definition at line 202 of file DecrepitRelicInputSourceImplementation.cc.

References art::DecrepitRelicInputSourceImplementation::beginJob().

Referenced by art::DecrepitRelicInputSourceImplementation::remainingSubRuns().

  {
    beginJob();
  }

void art::DecrepitRelicInputSourceImplementation::doEndJob ( )

overridevirtualinherited

Called by framework at end of job.

Reimplemented from art::InputSource.

Definition at line 208 of file DecrepitRelicInputSourceImplementation.cc.

References art::DecrepitRelicInputSourceImplementation::endJob().

Referenced by art::DecrepitRelicInputSourceImplementation::remainingSubRuns().

  {
    endJob();
  }

void RootInput::endJob ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 71 of file RootInput_source.cc.

References primaryFileSequence_.

{
  primaryFileSequence_->endJob();
}

std::unique_ptr<EventPrincipal> art::DecrepitRelicInputSourceImplementation::eventPrincipal ( )

inlineprotectedinherited

Definition at line 248 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::eventPrincipal_, art::DecrepitRelicInputSourceImplementation::setEventPrincipal(), art::DecrepitRelicInputSourceImplementation::setRunPrincipal(), and art::DecrepitRelicInputSourceImplementation::setSubRunPrincipal().

Referenced by readEvent_().

    {
      return std::move(eventPrincipal_);
    }

void RootInput::finish ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 97 of file RootInput_source.cc.

References primaryFileSequence_.

{
  primaryFileSequence_->finish();
}

input::ItemType RootInput::getNextItemType ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 91 of file RootInput_source.cc.

References primaryFileSequence_.

{
  return primaryFileSequence_->getNextItemType();
}

void art::DecrepitRelicInputSourceImplementation::issueReports ( EventID const &  eventID )

inherited

issue an event report

Definition at line 313 of file DecrepitRelicInputSourceImplementation.cc.

References art::DecrepitRelicInputSourceImplementation::readCount_.

Referenced by art::DecrepitRelicInputSourceImplementation::readEvent(), and art::DecrepitRelicInputSourceImplementation::rewind().

  {
    time_t t = time(0);
    char ts[] = "dd-Mon-yyyy hh:mm:ss TZN     ";
    strftime(ts, strlen(ts) + 1, "%d-%b-%Y %H:%M:%S %Z", localtime(&t));
    mf::LogVerbatim("ArtReport")
      << "Begin processing the " << readCount_ << suffix(readCount_)
      << " record. " << eventID << " at " << ts;
    // At some point we may want to initiate checkpointing here
  }

int art::DecrepitRelicInputSourceImplementation::maxEvents ( ) const

inlineinherited

Accessor for maximum number of events to be read. -1 is used for unlimited.

Definition at line 153 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::maxEvents_.

    {
      return maxEvents_;
    }

int art::DecrepitRelicInputSourceImplementation::maxSubRuns ( ) const

inlineinherited

Accessor for maximum number of subRuns to be read. -1 is used for unlimited.

Definition at line 169 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::maxSubRuns_.

    {
      return maxSubRuns_;
    }

auto const& art::InputSource::moduleDescription ( ) const

inlineinherited

Definition at line 59 of file InputSource.h.

Referenced by art::EmptyEvent::readRun_(), and art::EmptyEvent::readSubRun_().

    {
      return moduleDescription_;
    }

input::ItemType RootInput::nextItemType ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 103 of file RootInput_source.cc.

References accessState_, art::input::IsEvent, art::input::IsFile, art::input::IsRun, art::input::IsSubRun, art::errors::LogicError, art::DecrepitRelicInputSourceImplementation::nextItemType(), primaryFileSequence_, art::EventID::runID(), art::DecrepitRelicInputSourceImplementation::runPrincipalExemptPtr(), art::RootInput::AccessState::SEEKING_EVENT, art::RootInput::AccessState::SEEKING_FILE, art::RootInput::AccessState::SEEKING_RUN, art::RootInput::AccessState::SEEKING_SUBRUN, art::RootInput::AccessState::SEQUENTIAL, art::DecrepitRelicInputSourceImplementation::setEventPrincipal(), art::RootInput::AccessState::setLastReadEventID(), art::RootInput::AccessState::setRootFileForLastReadEvent(), art::DecrepitRelicInputSourceImplementation::setRunPrincipal(), art::DecrepitRelicInputSourceImplementation::setSubRunPrincipal(), art::RootInput::AccessState::state(), art::EventID::subRunID(), and art::RootInput::AccessState::wantedEventID().

{
  switch (accessState_.state()) {
    case AccessState::SEQUENTIAL:
      return DecrepitRelicInputSourceImplementation::nextItemType();
    case AccessState::SEEKING_FILE:
      return input::IsFile;
    case AccessState::SEEKING_RUN:
      setRunPrincipal(
        primaryFileSequence_->readIt(accessState_.wantedEventID().runID()));
      return input::IsRun;
    case AccessState::SEEKING_SUBRUN:
      // RunPrincipal has been handed off to the EventProcessor by this point.
      // Used the cached pointer.
      setSubRunPrincipal(primaryFileSequence_->readIt(
        accessState_.wantedEventID().subRunID(), runPrincipalExemptPtr()));
      return input::IsSubRun;
    case AccessState::SEEKING_EVENT: {
      auto const wantedEventID = accessState_.wantedEventID();
      setEventPrincipal(primaryFileSequence_->readIt(wantedEventID, true));
      accessState_.setLastReadEventID(wantedEventID);
      accessState_.setRootFileForLastReadEvent(
        primaryFileSequence_->rootFileForLastReadEvent());
      return input::IsEvent;
    }
    default:
      throw Exception(errors::LogicError)
        << "RootInputSource::nextItemType encountered an "
           "unknown AccessState.\n";
  }
}

template<typename T >

std::enable_if_t< std::is_convertible< T, off_t >::value, EventID > art::RootInput::postSeekChecks ( EventID const &  foundID, T  eventSpec  )

private

Definition at line 175 of file RootInput.h.

References accessState_, art::RootInput::AccessState::lastReadEventID(), primaryFileSequence_, and fhicl::detail::atom::value().

Referenced by seekToEvent().

  {
    if (eventspec == 0 && foundID == accessState_.lastReadEventID()) {
      // We're supposed to be reading the, "next" event but it's a
      // duplicate of the current one: skip it.
      mf::LogWarning("DuplicateEvent")
        << "Duplicate Events found: "
        << "both events were " << foundID << ".\n"
        << "The duplicate will be skipped.\n";
      return primaryFileSequence_->seekToEvent(1, false);
    }
    return foundID;
  }

template<typename T >

std::enable_if_t<!std::is_convertible< T, off_t >::value, EventID > art::RootInput::postSeekChecks ( EventID const &  foundID, T  eventSpec  )

private

Definition at line 191 of file RootInput.h.

  {
    // Default implementation is NOP.
    return foundID;
  }

auto const& art::InputSource::processConfiguration ( ) const

inlineinherited

Definition at line 64 of file InputSource.h.

References n.

Referenced by art::EmptyEvent::readRun_(), art::EmptyEvent::readSubRun_(), art::EmptyEvent::reallyReadEvent(), and RootInput().

    {
      return moduleDescription_.processConfiguration();
    }

ProcessingMode art::DecrepitRelicInputSourceImplementation::processingMode ( ) const

inlineinherited

RunsSubRunsAndEvents (default), RunsAndSubRuns, or Runs.

Definition at line 197 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::processingMode_.

Referenced by art::DecrepitRelicInputSourceImplementation::DecrepitRelicInputSourceImplementation(), art::EmptyEvent::getNextItemType(), art::DecrepitRelicInputSourceImplementation::nextItemType(), art::DecrepitRelicInputSourceImplementation::nextItemType_(), art::EmptyEvent::readEvent_(), art::EmptyEvent::readSubRun_(), art::EmptyEvent::reallyReadEvent(), and RootInput().

    {
      return processingMode_;
    }

std::unique_ptr< EventPrincipal > art::DecrepitRelicInputSourceImplementation::readEvent ( EventID const &  )

overridevirtualinherited

Read a specific event.

Reimplemented from art::InputSource.

Definition at line 298 of file DecrepitRelicInputSourceImplementation.cc.

References art::errors::LogicError.

  {
    throw art::Exception(art::errors::LogicError)
      << "DecrepitRelicInputSourceImplementation::readEvent()\n"
      << "Random access is not implemented for this type of Input Source\n"
      << "Contact a Framework Developer\n";
  }

std::unique_ptr< EventPrincipal > RootInput::readEvent ( cet::exempt_ptr< SubRunPrincipal const >  srp )

overrideprivatevirtual

Read next event Indicate inability to get a new event by returning a null unique_ptr.

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 214 of file RootInput_source.cc.

References readEvent_().

{
  return readEvent_(srp);
}

std::unique_ptr< EventPrincipal > RootInput::readEvent_ ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 236 of file RootInput_source.cc.

References accessState_, DEFINE_ART_INPUT_SOURCE, art::EventPrincipal::id(), primaryFileSequence_, art::RootInput::AccessState::setLastReadEventID(), and art::RootInput::AccessState::setRootFileForLastReadEvent().

Referenced by readEvent().

{
  std::unique_ptr<EventPrincipal> result;
  if (!result.get()) {
    result = primaryFileSequence_->readEvent_();
  }
  if (result.get()) {
    accessState_.setLastReadEventID(result->id());
    accessState_.setRootFileForLastReadEvent(
      primaryFileSequence_->rootFileForLastReadEvent());
  }
  return result;
}

std::unique_ptr< EventPrincipal > RootInput::readEvent_ ( cet::exempt_ptr< SubRunPrincipal const >  srp )

private

Definition at line 220 of file RootInput_source.cc.

References accessState_, art::DecrepitRelicInputSourceImplementation::eventPrincipal(), art::errors::LogicError, art::DecrepitRelicInputSourceImplementation::readEvent(), art::RootInput::AccessState::resetState(), art::RootInput::AccessState::SEEKING_EVENT, art::RootInput::AccessState::SEQUENTIAL, and art::RootInput::AccessState::state().

{
  switch (accessState_.state()) {
    case AccessState::SEQUENTIAL:
      return DecrepitRelicInputSourceImplementation::readEvent(srp);
    case AccessState::SEEKING_EVENT:
      accessState_.resetState();
      return eventPrincipal();
    default:
      throw Exception(errors::LogicError)
        << "RootInputSource::readEvent encountered an "
           "unknown or inappropriate AccessState.\n";
  }
}

std::unique_ptr< FileBlock > RootInput::readFile ( )

overrideprivatevirtual

Read next file.

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 136 of file RootInput_source.cc.

References accessState_, art::errors::LogicError, art::DecrepitRelicInputSourceImplementation::readFile(), readFile_(), art::RootInput::AccessState::SEEKING_FILE, art::RootInput::AccessState::SEEKING_RUN, art::RootInput::AccessState::SEQUENTIAL, art::RootInput::AccessState::setState(), and art::RootInput::AccessState::state().

{
  switch (accessState_.state()) {
    case AccessState::SEQUENTIAL:
      return DecrepitRelicInputSourceImplementation::readFile();
    case AccessState::SEEKING_FILE:
      accessState_.setState(AccessState::SEEKING_RUN);
      return readFile_();
    default:
      throw Exception(errors::LogicError)
        << "RootInputSource::readFile encountered an "
           "unknown or inappropriate AccessState.\n";
  }
}

std::unique_ptr< FileBlock > RootInput::readFile_ ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 152 of file RootInput_source.cc.

References primaryFileSequence_.

Referenced by readFile().

{
  return primaryFileSequence_->readFile_();
}

std::unique_ptr< RunPrincipal > RootInput::readRun ( )

overrideprivatevirtual

Read next run.

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 158 of file RootInput_source.cc.

References accessState_, art::errors::LogicError, art::DecrepitRelicInputSourceImplementation::readRun(), art::DecrepitRelicInputSourceImplementation::runPrincipal(), art::RootInput::AccessState::SEEKING_RUN, art::RootInput::AccessState::SEEKING_SUBRUN, art::RootInput::AccessState::SEQUENTIAL, art::RootInput::AccessState::setState(), and art::RootInput::AccessState::state().

{
  switch (accessState_.state()) {
    case AccessState::SEQUENTIAL:
      return DecrepitRelicInputSourceImplementation::readRun();
    case AccessState::SEEKING_RUN:
      accessState_.setState(AccessState::SEEKING_SUBRUN);
      return runPrincipal();
    default:
      throw Exception(errors::LogicError)
        << "RootInputSource::readRun encountered an "
           "unknown or inappropriate AccessState.\n";
  }
}

std::unique_ptr< RunPrincipal > RootInput::readRun_ ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 174 of file RootInput_source.cc.

References primaryFileSequence_.

{
  return primaryFileSequence_->readRun_();
}

std::unique_ptr< SubRunPrincipal > RootInput::readSubRun ( cet::exempt_ptr< RunPrincipal const >  rp )

overrideprivatevirtual

Read next subRun.

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 186 of file RootInput_source.cc.

References accessState_, art::errors::LogicError, art::DecrepitRelicInputSourceImplementation::readSubRun(), art::RootInput::AccessState::SEEKING_EVENT, art::RootInput::AccessState::SEEKING_SUBRUN, art::RootInput::AccessState::SEQUENTIAL, art::RootInput::AccessState::setState(), art::RootInput::AccessState::state(), and art::DecrepitRelicInputSourceImplementation::subRunPrincipal().

{
  switch (accessState_.state()) {
    case AccessState::SEQUENTIAL:
      return DecrepitRelicInputSourceImplementation::readSubRun(rp);
    case AccessState::SEEKING_SUBRUN:
      accessState_.setState(AccessState::SEEKING_EVENT);
      return subRunPrincipal();
    default:
      throw Exception(errors::LogicError)
        << "RootInputSource::readSubRun encountered an "
           "unknown or inappropriate AccessState.\n";
  }
}

std::unique_ptr< SubRunPrincipal > RootInput::readSubRun_ ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 202 of file RootInput_source.cc.

References primaryFileSequence_, and art::DecrepitRelicInputSourceImplementation::runPrincipalExemptPtr().

{
  return primaryFileSequence_->readSubRun_(runPrincipalExemptPtr());
}

int art::DecrepitRelicInputSourceImplementation::remainingEvents ( ) const

inlineinherited

Accessor for remaining number of events to be read. -1 is used for unlimited.

Definition at line 161 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::remainingEvents_.

    {
      return remainingEvents_;
    }

int art::DecrepitRelicInputSourceImplementation::remainingSubRuns ( ) const

inlineinherited

Accessor for remaining number of subRuns to be read. -1 is used for unlimited.

Definition at line 177 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::doBeginJob(), art::DecrepitRelicInputSourceImplementation::doEndJob(), and art::DecrepitRelicInputSourceImplementation::remainingSubRuns_.

    {
      return remainingSubRuns_;
    }

void art::DecrepitRelicInputSourceImplementation::repeat_ ( )

inlineinherited

Reset the remaining number of events/subRuns to the maximum number.

Definition at line 143 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::doneReadAhead_, art::DecrepitRelicInputSourceImplementation::maxEvents_, art::DecrepitRelicInputSourceImplementation::maxSubRuns_, art::DecrepitRelicInputSourceImplementation::remainingEvents_, and art::DecrepitRelicInputSourceImplementation::remainingSubRuns_.

Referenced by art::DecrepitRelicInputSourceImplementation::rewind().

    {
      remainingEvents_ = maxEvents_;
      remainingSubRuns_ = maxSubRuns_;
      doneReadAhead_ = false;
    }

void art::DecrepitRelicInputSourceImplementation::reset ( void  )

inlineprotectedinherited

Definition at line 272 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::doneReadAhead_, art::input::IsInvalid, and art::DecrepitRelicInputSourceImplementation::state_.

    {
      doneReadAhead_ = false;
      state_ = input::IsInvalid;
    }

void art::DecrepitRelicInputSourceImplementation::resetEventPrincipal ( )

inlineprotectedinherited

Definition at line 267 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::eventPrincipal_.

    {
      eventPrincipal_.reset();
    }

void art::DecrepitRelicInputSourceImplementation::resetRunPrincipal ( )

inlineprotectedinherited

Definition at line 257 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::runPrincipal_.

Referenced by art::EmptyEvent::getNextItemType(), and art::EmptyEvent::rewind_().

    {
      runPrincipal_.reset();
    }

void art::DecrepitRelicInputSourceImplementation::resetSubRunPrincipal ( )

inlineprotectedinherited

Definition at line 262 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::subRunPrincipal_.

Referenced by art::EmptyEvent::getNextItemType(), and art::EmptyEvent::rewind_().

    {
      subRunPrincipal_.reset();
    }

void art::DecrepitRelicInputSourceImplementation::rewind ( )

inlineoverridevirtualinherited

Begin again at the first event.

Reimplemented from art::InputSource.

Definition at line 130 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::doneReadAhead_, art::input::IsInvalid, art::DecrepitRelicInputSourceImplementation::issueReports(), art::DecrepitRelicInputSourceImplementation::repeat_(), art::DecrepitRelicInputSourceImplementation::rewind_(), and art::DecrepitRelicInputSourceImplementation::state_.

    {
      repeat_();
      doneReadAhead_ = false;
      state_ = input::IsInvalid;
      rewind_();
    }

void RootInput::rewind_ ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 83 of file RootInput_source.cc.

References accessState_, primaryFileSequence_, and art::RootInput::AccessState::resetState().

{
  // Rewind to before the first event that was read.
  accessState_.resetState();
  primaryFileSequence_->rewind_();
}

std::unique_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::runPrincipal ( )

inlineprotectedinherited

Definition at line 234 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::cachedRunPrincipal_, and art::DecrepitRelicInputSourceImplementation::runPrincipal_.

Referenced by readRun().

    {
      cachedRunPrincipal_ = runPrincipal_.get();
      return std::move(runPrincipal_);
    }

cet::exempt_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::runPrincipalExemptPtr ( )

inlineprotectedinherited

Definition at line 223 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::cachedRunPrincipal_.

Referenced by nextItemType(), and readSubRun_().

    {
      return cachedRunPrincipal_;
    }

std::unique_ptr< RangeSetHandler > RootInput::runRangeSetHandler ( )

overrideprivatevirtual

Implements art::InputSource.

Definition at line 180 of file RootInput_source.cc.

References primaryFileSequence_.

{
  return primaryFileSequence_->runRangeSetHandler();
}

template<typename T >

bool art::RootInput::seekToEvent	(	T	eventSpec,
		bool	exact = false
	)

Definition at line 145 of file RootInput.h.

References accessState_, art::EventID::isValid(), art::RootInput::AccessState::lastReadEventID(), art::errors::LogicError, postSeekChecks(), primaryFileSequence_, art::RootInput::AccessState::rootFileForLastReadEvent(), art::EventID::runID(), art::RootInput::AccessState::SEEKING_EVENT, art::RootInput::AccessState::SEEKING_FILE, art::RootInput::AccessState::SEEKING_RUN, art::RootInput::AccessState::SEEKING_SUBRUN, art::RootInput::AccessState::setState(), art::RootInput::AccessState::setWantedEventID(), art::RootInput::AccessState::state(), art::EventID::subRunID(), and fhicl::detail::atom::value().

Referenced by evd::LandedSocket::postProcessEvent(), and evdb::EventDisplay::postProcessEvent().

  {
    if (accessState_.state()) {
      throw Exception(errors::LogicError)
        << "Attempted to initiate a random access seek "
        << "with one already in progress at state = " << accessState_.state()
        << ".\n";
    }
    EventID foundID = primaryFileSequence_->seekToEvent(eventSpec, exact);
    if (!foundID.isValid()) {
      return false;
    }
    foundID = postSeekChecks(foundID, eventSpec);
    accessState_.setWantedEventID(foundID);
    if (primaryFileSequence_->rootFile() !=
        accessState_.rootFileForLastReadEvent()) {
      accessState_.setState(AccessState::SEEKING_FILE);
    } else if (foundID.runID() != accessState_.lastReadEventID().runID()) {
      accessState_.setState(AccessState::SEEKING_RUN);
    } else if (foundID.subRunID() !=
               accessState_.lastReadEventID().subRunID()) {
      accessState_.setState(AccessState::SEEKING_SUBRUN);
    } else {
      accessState_.setState(AccessState::SEEKING_EVENT);
    }
    return true;
  }

void art::DecrepitRelicInputSourceImplementation::setEventPrincipal ( std::unique_ptr< EventPrincipal > &&  ep )

protectedinherited

Definition at line 105 of file DecrepitRelicInputSourceImplementation.cc.

References art::DecrepitRelicInputSourceImplementation::cachedSubRunPrincipal_, and art::DecrepitRelicInputSourceImplementation::eventPrincipal_.

Referenced by art::DecrepitRelicInputSourceImplementation::eventPrincipal(), and nextItemType().

  {
    assert(cachedSubRunPrincipal_);
    eventPrincipal_ = std::move(ep);
    eventPrincipal_->setSubRunPrincipal(cachedSubRunPrincipal_);
  }

void art::DecrepitRelicInputSourceImplementation::setRunPrincipal ( std::unique_ptr< RunPrincipal > &&  rp )

protectedinherited

Definition at line 89 of file DecrepitRelicInputSourceImplementation.cc.

References art::DecrepitRelicInputSourceImplementation::runPrincipal_.

Referenced by art::DecrepitRelicInputSourceImplementation::eventPrincipal(), and nextItemType().

  {
    runPrincipal_ = std::move(rp);
  }

void art::DecrepitRelicInputSourceImplementation::setSubRunPrincipal ( std::unique_ptr< SubRunPrincipal > &&  srp )

protectedinherited

Definition at line 96 of file DecrepitRelicInputSourceImplementation.cc.

References art::DecrepitRelicInputSourceImplementation::cachedRunPrincipal_, and art::DecrepitRelicInputSourceImplementation::subRunPrincipal_.

Referenced by art::DecrepitRelicInputSourceImplementation::eventPrincipal(), and nextItemType().

  {
    assert(cachedRunPrincipal_);
    subRunPrincipal_ = std::move(srp);
    subRunPrincipal_->setRunPrincipal(cachedRunPrincipal_);
  }

void art::DecrepitRelicInputSourceImplementation::setTimestamp ( Timestamp const &  theTime )

inlineprotectedinherited

To set the current time, as seen by the input source.

Definition at line 205 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::time_.

Referenced by art::DecrepitRelicInputSourceImplementation::readEvent(), and art::EmptyEvent::rewind_().

    {
      time_ = theTime;
    }

void art::DecrepitRelicInputSourceImplementation::skipEvents ( int  offset )

overridevirtualinherited

Skip the number of events specified. Offset may be negative.

Reimplemented from art::InputSource.

Definition at line 307 of file DecrepitRelicInputSourceImplementation.cc.

References art::DecrepitRelicInputSourceImplementation::skip().

  {
    this->skip(offset);
  }

input::ItemType art::DecrepitRelicInputSourceImplementation::state ( ) const

inlineprotectedinherited

Definition at line 211 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::state_.

Referenced by art::RootInput::AccessState::state().

    {
      return state_;
    }

std::unique_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::subRunPrincipal ( )

inlineprotectedinherited

Definition at line 241 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::cachedSubRunPrincipal_, and art::DecrepitRelicInputSourceImplementation::subRunPrincipal_.

Referenced by readSubRun().

    {
      cachedSubRunPrincipal_ = subRunPrincipal_.get();
      return std::move(subRunPrincipal_);
    }

cet::exempt_ptr<SubRunPrincipal> art::DecrepitRelicInputSourceImplementation::subRunPrincipalExemptPtr ( )

inlineprotectedinherited

Definition at line 228 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::cachedSubRunPrincipal_.

    {
      return cachedSubRunPrincipal_;
    }

std::unique_ptr< RangeSetHandler > RootInput::subRunRangeSetHandler ( )

overrideprivatevirtual

Implements art::InputSource.

Definition at line 208 of file RootInput_source.cc.

References primaryFileSequence_.

{
  return primaryFileSequence_->subRunRangeSetHandler();
}

Timestamp const& art::DecrepitRelicInputSourceImplementation::timestamp ( ) const

inlineinherited

Accessor for the current time, as seen by the input source.

Definition at line 190 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::time_.

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

    {
      return time_;
    }

Member Data Documentation

AccessState art::RootInput::accessState_

private

Definition at line 109 of file RootInput.h.

Referenced by nextItemType(), postSeekChecks(), readEvent_(), readFile(), readRun(), readSubRun(), rewind_(), RootInput(), and seekToEvent().

InputFileCatalog art::RootInput::catalog_

private

Definition at line 107 of file RootInput.h.

Referenced by RootInput().

std::unique_ptr<RootInputFileSequence> art::RootInput::primaryFileSequence_

private

Definition at line 108 of file RootInput.h.

Referenced by closeFile_(), endJob(), finish(), getNextItemType(), nextItemType(), postSeekChecks(), readEvent_(), readFile_(), readRun_(), readSubRun_(), rewind_(), RootInput(), runRangeSetHandler(), seekToEvent(), and subRunRangeSetHandler().

---

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

• art/Framework/IO/Root/RootInput.h
• art/Framework/IO/Root/RootInput_source.cc