art::InputSource Class Reference

#include "InputSource.h"

Inheritance diagram for art::InputSource:

Public Types
enum	ProcessingMode { Runs, RunsAndSubRuns, RunsSubRunsAndEvents }

Public Member Functions
virtual	~InputSource ()
	InputSource (ModuleDescription const &)
	InputSource (InputSource const &)=delete
	InputSource (InputSource &&)=delete
InputSource &	operator= (InputSource const &)=delete
InputSource &	operator= (InputSource &&)=delete
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
virtual void	doBeginJob ()
virtual void	doEndJob ()
virtual void	skipEvents (int n)
ModuleDescription const &	moduleDescription () const
ProcessConfiguration const &	processConfiguration () const

Static Public Member Functions
static ProcessingMode	mode (std::string const &modeString)

Private Attributes
ModuleDescription	moduleDescription_

Detailed Description

Definition at line 59 of file InputSource.h.

Member Enumeration Documentation

enum art::InputSource::ProcessingMode

Enumerator
Runs
RunsAndSubRuns
RunsSubRunsAndEvents

Definition at line 61 of file InputSource.h.

                        {
      Runs,                // 0
      RunsAndSubRuns,      // 1
      RunsSubRunsAndEvents // 2
    };

Constructor & Destructor Documentation

art::InputSource::~InputSource ( )

virtualdefault

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

explicit

Definition at line 27 of file InputSource.cc.

                                                      : moduleDescription_{md}
  {}

art::InputSource::InputSource ( InputSource const &  )

delete

art::InputSource::InputSource ( InputSource &&  )

delete

Member Function Documentation

virtual void art::InputSource::closeFile ( )

pure virtual

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

void art::InputSource::doBeginJob ( )

virtual

Reimplemented in art::EmptyEvent.

Definition at line 54 of file InputSource.cc.

  {}

void art::InputSource::doEndJob ( )

virtual

Reimplemented in art::EmptyEvent.

Definition at line 58 of file InputSource.cc.

  {}

InputSource::ProcessingMode art::InputSource::mode ( std::string const &  modeString )

static

Definition at line 9 of file InputSource.cc.

References art::errors::Configuration, Runs, RunsAndSubRuns, and RunsSubRunsAndEvents.

Referenced by art::ProcessingLimits::ProcessingLimits().

  {
    if (modeString == "Runs") {
      return Runs;
    }
    if (modeString == "RunsAndSubRuns") {
      return RunsAndSubRuns;
    }
    if (modeString == "RunsSubRunsAndEvents") {
      return RunsSubRunsAndEvents;
    }
    throw Exception(errors::Configuration)
      << "The 'processingMode' parameter for sources has an illegal value '"
      << modeString << "'\n"
      << "Legal values are 'Runs', 'RunsAndSubRuns', or "
         "'RunsSubRunsAndEvents'.\n";
  }

ModuleDescription const & art::InputSource::moduleDescription

(

)

const

Definition at line 31 of file InputSource.cc.

References moduleDescription_.

Referenced by art::EmptyEvent::readRun(), and art::EmptyEvent::readSubRun().

  {
    return moduleDescription_;
  }

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

pure virtual

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

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

delete

InputSource& art::InputSource::operator= ( InputSource &&  )

delete

ProcessConfiguration const & art::InputSource::processConfiguration

(

)

const

Definition at line 37 of file InputSource.cc.

References moduleDescription_, and art::ModuleDescription::processConfiguration().

Referenced by art::EmptyEvent::readEvent(), art::EmptyEvent::readRun(), and art::EmptyEvent::readSubRun().

  {
    return moduleDescription_.processConfiguration();
  }

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

pure virtual

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

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

pure virtual

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

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

pure virtual

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

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

pure virtual

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

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

pure virtual

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

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

virtual

Reimplemented in art::EmptyEvent.

Definition at line 43 of file InputSource.cc.

References art::errors::Configuration.

  {
    throw Exception(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 >, and art::EmptyEvent.

Member Data Documentation

ModuleDescription art::InputSource::moduleDescription_

private

Definition at line 106 of file InputSource.h.

Referenced by moduleDescription(), and processConfiguration().

---

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

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