Inheritance diagram for art::EmptyEvent:

Classes
struct	Config

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

enum	ProcessingMode { Runs, RunsAndSubRuns, RunsSubRunsAndEvents }

Public Member Functions
	EmptyEvent (Parameters const &config, InputSourceDescription &desc)

unsigned int	numberEventsInRun () const

unsigned int	numberEventsInSubRun () const

unsigned int	eventCreationDelay () const

unsigned int	numberEventsInThisRun () const

unsigned int	numberEventsInThisSubRun () const

input::ItemType	nextItemType () override

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

std::unique_ptr< EventPrincipal >	readEvent (EventID const &) override
	Read a specific event. More...

std::unique_ptr< SubRunPrincipal >	readSubRun (cet::exempt_ptr< RunPrincipal const > rp) override
	Read next subRun. More...

std::unique_ptr< RunPrincipal >	readRun () override
	Read next run. More...

std::unique_ptr< FileBlock >	readFile () override
	Read next file. 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

virtual void	finish ()

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 Member Functions
art::input::ItemType	getNextItemType () override

void	setRunAndEventInfo ()

std::unique_ptr< EventPrincipal >	readEvent_ () override

std::unique_ptr< SubRunPrincipal >	readSubRun_ () override

std::unique_ptr< RunPrincipal >	readRun_ () override

std::unique_ptr< RangeSetHandler >	runRangeSetHandler () override

std::unique_ptr< RangeSetHandler >	subRunRangeSetHandler () override

void	skip (int offset) override

void	rewind_ () override

void	beginJob () override

void	endJob () override

void	reallyReadEvent (bool const lastEventInSubRun)

std::unique_ptr< EmptyEventTimestampPlugin >	makePlugin_ (OptionalDelegatedParameter const &maybeConfig)

Private Attributes
unsigned int	numberEventsInRun_

unsigned int	numberEventsInSubRun_

unsigned int	eventCreationDelay_

unsigned int	numberEventsInThisRun_ {}

unsigned int	numberEventsInThisSubRun_ {}

EventID	eventID_ {}

EventID	origEventID_ {}

bool	newRun_ {true}

bool	newSubRun_ {true}

bool	subRunSet_ {false}

bool	eventSet_ {false}

bool	skipEventIncrement_ {true}

bool	resetEventOnSubRun_

std::unique_ptr< EventPrincipal >	ep_ {}

cet::BasicPluginFactory	pluginFactory_ {}

std::unique_ptr< EmptyEventTimestampPlugin >	plugin_

Detailed Description

Definition at line 38 of file EmptyEvent_source.cc.

Member Typedef Documentation

using art::EmptyEvent::Parameters = WrappedTable<Config, Config::KeysToIgnore>

Definition at line 74 of file EmptyEvent_source.cc.

Member Enumeration Documentation

enum art::InputSource::ProcessingMode

inherited

Enumerator
Runs
RunsAndSubRuns
RunsSubRunsAndEvents

Definition at line 52 of file InputSource.h.

52 { Runs, RunsAndSubRuns, RunsSubRunsAndEvents };

art::InputSource::RunsSubRunsAndEvents

Definition: InputSource.h:52

art::InputSource::Runs

Definition: InputSource.h:52

art::InputSource::RunsAndSubRuns

Definition: InputSource.h:52

Constructor & Destructor Documentation

art::EmptyEvent::EmptyEvent	(	Parameters const &	config,
		InputSourceDescription &	desc
	)

explicit

Definition at line 149 of file EmptyEvent_source.cc.

References eventCreationDelay_, eventID_, art::EventID::firstEvent(), art::RunID::firstRun(), art::SubRunID::firstSubRun(), makePlugin_(), art::InputSourceDescription::moduleDescription, numberEventsInRun_, numberEventsInSubRun_, origEventID_, plugin_, resetEventOnSubRun_, art::SubRunID::run(), art::RunID::run(), and art::SubRunID::subRun().

   : DecrepitRelicInputSourceImplementation{config().drisi_config,
                                            desc.moduleDescription}
   , numberEventsInRun_{static_cast<uint32_t>(config().numberEventsInRun())}
   , numberEventsInSubRun_{static_cast<uint32_t>(
       config().numberEventsInSubRun())}
   , eventCreationDelay_{config().eventCreationDelay()}
   , resetEventOnSubRun_{config().resetEventOnSubRun()}
   , plugin_{makePlugin_(config().timestampPlugin)}
 {
 
   RunNumber_t firstRun{};
   bool haveFirstRun = config().firstRun(firstRun);
   SubRunNumber_t firstSubRun{};
   bool haveFirstSubRun = config().firstSubRun(firstSubRun);
   EventNumber_t firstEvent{};
   bool haveFirstEvent = config().firstEvent(firstEvent);
   RunID firstRunID = haveFirstRun ? RunID(firstRun) : RunID::firstRun();
   SubRunID firstSubRunID = haveFirstSubRun ?
                              SubRunID(firstRunID.run(), firstSubRun) :
                              SubRunID::firstSubRun(firstRunID);
   origEventID_ =
     haveFirstEvent ?
       EventID(firstSubRunID.run(), firstSubRunID.subRun(), firstEvent) :
       EventID::firstEvent(firstSubRunID);
   eventID_ = origEventID_;
 }

Member Function Documentation

void art::EmptyEvent::beginJob ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 235 of file EmptyEvent_source.cc.

References plugin_.

 {
   if (plugin_) {
     plugin_->doBeginJob();
   }
 }

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 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 art::EmptyEvent::endJob ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 243 of file EmptyEvent_source.cc.

References plugin_.

 {
   if (plugin_) {
     plugin_->doEndJob();
   }
 }

unsigned int art::EmptyEvent::eventCreationDelay ( ) const

inline

Definition at line 89 of file EmptyEvent_source.cc.

   {
     return eventCreationDelay_;
   }

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 art::RootInput::readEvent_().

     {
       return std::move(eventPrincipal_);
     }

virtual void art::DecrepitRelicInputSourceImplementation::finish ( )

inlineprotectedvirtualinherited

Reimplemented in art::RootInput.

Definition at line 219 of file DecrepitRelicInputSourceImplementation.h.

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

220 {}

art::input::ItemType art::EmptyEvent::getNextItemType ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 325 of file EmptyEvent_source.cc.

References ep_, eventID_, eventSet_, art::input::IsEvent, art::input::IsRun, art::input::IsStop, art::input::IsSubRun, art::RunID::isValid(), newRun_, newSubRun_, numberEventsInSubRun_, numberEventsInThisRun_, numberEventsInThisSubRun_, art::DecrepitRelicInputSourceImplementation::processingMode(), reallyReadEvent(), art::DecrepitRelicInputSourceImplementation::resetRunPrincipal(), art::DecrepitRelicInputSourceImplementation::resetSubRunPrincipal(), art::EventID::runID(), art::InputSource::Runs, setRunAndEventInfo(), art::EventID::subRunID(), and subRunSet_.

 {
   if (newRun_) {
     if (!eventID_.runID().isValid()) {
       ep_.reset();
       return input::IsStop;
     }
     return input::IsRun;
   }
   if (newSubRun_) {
     return input::IsSubRun;
   }
   if (ep_.get() != nullptr)
     return input::IsEvent;
   EventID oldEventID = eventID_;
   if (!eventSet_) {
     subRunSet_ = false;
     setRunAndEventInfo();
     eventSet_ = true;
   }
   if (!eventID_.runID().isValid()) {
     ep_.reset();
     return input::IsStop;
   }
   if (oldEventID.runID() != eventID_.runID()) {
     //  New Run
     // reset these since this event is in the new run
     numberEventsInThisRun_ = 0;
     numberEventsInThisSubRun_ = 0;
     newRun_ = newSubRun_ = true;
     resetSubRunPrincipal();
     resetRunPrincipal();
     return input::IsRun;
   }
   // Same Run
   if (oldEventID.subRunID() != eventID_.subRunID()) {
     // New Subrun
     numberEventsInThisSubRun_ = 0;
     newSubRun_ = true;
     resetSubRunPrincipal();
     if (processingMode() != Runs) {
       return input::IsSubRun;
     }
   }
   ++numberEventsInThisRun_;
   ++numberEventsInThisSubRun_;
   bool const lastEventInSubRun =
     numberEventsInThisSubRun_ == numberEventsInSubRun_;
   reallyReadEvent(lastEventInSubRun);
   if (ep_.get() == nullptr) {
     return input::IsStop;
   }
   eventSet_ = false;
   return input::IsEvent;
 }

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
   }

std::unique_ptr< art::EmptyEventTimestampPlugin > art::EmptyEvent::makePlugin_ ( OptionalDelegatedParameter const & maybeConfig )

private

Definition at line 270 of file EmptyEvent_source.cc.

References art::errors::Configuration, e, fhicl::ParameterSet::get(), fhicl::OptionalDelegatedParameter::get_if_present(), pluginFactory_, and fhicl::detail::atom::value().

Referenced by EmptyEvent().

 {
   std::unique_ptr<art::EmptyEventTimestampPlugin> result;
   try {
     ParameterSet pset;
     if (maybeConfig.get_if_present(pset)) {
       auto const libspec = pset.get<std::string>("plugin_type");
       auto const pluginType = pluginFactory_.pluginType(libspec);
       if (pluginType ==
           cet::PluginTypeDeducer<EmptyEventTimestampPlugin>::value) {
         result =
           pluginFactory_.makePlugin<std::unique_ptr<EmptyEventTimestampPlugin>>(
             libspec, pset);
       } else {
         throw Exception(errors::Configuration, "EmptyEvent: ")
           << "unrecognized plugin type " << pluginType << "for plugin "
           << libspec << ".\n";
       }
     }
   }
   catch (cet::exception& e) {
     throw Exception(errors::Configuration, "EmptyEvent: ", e)
       << "Exception caught while processing plugin spec.\n";
   }
   return result;
 }

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 readRun_(), and readSubRun_().

     {
       return moduleDescription_;
     }

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

overridevirtualinherited

Implements art::InputSource.

Reimplemented in art::RootInput.

Definition at line 140 of file DecrepitRelicInputSourceImplementation.cc.

Referenced by art::RootInput::nextItemType().

   {
     if (doneReadAhead_) {
       return state_;
     }
     doneReadAhead_ = true;
     input::ItemType oldState = state_;
     if (eventLimitReached()) {
       // If the maximum event limit has been reached, stop.
       state_ = input::IsStop;
     } else if (subRunLimitReached()) {
       // 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;
       } else {
         input::ItemType newState = nextItemType_();
         if (newState == input::IsEvent) {
           assert(processingMode() == RunsSubRunsAndEvents);
           state_ = input::IsEvent;
         } else {
           state_ = input::IsStop;
         }
       }
     } else {
       input::ItemType newState = nextItemType_();
       if (newState == input::IsStop) {
         state_ = input::IsStop;
       } else if (newState == input::IsFile || oldState == input::IsInvalid) {
         state_ = input::IsFile;
       } else if (newState == input::IsRun || oldState == input::IsFile) {
         runPrincipal_ = readRun_();
         state_ = input::IsRun;
       } else if (newState == input::IsSubRun || oldState == input::IsRun) {
         assert(processingMode() != Runs);
         subRunPrincipal_ = readSubRun_();
         state_ = input::IsSubRun;
       } else {
         assert(processingMode() == RunsSubRunsAndEvents);
         state_ = input::IsEvent;
       }
     }
     if (state_ == input::IsStop) {
       subRunPrincipal_.reset();
       runPrincipal_.reset();
       // 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_;
   }

unsigned int art::EmptyEvent::numberEventsInRun ( ) const

inline

Definition at line 79 of file EmptyEvent_source.cc.

   {
     return numberEventsInRun_;
   }

unsigned int art::EmptyEvent::numberEventsInSubRun ( ) const

inline

Definition at line 84 of file EmptyEvent_source.cc.

   {
     return numberEventsInSubRun_;
   }

unsigned int art::EmptyEvent::numberEventsInThisRun ( ) const

inline

Definition at line 94 of file EmptyEvent_source.cc.

   {
     return numberEventsInThisRun_;
   }

unsigned int art::EmptyEvent::numberEventsInThisSubRun ( ) const

inline

Definition at line 99 of file EmptyEvent_source.cc.

References breakpoints::beginJob().

   {
     return numberEventsInThisSubRun_;
   }

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

inlineinherited

Definition at line 64 of file InputSource.h.

References n.

Referenced by readRun_(), readSubRun_(), reallyReadEvent(), and art::RootInput::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(), getNextItemType(), art::DecrepitRelicInputSourceImplementation::nextItemType(), art::DecrepitRelicInputSourceImplementation::nextItemType_(), readEvent_(), readSubRun_(), reallyReadEvent(), and art::RootInput::RootInput().

     {
       return processingMode_;
     }

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

overridevirtualinherited

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

Implements art::InputSource.

Reimplemented in art::RootInput.

Definition at line 273 of file DecrepitRelicInputSourceImplementation.cc.

Referenced by art::RootInput::readEvent_().

   {
     assert(doneReadAhead_);
     assert(state_ == input::IsEvent);
     assert(!eventLimitReached());
     doneReadAhead_ = false;
 
     eventPrincipal_ = readEvent_();
     assert(srp->run() == eventPrincipal_->run());
     assert(srp->subRun() == eventPrincipal_->subRun());
     eventPrincipal_->setSubRunPrincipal(srp);
     if (eventPrincipal_.get() != nullptr) {
       if (remainingEvents_ > 0)
         --remainingEvents_;
       ++readCount_;
       setTimestamp(eventPrincipal_->time());
       if ((reportFrequency_ > 0) && !(readCount_ % reportFrequency_)) {
         issueReports(eventPrincipal_->id());
       }
     }
     return std::move(eventPrincipal_);
   }

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 > EmptyEvent::readEvent_ ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 228 of file EmptyEvent_source.cc.

References ep_, art::DecrepitRelicInputSourceImplementation::processingMode(), and art::InputSource::RunsSubRunsAndEvents.

 {
   assert(ep_.get() != nullptr || processingMode() != RunsSubRunsAndEvents);
   return std::move(ep_);
 }

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

overridevirtualinherited

Read next subRun.

Implements art::InputSource.

Reimplemented in art::RootInput.

Definition at line 255 of file DecrepitRelicInputSourceImplementation.cc.

References art::DecrepitRelicInputSourceImplementation::cachedSubRunPrincipal_, art::DecrepitRelicInputSourceImplementation::doneReadAhead_, art::input::IsSubRun, art::DecrepitRelicInputSourceImplementation::limitReached(), art::DecrepitRelicInputSourceImplementation::remainingSubRuns_, art::DecrepitRelicInputSourceImplementation::state_, and art::DecrepitRelicInputSourceImplementation::subRunPrincipal_.

Referenced by art::RootInput::readSubRun().

   {
     // 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(doneReadAhead_);
     assert(state_ == input::IsSubRun);
     assert(!limitReached());
     doneReadAhead_ = false;
     --remainingSubRuns_;
     assert(subRunPrincipal_->run() == rp->run());
     subRunPrincipal_->setRunPrincipal(rp);
     cachedSubRunPrincipal_ = subRunPrincipal_.get();
     return std::move(subRunPrincipal_);
   }

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

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 202 of file EmptyEvent_source.cc.

References eventID_, art::Timestamp::invalidTimestamp(), art::InputSource::moduleDescription(), newSubRun_, art::Consumer::non_module_context(), plugin_, art::InputSource::processConfiguration(), art::DecrepitRelicInputSourceImplementation::processingMode(), art::InputSource::Runs, and art::EventID::subRunID().

 {
   if (processingMode() == Runs)
     return std::unique_ptr<SubRunPrincipal>{nullptr};
   auto ts = plugin_ ? plugin_->doBeginSubRunTimestamp(eventID_.subRunID()) :
                       Timestamp::invalidTimestamp();
   SubRunAuxiliary const subRunAux{
     eventID_.subRunID(), ts, Timestamp::invalidTimestamp()};
   auto srp_ptr = std::make_unique<SubRunPrincipal>(
     subRunAux, processConfiguration(), nullptr);
   if (plugin_) {
     SubRun const sr{
       *srp_ptr, moduleDescription(), Consumer::non_module_context()};
     plugin_->doBeginSubRun(sr);
   }
   newSubRun_ = false;
   return srp_ptr;
 }

void art::EmptyEvent::reallyReadEvent ( bool const lastEventInSubRun )

private

Definition at line 251 of file EmptyEvent_source.cc.

References art::EventAuxiliary::Any, ep_, eventID_, art::Timestamp::invalidTimestamp(), plugin_, art::InputSource::processConfiguration(), art::DecrepitRelicInputSourceImplementation::processingMode(), art::InputSource::RunsSubRunsAndEvents, and art::DecrepitRelicInputSourceImplementation::timestamp().

Referenced by getNextItemType().

 {
   if (processingMode() != RunsSubRunsAndEvents)
     return;
   auto timestamp = plugin_ ? plugin_->doEventTimestamp(eventID_) :
                              Timestamp::invalidTimestamp();
   EventAuxiliary const eventAux{
     eventID_, timestamp, false, EventAuxiliary::Any};
 
   ep_ = std::make_unique<EventPrincipal>(eventAux,
                                          processConfiguration(),
                                          nullptr,
                                          std::make_shared<History>(),
                                          std::make_unique<BranchMapper>(),
                                          std::make_unique<NoDelayedReader>(),
                                          lastEventInSubRun);
 }

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 getNextItemType(), and rewind_().

     {
       runPrincipal_.reset();
     }

void art::DecrepitRelicInputSourceImplementation::resetSubRunPrincipal ( )

inlineprotectedinherited

Definition at line 262 of file DecrepitRelicInputSourceImplementation.h.

References art::DecrepitRelicInputSourceImplementation::subRunPrincipal_.

Referenced by getNextItemType(), and 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 art::EmptyEvent::rewind_ ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 309 of file EmptyEvent_source.cc.

References eventID_, art::Timestamp::invalidTimestamp(), newRun_, newSubRun_, numberEventsInThisRun_, numberEventsInThisSubRun_, origEventID_, plugin_, art::DecrepitRelicInputSourceImplementation::resetRunPrincipal(), art::DecrepitRelicInputSourceImplementation::resetSubRunPrincipal(), art::DecrepitRelicInputSourceImplementation::setTimestamp(), and skipEventIncrement_.

 {
   if (plugin_) {
     plugin_->doRewind();
   }
   setTimestamp(Timestamp::invalidTimestamp());
   eventID_ = origEventID_;
   skipEventIncrement_ = true;
   numberEventsInThisRun_ = 0;
   numberEventsInThisSubRun_ = 0;
   newRun_ = newSubRun_ = true;
   resetSubRunPrincipal();
   resetRunPrincipal();
 }

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 art::RootInput::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 art::RootInput::nextItemType(), and art::RootInput::readSubRun_().

     {
       return cachedRunPrincipal_;
     }

std::unique_ptr< RangeSetHandler > art::EmptyEvent::runRangeSetHandler ( )

overrideprivatevirtual

Implements art::InputSource.

Definition at line 196 of file EmptyEvent_source.cc.

References eventID_, and art::EventID::run().

 {
   return std::make_unique<OpenRangeSetHandler>(eventID_.run());
 }

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 art::RootInput::nextItemType().

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

void art::EmptyEvent::setRunAndEventInfo ( )

private

Definition at line 382 of file EmptyEvent_source.cc.

References DEFINE_ART_INPUT_SOURCE, art::EventID::event(), eventCreationDelay_, eventID_, art::EventID::next(), art::EventID::nextRun(), art::EventID::nextSubRun(), numberEventsInRun_, numberEventsInSubRun_, numberEventsInThisRun_, numberEventsInThisSubRun_, origEventID_, resetEventOnSubRun_, art::EventID::run(), skipEventIncrement_, and art::EventID::subRun().

Referenced by getNextItemType().

 {
   // NOTE: numberEventsInRun < 0 means go forever in this run
   if (numberEventsInRun_ < 1 || numberEventsInThisRun_ < numberEventsInRun_) {
     // same run
     if (!(numberEventsInSubRun_ < 1 ||
           numberEventsInThisSubRun_ < numberEventsInSubRun_)) {
       // new subrun
       if (resetEventOnSubRun_) {
         eventID_ = eventID_.nextSubRun(origEventID_.event());
       } else {
         eventID_ = eventID_.nextSubRun(eventID_.next().event());
       }
     } else if (skipEventIncrement_) { // For first event, rewind etc.
       skipEventIncrement_ = false;
     } else {
       eventID_ = eventID_.next();
     }
   } else {
     // new run
     eventID_ = EventID(
       eventID_.nextRun().run(), origEventID_.subRun(), origEventID_.event());
   }
   if (eventCreationDelay_ > 0) {
     usleep(eventCreationDelay_);
   }
 }

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 art::RootInput::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 art::RootInput::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 rewind_().

     {
       time_ = theTime;
     }

void art::EmptyEvent::skip ( int offset )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 298 of file EmptyEvent_source.cc.

References eventID_, art::EventID::next(), and art::EventID::previous().

 {
   for (; offset < 0; ++offset) {
     eventID_ = eventID_.previous();
   }
   for (; offset > 0; --offset) {
     eventID_ = eventID_.next();
   }
 }

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 art::RootInput::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 > art::EmptyEvent::subRunRangeSetHandler ( )

overrideprivatevirtual

Implements art::InputSource.

Definition at line 222 of file EmptyEvent_source.cc.

References eventID_, and art::EventID::run().

 {
   return std::make_unique<OpenRangeSetHandler>(eventID_.run());
 }

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 reallyReadEvent().

     {
       return time_;
     }

Member Data Documentation

std::unique_ptr<EventPrincipal> art::EmptyEvent::ep_ {}

private

Definition at line 139 of file EmptyEvent_source.cc.

Referenced by getNextItemType(), readEvent_(), and reallyReadEvent().

unsigned int art::EmptyEvent::eventCreationDelay_

private

Definition at line 127 of file EmptyEvent_source.cc.

Referenced by EmptyEvent(), and setRunAndEventInfo().

EventID art::EmptyEvent::eventID_ {}

private

Definition at line 131 of file EmptyEvent_source.cc.

Referenced by EmptyEvent(), getNextItemType(), readRun_(), readSubRun_(), reallyReadEvent(), rewind_(), runRangeSetHandler(), setRunAndEventInfo(), skip(), and subRunRangeSetHandler().

bool art::EmptyEvent::eventSet_ {false}

private

Definition at line 136 of file EmptyEvent_source.cc.

Referenced by getNextItemType().

bool art::EmptyEvent::newRun_ {true}

private

Definition at line 133 of file EmptyEvent_source.cc.

Referenced by getNextItemType(), readRun_(), and rewind_().

bool art::EmptyEvent::newSubRun_ {true}

private

Definition at line 134 of file EmptyEvent_source.cc.

Referenced by getNextItemType(), readSubRun_(), and rewind_().

unsigned int art::EmptyEvent::numberEventsInRun_

private

Definition at line 125 of file EmptyEvent_source.cc.

Referenced by EmptyEvent(), and setRunAndEventInfo().

unsigned int art::EmptyEvent::numberEventsInSubRun_

private

Definition at line 126 of file EmptyEvent_source.cc.

Referenced by EmptyEvent(), getNextItemType(), and setRunAndEventInfo().

unsigned int art::EmptyEvent::numberEventsInThisRun_ {}

private

Definition at line 129 of file EmptyEvent_source.cc.

Referenced by getNextItemType(), rewind_(), and setRunAndEventInfo().

unsigned int art::EmptyEvent::numberEventsInThisSubRun_ {}

private

Definition at line 130 of file EmptyEvent_source.cc.

Referenced by getNextItemType(), rewind_(), and setRunAndEventInfo().

EventID art::EmptyEvent::origEventID_ {}

private

Definition at line 132 of file EmptyEvent_source.cc.

Referenced by EmptyEvent(), rewind_(), and setRunAndEventInfo().

std::unique_ptr<EmptyEventTimestampPlugin> art::EmptyEvent::plugin_

private

Definition at line 142 of file EmptyEvent_source.cc.

Referenced by beginJob(), EmptyEvent(), endJob(), readRun_(), readSubRun_(), reallyReadEvent(), and rewind_().

cet::BasicPluginFactory art::EmptyEvent::pluginFactory_ {}

private

Definition at line 141 of file EmptyEvent_source.cc.

Referenced by makePlugin_().

bool art::EmptyEvent::resetEventOnSubRun_

private

Definition at line 138 of file EmptyEvent_source.cc.

Referenced by EmptyEvent(), and setRunAndEventInfo().

bool art::EmptyEvent::skipEventIncrement_ {true}

private

Definition at line 137 of file EmptyEvent_source.cc.

Referenced by rewind_(), and setRunAndEventInfo().

bool art::EmptyEvent::subRunSet_ {false}

private

Definition at line 135 of file EmptyEvent_source.cc.

Referenced by getNextItemType().

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

art/Framework/Modules/EmptyEvent_source.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation