#include <RootInput.h>

Inheritance diagram for art::RootInput:

Classes
class	AccessState

struct	Config

Public Types
using	Parameters = fhicl::WrappedTable< Config, Config::KeysToIgnore >

Public Types inherited from art::InputSource
enum	ProcessingMode { Runs, RunsAndSubRuns, RunsSubRunsAndEvents }

Public Member Functions
	~RootInput ()

	RootInput (Parameters const &, InputSourceDescription &)

	RootInput (RootInput const &)=delete

	RootInput (RootInput &&)=delete

RootInput &	operator= (RootInput const &)=delete

RootInput &	operator= (RootInput &&)=delete

template<typename T >
bool	seekToEvent (T eventSpec, bool exact=false)

Public Member Functions inherited from art::DecrepitRelicInputSourceImplementation
	DecrepitRelicInputSourceImplementation (fhicl::TableFragment< Config > const &, ModuleDescription const &)

virtual	~DecrepitRelicInputSourceImplementation () noexcept=0

	DecrepitRelicInputSourceImplementation (DecrepitRelicInputSourceImplementation &&)=delete

DecrepitRelicInputSourceImplementation &	operator= (DecrepitRelicInputSourceImplementation const &)=delete

DecrepitRelicInputSourceImplementation &	operator= (DecrepitRelicInputSourceImplementation &&)=delete

virtual void	closeFile () override

virtual void	doBeginJob () override

virtual void	doEndJob () override

virtual std::unique_ptr< EventPrincipal >	readEvent (EventID const &) override

virtual void	skipEvents (int offset) override

virtual void	rewind () override

ProcessingMode	processingMode () const

int	maxEvents () const

int	remainingEvents () const

int	maxSubRuns () const

int	remainingSubRuns () const

void	repeat_ ()

void	issueReports (EventID const &eventID)

Public Member Functions inherited from art::InputSource
virtual	~InputSource () noexcept

	InputSource (ModuleDescription const &)

	InputSource (InputSource const &)=delete

	InputSource (InputSource &&)=delete

InputSource &	operator= (InputSource const &)=delete

InputSource &	operator= (InputSource &&)=delete

ModuleDescription const &	moduleDescription () const

ProcessConfiguration const &	processConfiguration () const

Private Types
typedef input::EntryNumber	EntryNumber

Private Member Functions
void	finish () override

virtual input::ItemType	nextItemType () override

virtual std::unique_ptr< FileBlock >	readFile () override
	Read next file. More...

virtual std::unique_ptr< RunPrincipal >	readRun () override

virtual std::unique_ptr< SubRunPrincipal >	readSubRun (cet::exempt_ptr< RunPrincipal const >) override

virtual std::unique_ptr< EventPrincipal >	readEvent (cet::exempt_ptr< SubRunPrincipal const >) override

virtual std::unique_ptr< RangeSetHandler >	runRangeSetHandler () override

virtual std::unique_ptr< RangeSetHandler >	subRunRangeSetHandler () override

virtual void	endJob () override

virtual input::ItemType	getNextItemType () override

virtual std::unique_ptr< RunPrincipal >	readRun_ () override

virtual std::unique_ptr< SubRunPrincipal >	readSubRun_ (cet::exempt_ptr< RunPrincipal const >) override

virtual std::unique_ptr< EventPrincipal >	readEvent_ () override

virtual std::unique_ptr< FileBlock >	readFile_ () override

virtual void	closeFile_ () override

virtual void	rewind_ () override

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

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_ {}

Additional Inherited Members
Protected Member Functions inherited from art::DecrepitRelicInputSourceImplementation
input::ItemType	state () const

void	setState (input::ItemType)

void	reset ()

Detailed Description

Definition at line 27 of file RootInput.h.

Member Typedef Documentation

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

private

Definition at line 91 of file RootInput.h.

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

Definition at line 47 of file RootInput.h.

Constructor & Destructor Documentation

RootInput::~RootInput ( )

Definition at line 89 of file RootInput_source.cc.

89 {}

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

Definition at line 91 of file RootInput_source.cc.

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

art::RootInput::RootInput ( RootInput const & )

delete

art::RootInput::RootInput ( RootInput && )

delete

Member Function Documentation

void RootInput::closeFile_ ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 112 of file RootInput_source.cc.

 {
   primaryFileSequence_->closeFile_();
 }

void RootInput::endJob ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 106 of file RootInput_source.cc.

 {
   primaryFileSequence_->endJob();
 }

void RootInput::finish ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 132 of file RootInput_source.cc.

 {
   primaryFileSequence_->finish();
 }

input::ItemType RootInput::getNextItemType ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 126 of file RootInput_source.cc.

 {
   return primaryFileSequence_->getNextItemType();
 }

input::ItemType RootInput::nextItemType ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 138 of file RootInput_source.cc.

 {
   switch (accessState_.state()) {
     case AccessState::SEQUENTIAL:
       return DecrepitRelicInputSourceImplementation::nextItemType();
     case AccessState::SEEKING_FILE:
       return input::IsFile;
     case AccessState::SEEKING_RUN:
       primaryFileSequence_->readIt(accessState_.wantedEventID().runID());
       return input::IsRun;
     case AccessState::SEEKING_SUBRUN:
       primaryFileSequence_->readIt(accessState_.wantedEventID().subRunID());
       return input::IsSubRun;
     case AccessState::SEEKING_EVENT: {
       primaryFileSequence_->readIt(accessState_.wantedEventID(), true);
       accessState_.setLastReadEventID(accessState_.wantedEventID());
       accessState_.setRootFileForLastReadEvent(
         primaryFileSequence_->rootFileForLastReadEvent());
       return input::IsEvent;
     }
     default:
       throw Exception(errors::LogicError) << "RootInputSource::nextItemType "
                                              "encountered an unknown "
                                              "AccessState.\n";
   }
 }

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

delete

RootInput& art::RootInput::operator= ( RootInput && )

delete

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 233 of file RootInput.h.

   {
     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 249 of file RootInput.h.

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

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

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 247 of file RootInput_source.cc.

 {
   return readEvent_(srp);
 }

unique_ptr< EventPrincipal > RootInput::readEvent_ ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 270 of file RootInput_source.cc.

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

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

private

Definition at line 253 of file RootInput_source.cc.

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

unique_ptr< FileBlock > RootInput::readFile ( )

overrideprivatevirtual

Read next file.

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 166 of file RootInput_source.cc.

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

unique_ptr< FileBlock > RootInput::readFile_ ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 183 of file RootInput_source.cc.

 {
   return primaryFileSequence_->readFile_();
 }

unique_ptr< RunPrincipal > RootInput::readRun ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 189 of file RootInput_source.cc.

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

unique_ptr< RunPrincipal > RootInput::readRun_ ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 206 of file RootInput_source.cc.

 {
   return primaryFileSequence_->readRun_();
 }

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

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 218 of file RootInput_source.cc.

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

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

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 235 of file RootInput_source.cc.

 {
   return primaryFileSequence_->readSubRun_(rp);
 }

void RootInput::rewind_ ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 118 of file RootInput_source.cc.

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

unique_ptr< RangeSetHandler > RootInput::runRangeSetHandler ( )

overrideprivatevirtual

Implements art::InputSource.

Definition at line 212 of file RootInput_source.cc.

 {
   return primaryFileSequence_->runRangeSetHandler();
 }

template<typename T >

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

Definition at line 203 of file RootInput.h.

   {
     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;
   }

unique_ptr< RangeSetHandler > RootInput::subRunRangeSetHandler ( )

overrideprivatevirtual

Implements art::InputSource.

Definition at line 241 of file RootInput_source.cc.

 {
   return primaryFileSequence_->subRunRangeSetHandler();
 }

Member Data Documentation

AccessState art::RootInput::accessState_ {}

private

Definition at line 198 of file RootInput.h.

InputFileCatalog art::RootInput::catalog_

private

Definition at line 196 of file RootInput.h.

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

private

Definition at line 197 of file RootInput.h.

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

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

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation