#include <DecrepitRelicInputSourceImplementation.h>

Inheritance diagram for art::DecrepitRelicInputSourceImplementation:

Classes
struct	Config

Public Member Functions
	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	finish ()

virtual input::ItemType	nextItemType () override

virtual void	closeFile () override

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 void	doBeginJob () override

virtual void	doEndJob () 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

virtual std::unique_ptr< RangeSetHandler >	runRangeSetHandler ()=0

virtual std::unique_ptr< RangeSetHandler >	subRunRangeSetHandler ()=0

ModuleDescription const &	moduleDescription () const

ProcessConfiguration const &	processConfiguration () const

Protected Member Functions
input::ItemType	state () const

void	setState (input::ItemType)

void	reset ()

Private Member Functions
virtual input::ItemType	getNextItemType ()=0

virtual std::unique_ptr< RunPrincipal >	readRun_ ()=0

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

virtual std::unique_ptr< EventPrincipal >	readEvent_ ()=0

virtual std::unique_ptr< FileBlock >	readFile_ ()

virtual void	closeFile_ ()

virtual void	beginJob ()

virtual void	endJob ()

virtual void	skip (int)

virtual void	rewind_ ()

Private Attributes
ProcessingMode	processingMode_ {RunsSubRunsAndEvents}

int	maxEvents_

int	maxSubRuns_

int const	reportFrequency_

int	remainingEvents_

int	remainingSubRuns_

int	numberOfEventsRead_ {}

input::ItemType	state_ {input::IsInvalid}

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

Detailed Description

Definition at line 58 of file DecrepitRelicInputSourceImplementation.h.

Constructor & Destructor Documentation

art::DecrepitRelicInputSourceImplementation::DecrepitRelicInputSourceImplementation	(	fhicl::TableFragment< Config > const &	config,
		ModuleDescription const &	desc
	)

Definition at line 40 of file DecrepitRelicInputSourceImplementation.cc.

     : InputSource{desc}
     , maxEvents_{config().maxEvents()}
     , maxSubRuns_{config().maxSubRuns()}
     , reportFrequency_{config().reportFrequency()}
     , remainingEvents_{maxEvents_}
     , remainingSubRuns_{maxSubRuns_}
   {
     if (reportFrequency_ < 0) {
       throw art::Exception(art::errors::Configuration)
         << "reportFrequency has a negative value, which is not meaningful.";
     }
     std::string const runMode{"Runs"};
     std::string const runSubRunMode{"RunsAndSubRuns"};
     std::string const processingMode = config().processingMode();
     if (processingMode == runMode) {
       processingMode_ = Runs;
     } else if (processingMode == "RunsAndSubRuns") {
       processingMode_ = RunsAndSubRuns;
     } else if (processingMode != Config::defaultMode()) {
       throw art::Exception(art::errors::Configuration)
         << "DecrepitRelicInputSourceImplementation::"
            "DecrepitRelicInputSourceImplementation()\n"
         << "The 'processingMode' parameter for sources has an illegal value '"
         << processingMode << "'\n"
         << "Legal values are '" << Config::defaultMode() << "', '"
         << runSubRunMode << "', or '" << runMode << "'.\n";
     }
   }

art::DecrepitRelicInputSourceImplementation::~DecrepitRelicInputSourceImplementation ( )

pure virtualdefaultnoexcept

art::DecrepitRelicInputSourceImplementation::DecrepitRelicInputSourceImplementation ( DecrepitRelicInputSourceImplementation && )

delete

Member Function Documentation

void art::DecrepitRelicInputSourceImplementation::beginJob ( )

privatevirtual

Reimplemented in art::EmptyEvent.

Definition at line 217 of file DecrepitRelicInputSourceImplementation.cc.

218 {}

void art::DecrepitRelicInputSourceImplementation::closeFile ( )

overridevirtual

Implements art::InputSource.

Definition at line 153 of file DecrepitRelicInputSourceImplementation.cc.

   {
     return closeFile_();
   }

void art::DecrepitRelicInputSourceImplementation::closeFile_ ( )

privatevirtual

Definition at line 159 of file DecrepitRelicInputSourceImplementation.cc.

160 {}

void art::DecrepitRelicInputSourceImplementation::doBeginJob ( )

overridevirtual

Reimplemented from art::InputSource.

Definition at line 211 of file DecrepitRelicInputSourceImplementation.cc.

   {
     beginJob();
   }

void art::DecrepitRelicInputSourceImplementation::doEndJob ( )

overridevirtual

Reimplemented from art::InputSource.

Definition at line 221 of file DecrepitRelicInputSourceImplementation.cc.

   {
     endJob();
   }

void art::DecrepitRelicInputSourceImplementation::endJob ( )

privatevirtual

Reimplemented in art::EmptyEvent.

Definition at line 227 of file DecrepitRelicInputSourceImplementation.cc.

228 {}

virtual void art::DecrepitRelicInputSourceImplementation::finish ( )

inlinevirtual

Definition at line 100 of file DecrepitRelicInputSourceImplementation.h.

101 {}

virtual input::ItemType art::DecrepitRelicInputSourceImplementation::getNextItemType ( )

privatepure virtual

Implemented in art::EmptyEvent.

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

Definition at line 312 of file DecrepitRelicInputSourceImplementation.cc.

   {
     detail::issue_reports(numberOfEventsRead_, eventID);
   }

int art::DecrepitRelicInputSourceImplementation::maxEvents ( ) const

Definition at line 274 of file DecrepitRelicInputSourceImplementation.cc.

   {
     return maxEvents_;
   }

int art::DecrepitRelicInputSourceImplementation::maxSubRuns ( ) const

Definition at line 290 of file DecrepitRelicInputSourceImplementation.cc.

   {
     return maxSubRuns_;
   }

input::ItemType art::DecrepitRelicInputSourceImplementation::nextItemType ( )

overridevirtual

Implements art::InputSource.

Definition at line 74 of file DecrepitRelicInputSourceImplementation.cc.

   {
     auto const oldState = state_;
     if (remainingEvents_ == 0) {
       // If the maximum event limit has been reached, stop.
       state_ = input::IsStop;
       return state_;
     }
     if (remainingSubRuns_ == 0) {
       // If the maximum subRun limit has been reached, stop
       // when reaching a new file, run, or subRun.
       if (oldState == input::IsInvalid || oldState == input::IsFile ||
           oldState == input::IsRun || processingMode_ != RunsSubRunsAndEvents) {
         state_ = input::IsStop;
         return state_;
       }
     }
     auto newState = getNextItemType();
     while (true) {
       if ((newState == input::IsEvent) &&
           (processingMode_ != RunsSubRunsAndEvents)) {
         newState = getNextItemType();
         continue;
       }
       if ((newState == input::IsSubRun) && (processingMode_ == Runs)) {
         newState = getNextItemType();
         continue;
       }
       break;
     }
     if (newState == input::IsStop) {
       state_ = input::IsStop;
       // FIXME: upon the advent of a catalog system which can do
       // something intelligent with the difference between whole-file
       // success, partial-file success, partial-file failure and
       // whole-file failure (such as file-open failure), we will need to
       // communicate that difference here. The file disposition options
       // as they are now (and the mapping to any concrete implementation
       // we are are aware of currently) are not sufficient to the task,
       // so we deliberately do not distinguish here between partial-file
       // and whole-file success in particular.
       finish();
       return state_;
     } else if (newState == input::IsFile || oldState == input::IsInvalid) {
       state_ = input::IsFile;
       return state_;
     } else if (newState == input::IsRun || oldState == input::IsFile) {
       state_ = input::IsRun;
       return state_;
     } else if (newState == input::IsSubRun || oldState == input::IsRun) {
       assert(processingMode_ != Runs);
       state_ = input::IsSubRun;
       return state_;
     }
     assert(processingMode_ == RunsSubRunsAndEvents);
     state_ = input::IsEvent;
     return state_;
   }

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

delete

DecrepitRelicInputSourceImplementation& art::DecrepitRelicInputSourceImplementation::operator= ( DecrepitRelicInputSourceImplementation && )

delete

InputSource::ProcessingMode art::DecrepitRelicInputSourceImplementation::processingMode ( ) const

Definition at line 266 of file DecrepitRelicInputSourceImplementation.cc.

   {
     return processingMode_;
   }

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

overridevirtual

Implements art::InputSource.

Definition at line 189 of file DecrepitRelicInputSourceImplementation.cc.

   {
     assert(state_ == input::IsEvent);
     assert(remainingEvents_ != 0);
     auto ep = readEvent_();
     assert(srp->run() == ep->run());
     assert(srp->subRun() == ep->subRun());
     ep->setSubRunPrincipal(srp);
     if (ep.get() != nullptr) {
       if (remainingEvents_ > 0) {
         --remainingEvents_;
       }
       ++numberOfEventsRead_;
       if ((reportFrequency_ > 0) && !(numberOfEventsRead_ % reportFrequency_)) {
         issueReports(ep->eventID());
       }
     }
     return ep;
   }

virtual std::unique_ptr<EventPrincipal> art::DecrepitRelicInputSourceImplementation::readEvent_ ( )

privatepure virtual

Implemented in art::EmptyEvent.

std::unique_ptr< FileBlock > art::DecrepitRelicInputSourceImplementation::readFile ( )

overridevirtual

Read next file.

Implements art::InputSource.

Definition at line 135 of file DecrepitRelicInputSourceImplementation.cc.

   {
     assert(state_ == input::IsFile);
     assert((remainingEvents_ != 0) && (remainingSubRuns_ != 0));
     return readFile_();
   }

unique_ptr< FileBlock > art::DecrepitRelicInputSourceImplementation::readFile_ ( )

privatevirtual

Definition at line 147 of file DecrepitRelicInputSourceImplementation.cc.

   {
     return make_unique<FileBlock>();
   }

unique_ptr< RunPrincipal > art::DecrepitRelicInputSourceImplementation::readRun ( )

overridevirtual

Implements art::InputSource.

Definition at line 163 of file DecrepitRelicInputSourceImplementation.cc.

   {
     // Note: For the moment, we do not support saving and restoring the state of
     // the random number generator if random numbers are generated during
     // processing of runs (e.g. beginRun(), endRun())
     assert(state_ == input::IsRun);
     assert((remainingEvents_ != 0) && (remainingSubRuns_ != 0));
     return readRun_();
   }

virtual std::unique_ptr<RunPrincipal> art::DecrepitRelicInputSourceImplementation::readRun_ ( )

privatepure virtual

Implemented in art::EmptyEvent.

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

overridevirtual

Implements art::InputSource.

Definition at line 174 of file DecrepitRelicInputSourceImplementation.cc.

   {
     // Note: For the moment, we do not support saving and restoring the state of
     // the random number generator if random numbers are generated during
     // processing of subRuns (e.g. beginSubRun(), endSubRun())
     assert(state_ == input::IsSubRun);
     assert((remainingEvents_ != 0) && (remainingSubRuns_ != 0));
     --remainingSubRuns_;
     auto srp = readSubRun_(rp);
     srp->setRunPrincipal(rp);
     return srp;
   }

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

privatepure virtual

Implemented in art::EmptyEvent.

int art::DecrepitRelicInputSourceImplementation::remainingEvents ( ) const

Definition at line 282 of file DecrepitRelicInputSourceImplementation.cc.

   {
     return remainingEvents_;
   }

int art::DecrepitRelicInputSourceImplementation::remainingSubRuns ( ) const

Definition at line 298 of file DecrepitRelicInputSourceImplementation.cc.

   {
     return remainingSubRuns_;
   }

void art::DecrepitRelicInputSourceImplementation::repeat_ ( )

Definition at line 305 of file DecrepitRelicInputSourceImplementation.cc.

   {
     remainingEvents_ = maxEvents_;
     remainingSubRuns_ = maxSubRuns_;
   }

void art::DecrepitRelicInputSourceImplementation::reset ( )

protected

Definition at line 330 of file DecrepitRelicInputSourceImplementation.cc.

   {
     state_ = input::IsInvalid;
   }

void art::DecrepitRelicInputSourceImplementation::rewind ( )

overridevirtual

Reimplemented from art::InputSource.

Definition at line 247 of file DecrepitRelicInputSourceImplementation.cc.

   {
     remainingEvents_ = maxEvents_;
     remainingSubRuns_ = maxSubRuns_;
     state_ = input::IsInvalid;
     rewind_();
   }

void art::DecrepitRelicInputSourceImplementation::rewind_ ( )

privatevirtual

Reimplemented in art::EmptyEvent.

Definition at line 256 of file DecrepitRelicInputSourceImplementation.cc.

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

void art::DecrepitRelicInputSourceImplementation::setState ( input::ItemType state )

protected

Definition at line 324 of file DecrepitRelicInputSourceImplementation.cc.

   {
     state_ = state;
   }

void art::DecrepitRelicInputSourceImplementation::skip ( int )

privatevirtual

Reimplemented in art::EmptyEvent.

Definition at line 237 of file DecrepitRelicInputSourceImplementation.cc.

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