art::InputSource Class Reference

#include "InputSource.h"

Inheritance diagram for art::InputSource:

Public Types
enum	ProcessingMode { Runs, RunsAndSubRuns, RunsSubRunsAndEvents }

Public Member Functions
	InputSource (ModuleDescription const &md)
virtual	~InputSource () noexcept=default
auto const &	moduleDescription () const
auto const &	processConfiguration () const
virtual std::unique_ptr< EventPrincipal >	readEvent (EventID const &id)
virtual void	skipEvents (int n)
virtual void	rewind ()
virtual void	doBeginJob ()
virtual void	doEndJob ()
virtual input::ItemType	nextItemType ()=0
virtual std::unique_ptr< FileBlock >	readFile ()=0
virtual void	closeFile ()=0
virtual std::unique_ptr< RunPrincipal >	readRun ()=0
virtual std::unique_ptr< SubRunPrincipal >	readSubRun (cet::exempt_ptr< RunPrincipal const > rp)=0
virtual std::unique_ptr< EventPrincipal >	readEvent (cet::exempt_ptr< SubRunPrincipal const > srp)=0
virtual std::unique_ptr< RangeSetHandler >	runRangeSetHandler ()=0
virtual std::unique_ptr< RangeSetHandler >	subRunRangeSetHandler ()=0

Private Attributes
ModuleDescription	moduleDescription_

Detailed Description

Definition at line 48 of file InputSource.h.

Member Enumeration Documentation

enum art::InputSource::ProcessingMode

Enumerator
Runs
RunsAndSubRuns
RunsSubRunsAndEvents

Definition at line 52 of file InputSource.h.

{ Runs, RunsAndSubRuns, RunsSubRunsAndEvents };

Constructor & Destructor Documentation

art::InputSource::InputSource ( ModuleDescription const &  md )

inlineexplicit

Definition at line 54 of file InputSource.h.

                                                      : moduleDescription_{md}
    {}

virtual art::InputSource::~InputSource ( )

virtualdefaultnoexcept

Member Function Documentation

virtual void art::InputSource::closeFile ( )

pure virtual

Implemented in art::Source< T >, and art::DecrepitRelicInputSourceImplementation.

void art::InputSource::doBeginJob ( )

virtual

Reimplemented in art::DecrepitRelicInputSourceImplementation.

Definition at line 31 of file InputSource.cc.

{}

void art::InputSource::doEndJob ( )

virtual

Reimplemented in art::DecrepitRelicInputSourceImplementation.

Definition at line 35 of file InputSource.cc.

{}

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

inline

Definition at line 59 of file InputSource.h.

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

    {
      return moduleDescription_;
    }

virtual input::ItemType art::InputSource::nextItemType ( )

pure virtual

Implemented in art::Source< T >, art::RootInput, and art::DecrepitRelicInputSourceImplementation.

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

inline

Definition at line 64 of file InputSource.h.

References n.

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

    {
      return moduleDescription_.processConfiguration();
    }

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

virtual

Reimplemented in art::DecrepitRelicInputSourceImplementation.

Definition at line 4 of file InputSource.cc.

References art::errors::Configuration.

{
  throw art::Exception(art::errors::Configuration)
    << "The application has tried to peform random access on an input source\n"
    << "that does not support random access. Please reconfigure the program\n"
    << "to use an input source that supports random access (e.g. RootInput)\n";
}

virtual std::unique_ptr<EventPrincipal> art::InputSource::readEvent ( cet::exempt_ptr< SubRunPrincipal const >  srp )

pure virtual

Implemented in art::Source< T >, art::RootInput, and art::DecrepitRelicInputSourceImplementation.

virtual std::unique_ptr<FileBlock> art::InputSource::readFile ( )

pure virtual

Implemented in art::Source< T >, art::RootInput, and art::DecrepitRelicInputSourceImplementation.

virtual std::unique_ptr<RunPrincipal> art::InputSource::readRun ( )

pure virtual

Implemented in art::Source< T >, art::RootInput, and art::DecrepitRelicInputSourceImplementation.

virtual std::unique_ptr<SubRunPrincipal> art::InputSource::readSubRun ( cet::exempt_ptr< RunPrincipal const >  rp )

pure virtual

Implemented in art::Source< T >, art::RootInput, and art::DecrepitRelicInputSourceImplementation.

void art::InputSource::rewind ( )

virtual

Reimplemented in art::DecrepitRelicInputSourceImplementation.

Definition at line 22 of file InputSource.cc.

References art::errors::Configuration.

{
  throw art::Exception(art::errors::Configuration)
    << "The application has tried to rewind an input source\n"
    << "that does not support rewinding. Please reconfigure the program\n"
    << "to use an input source that supports random access (e.g. RootInput)\n";
}

virtual std::unique_ptr<RangeSetHandler> art::InputSource::runRangeSetHandler ( )

pure virtual

Implemented in art::Source< T >, art::RootInput, and art::EmptyEvent.

void art::InputSource::skipEvents ( int  n )

virtual

Reimplemented in art::DecrepitRelicInputSourceImplementation.

Definition at line 13 of file InputSource.cc.

References art::errors::Configuration.

{
  throw art::Exception(art::errors::Configuration)
    << "The application has tried to peform random access on an input source\n"
    << "that does not support random access. Please reconfigure the program\n"
    << "to use an input source that supports random access (e.g. RootInput)\n";
}

virtual std::unique_ptr<RangeSetHandler> art::InputSource::subRunRangeSetHandler ( )

pure virtual

Implemented in art::Source< T >, art::RootInput, and art::EmptyEvent.

Member Data Documentation

ModuleDescription art::InputSource::moduleDescription_

private

Definition at line 100 of file InputSource.h.

---

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

• art/Framework/Core/InputSource.h
• art/Framework/Core/InputSource.cc