Inheritance diagram for art::EmptyEvent:

Classes
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
	EmptyEvent (Parameters const &config, InputSourceDescription &desc)

	EmptyEvent (EmptyEvent const &)=delete

	EmptyEvent (EmptyEvent &&)=delete

EmptyEvent &	operator= (EmptyEvent const &)=delete

EmptyEvent &	operator= (EmptyEvent &&)=delete

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	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

ModuleDescription const &	moduleDescription () const

ProcessConfiguration const &	processConfiguration () const

Private Member Functions
unique_ptr< RangeSetHandler >	runRangeSetHandler () override

unique_ptr< RangeSetHandler >	subRunRangeSetHandler () override

input::ItemType	getNextItemType () override

unique_ptr< RunPrincipal >	readRun_ () override

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

unique_ptr< EventPrincipal >	readEvent_ () override

unique_ptr< EmptyEventTimestampPlugin >	makePlugin_ (OptionalDelegatedParameter const &maybeConfig)

void	beginJob () override

void	endJob () override

void	skip (int offset) override

void	rewind_ () override

Private Attributes
unsigned const	numberEventsInRun_

unsigned const	numberEventsInSubRun_

steady_clock::time_point const	beginTime_ {steady_clock::now()}

std::chrono::seconds const	maxTime_

std::chrono::microseconds const	eventCreationDelay_

unsigned	numberEventsInThisRun_ {}

unsigned	numberEventsInThisSubRun_ {}

EventID	origEventID_ {}

EventID	eventID_ {}

bool	firstTime_ {true}

bool	newFile_ {true}

bool	newRun_ {true}

bool	newSubRun_ {true}

bool const	resetEventOnSubRun_

cet::BasicPluginFactory	pluginFactory_ {}

unique_ptr< EmptyEventTimestampPlugin >	plugin_

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 44 of file EmptyEvent_source.cc.

Member Typedef Documentation

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

Definition at line 97 of file EmptyEvent_source.cc.

Constructor & Destructor Documentation

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

Definition at line 141 of file EmptyEvent_source.cc.

   : DecrepitRelicInputSourceImplementation{config().drisi_config,
                                            desc.moduleDescription}
   , numberEventsInRun_{static_cast<uint32_t>(config().numberEventsInRun())}
   , numberEventsInSubRun_{static_cast<uint32_t>(
       config().numberEventsInSubRun())}
   , maxTime_{config().maxTime()}
   , eventCreationDelay_{config().eventCreationDelay()}
   , resetEventOnSubRun_{config().resetEventOnSubRun()}
   , plugin_{makePlugin_(config().timestampPlugin)}
 {
   // Additional configuration checking which is cumbersome to do with
   // the FHiCL validation system.
   auto const& pset = config.get_PSet();
   if (pset.has_key("maxTime") &&
       (pset.has_key("maxEvents") || pset.has_key("maxSubRuns"))) {
     throw Exception{
       errors::Configuration,
       "An error occurred while configuring the EmptyEvent source.\n"}
       << "The 'maxTime' parameter cannot be used with the 'maxEvents' or "
          "'maxSubRuns' parameters.\n"
          "Type 'art --print-description EmptyEvent' for the allowed "
          "configuration.\n";
   }
 
   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_;
 }

art::EmptyEvent::EmptyEvent ( EmptyEvent const & )

delete

art::EmptyEvent::EmptyEvent ( EmptyEvent && )

delete

Member Function Documentation

void art::EmptyEvent::beginJob ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 347 of file EmptyEvent_source.cc.

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

void art::EmptyEvent::endJob ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 355 of file EmptyEvent_source.cc.

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

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

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 185 of file EmptyEvent_source.cc.

 {
   // Trigger framework stop if max allowed time is exceeded.
   // N.B. Since the begin time corresponds to source construction and
   // not the actual event loop, there will be minor differences wrt
   // the time reported for executing a given job.
   if (steady_clock::now() - beginTime_ > maxTime_) {
     return input::IsStop;
   }
   // First check for sanity because skip(offset) can be abused and so can the
   // ctor.
   if (!eventID_.runID().isValid()) {
     return input::IsStop;
   }
   if (!eventID_.subRunID().isValid()) {
     return input::IsStop;
   }
   if (!eventID_.isValid()) {
     return input::IsStop;
   }
   if (newFile_) {
     newFile_ = false;
     return input::IsFile;
   }
   if (newRun_) {
     newRun_ = false;
     if (eventCreationDelay_ > 0ms) {
       std::this_thread::sleep_for(eventCreationDelay_);
     }
     return input::IsRun;
   }
   if (newSubRun_) {
     newSubRun_ = false;
     if (eventCreationDelay_ > 0ms) {
       std::this_thread::sleep_for(eventCreationDelay_);
     }
     return input::IsSubRun;
   }
   if ((numberEventsInRun_ > 0) &&
       (numberEventsInRun_ <= numberEventsInThisRun_)) {
     // Time to switch runs.
     newRun_ = false;
     newSubRun_ = true;
     numberEventsInThisRun_ = 0;
     numberEventsInThisSubRun_ = 0;
     eventID_ = EventID(
       eventID_.nextRun().run(), origEventID_.subRun(), origEventID_.event());
     firstTime_ = true;
     if (eventCreationDelay_ > 0ms) {
       std::this_thread::sleep_for(eventCreationDelay_);
     }
     return input::IsRun;
   }
   if ((numberEventsInSubRun_ > 0) &&
       (numberEventsInSubRun_ <= numberEventsInThisSubRun_)) {
     // Time to switch subruns.
     newRun_ = false;
     newSubRun_ = false;
     numberEventsInThisSubRun_ = 0;
     if (resetEventOnSubRun_) {
       eventID_ = eventID_.nextSubRun(origEventID_.event());
     } else {
       eventID_ = eventID_.nextSubRun(eventID_.next().event());
     }
     firstTime_ = true;
     if (eventCreationDelay_ > 0ms) {
       std::this_thread::sleep_for(eventCreationDelay_);
     }
     return input::IsSubRun;
   }
   // same run and subrun
   if (!firstTime_) {
     eventID_ = eventID_.next();
     if (!eventID_.runID().isValid()) {
       return input::IsStop;
     }
   }
   firstTime_ = false;
   ++numberEventsInThisRun_;
   ++numberEventsInThisSubRun_;
   if (eventCreationDelay_ > 0ms) {
     std::this_thread::sleep_for(eventCreationDelay_);
   }
   return input::IsEvent;
 }

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

private

Definition at line 363 of file EmptyEvent_source.cc.

 {
   std::unique_ptr<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<decltype(result)>(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;
 }

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

delete

EmptyEvent& art::EmptyEvent::operator= ( EmptyEvent && )

delete

unique_ptr< art::EventPrincipal > art::EmptyEvent::readEvent_ ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 313 of file EmptyEvent_source.cc.

 {
   unique_ptr<EventPrincipal> result;
   if (processingMode() != RunsSubRunsAndEvents) {
     return result;
   }
   auto timestamp = plugin_ ? plugin_->doEventTimestamp(eventID_) :
                              Timestamp::invalidTimestamp();
   EventAuxiliary const eventAux{
     eventID_, timestamp, false, EventAuxiliary::Any};
   result = make_unique<EventPrincipal>(eventAux,
                                        processConfiguration(),
                                        nullptr,
                                        make_unique<History>(),
                                        make_unique<NoDelayedReader>(),
                                        numberEventsInThisSubRun_ ==
                                          numberEventsInSubRun_);
   assert(result.get() != nullptr);
   return result;
 }

unique_ptr< art::RunPrincipal > art::EmptyEvent::readRun_ ( )

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 272 of file EmptyEvent_source.cc.

 {
   unique_ptr<RunPrincipal> result;
   auto ts = plugin_ ? plugin_->doBeginRunTimestamp(eventID_.runID()) :
                       Timestamp::invalidTimestamp();
   RunAuxiliary const runAux{
     eventID_.runID(), ts, Timestamp::invalidTimestamp()};
   result = make_unique<RunPrincipal>(runAux, processConfiguration(), nullptr);
   assert(result.get() != nullptr);
   if (plugin_) {
     ModuleContext const mc{moduleDescription()};
     Run const r{*result, mc};
     plugin_->doBeginRun(r);
   }
   return result;
 }

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

overrideprivatevirtual

Implements art::DecrepitRelicInputSourceImplementation.

Definition at line 290 of file EmptyEvent_source.cc.

 {
   unique_ptr<SubRunPrincipal> result;
   if (processingMode() == Runs) {
     return result;
   }
   auto ts = plugin_ ? plugin_->doBeginSubRunTimestamp(eventID_.subRunID()) :
                       Timestamp::invalidTimestamp();
   SubRunAuxiliary const subRunAux{
     eventID_.subRunID(), ts, Timestamp::invalidTimestamp()};
   result =
     make_unique<SubRunPrincipal>(subRunAux, processConfiguration(), nullptr);
   assert(result.get() != nullptr);
   result->setRunPrincipal(rp);
   if (plugin_) {
     ModuleContext const mc{moduleDescription()};
     SubRun const sr{*result, mc};
     plugin_->doBeginSubRun(sr);
   }
   return result;
 }

void art::EmptyEvent::rewind_ ( )

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 400 of file EmptyEvent_source.cc.

 {
   if (plugin_) {
     plugin_->doRewind();
   }
   firstTime_ = true;
   newFile_ = true;
   newRun_ = true;
   newSubRun_ = true;
   numberEventsInThisRun_ = 0;
   numberEventsInThisSubRun_ = 0;
   eventID_ = origEventID_;
 }

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

overrideprivatevirtual

Implements art::InputSource.

Definition at line 335 of file EmptyEvent_source.cc.

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

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

overrideprivatevirtual

Reimplemented from art::DecrepitRelicInputSourceImplementation.

Definition at line 389 of file EmptyEvent_source.cc.

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

unique_ptr< art::RangeSetHandler > art::EmptyEvent::subRunRangeSetHandler ( )

overrideprivatevirtual

Implements art::InputSource.

Definition at line 341 of file EmptyEvent_source.cc.

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

Member Data Documentation

steady_clock::time_point const art::EmptyEvent::beginTime_ {steady_clock::now()}

private

Definition at line 123 of file EmptyEvent_source.cc.

std::chrono::microseconds const art::EmptyEvent::eventCreationDelay_

private

Definition at line 125 of file EmptyEvent_source.cc.

EventID art::EmptyEvent::eventID_ {}

private

Definition at line 129 of file EmptyEvent_source.cc.

bool art::EmptyEvent::firstTime_ {true}

private

Definition at line 130 of file EmptyEvent_source.cc.

std::chrono::seconds const art::EmptyEvent::maxTime_

private

Definition at line 124 of file EmptyEvent_source.cc.

bool art::EmptyEvent::newFile_ {true}

private

Definition at line 131 of file EmptyEvent_source.cc.

bool art::EmptyEvent::newRun_ {true}

private

Definition at line 132 of file EmptyEvent_source.cc.

bool art::EmptyEvent::newSubRun_ {true}

private

Definition at line 133 of file EmptyEvent_source.cc.

unsigned const art::EmptyEvent::numberEventsInRun_

private

Definition at line 121 of file EmptyEvent_source.cc.

unsigned const art::EmptyEvent::numberEventsInSubRun_

private

Definition at line 122 of file EmptyEvent_source.cc.

unsigned art::EmptyEvent::numberEventsInThisRun_ {}

private

Definition at line 126 of file EmptyEvent_source.cc.

unsigned art::EmptyEvent::numberEventsInThisSubRun_ {}

private

Definition at line 127 of file EmptyEvent_source.cc.

EventID art::EmptyEvent::origEventID_ {}

private

Definition at line 128 of file EmptyEvent_source.cc.

unique_ptr<EmptyEventTimestampPlugin> art::EmptyEvent::plugin_

private

Definition at line 136 of file EmptyEvent_source.cc.

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

private

Definition at line 135 of file EmptyEvent_source.cc.

bool const art::EmptyEvent::resetEventOnSubRun_

private

Definition at line 134 of file EmptyEvent_source.cc.

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

art/art/Framework/Modules/EmptyEvent_source.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation