#include <RawInputSource.h>

Inheritance diagram for edm::RawInputSource:

Public Member Functions
	RawInputSource (ParameterSet const &pset, InputSourceDescription const &desc)

	~RawInputSource () override

Public Member Functions inherited from edm::InputSource
std::shared_ptr< ActivityRegistry >	actReg () const
	Accessor for Activity Registry. More...

std::shared_ptr< BranchIDListHelper const >	branchIDListHelper () const
	Accessors for branchIDListHelper. More...

std::shared_ptr< BranchIDListHelper > &	branchIDListHelper ()

void	closeFile (FileBlock *, bool cleaningUpAfterException)
	close current file More...

void	doBeginJob ()
	Called by framework at beginning of job. More...

virtual void	doBeginLumi (LuminosityBlockPrincipal &lbp, ProcessContext const *)
	Called by framework at beginning of lumi block. More...

virtual void	doBeginRun (RunPrincipal &rp, ProcessContext const *)
	Called by framework at beginning of run. More...

void	doEndJob ()
	Called by framework at end of job. More...

ProcessingController::ForwardState	forwardState () const

bool	goToEvent (EventID const &eventID)

	InputSource (ParameterSet const &, InputSourceDescription const &)
	Constructor. More...

	InputSource (InputSource const &)=delete

void	issueReports (EventID const &eventID, StreamID streamID)
	issue an event report More...

LuminosityBlockNumber_t	luminosityBlock () const
	Accessor for current luminosity block number. More...

std::shared_ptr< LuminosityBlockAuxiliary >	luminosityBlockAuxiliary () const
	Called by the framework to merge or insert lumi in principal cache. More...

int	maxEvents () const

int	maxLuminosityBlocks () const

ModuleDescription const &	moduleDescription () const
	Accessor for 'module' description. More...

ItemType	nextItemType ()
	Advances the source to the next item. More...

InputSource &	operator= (InputSource const &)=delete

ProcessConfiguration const &	processConfiguration () const
	Accessor for Process Configuration. More...

std::string const &	processGUID () const
	Accessor for global process identifier. More...

ProcessHistoryRegistry const &	processHistoryRegistry () const
	Accessors for process history registry. More...

ProcessHistoryRegistry &	processHistoryRegistry ()

ProcessingMode	processingMode () const
	RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...

std::shared_ptr< ProductRegistry const >	productRegistry () const
	Accessors for product registry. More...

std::shared_ptr< ProductRegistry > &	productRegistry ()

bool	randomAccess () const

void	readAndMergeLumi (LuminosityBlockPrincipal &lbp)
	Read next luminosity block (same as a prior lumi) More...

void	readAndMergeRun (RunPrincipal &rp)
	Read next run (same as a prior run) More...

void	readEvent (EventPrincipal &ep, StreamContext &)
	Read next event. More...

bool	readEvent (EventPrincipal &ep, EventID const &, StreamContext &)
	Read a specific event. More...

std::unique_ptr< FileBlock >	readFile ()
	Read next file. More...

void	readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
	Read next luminosity block (new lumi) More...

std::shared_ptr< LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary ()
	Read next luminosity block Auxilary. More...

void	readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
	Read next run (new run) More...

std::shared_ptr< RunAuxiliary >	readRunAuxiliary ()
	Read next run Auxiliary. More...

ProcessHistoryID const &	reducedProcessHistoryID () const

virtual void	registerProducts ()
	Register any produced products. More...

int	remainingEvents () const

int	remainingLuminosityBlocks () const

void	repeat ()
	Reset the remaining number of events/lumis to the maximum number. More...

std::pair< SharedResourcesAcquirer , std::recursive_mutex >	resourceSharedWithDelayedReader ()
	Returns nullptr if no resource shared between the Source and a DelayedReader. More...

ProcessingController::ReverseState	reverseState () const

void	rewind ()
	Begin again at the first event. More...

RunNumber_t	run () const
	Accessor for current run number. More...

std::shared_ptr< RunAuxiliary >	runAuxiliary () const
	Called by the framework to merge or insert run in principal cache. More...

void	setLuminosityBlockNumber_t (LuminosityBlockNumber_t lb)
	Set the luminosity block ID. More...

void	setRunNumber (RunNumber_t r)
	Set the run number. More...

void	skipEvents (int offset)

std::shared_ptr< ThinnedAssociationsHelper const >	thinnedAssociationsHelper () const
	Accessors for thinnedAssociationsHelper. More...

std::shared_ptr< ThinnedAssociationsHelper > &	thinnedAssociationsHelper ()

Timestamp const &	timestamp () const
	Accessor for the current time, as seen by the input source. More...

virtual	~InputSource () noexcept(false)
	Destructor. More...

Static Public Member Functions
static void	fillDescription (ParameterSetDescription &description)

Static Public Member Functions inherited from edm::InputSource
static const std::string &	baseType ()

static void	fillDescription (ParameterSetDescription &desc)

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions
virtual bool	checkNextEvent ()=0

void	makeEvent (EventPrincipal &eventPrincipal, EventAuxiliary const &eventAuxiliary)

virtual void	read (EventPrincipal &eventPrincipal)=0

void	setInputFileTransitionsEachEvent ()

Protected Member Functions inherited from edm::InputSource
void	decreaseRemainingEventsBy (int iSkipped)

bool	eventCached () const

bool	newLumi () const

bool	newRun () const

ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()

ProductRegistry &	productRegistryUpdate ()

void	reset () const

void	resetEventCached ()

void	resetLuminosityBlockAuxiliary (bool isNewLumi=true) const

void	resetNewLumi ()

void	resetNewRun ()

void	resetRunAuxiliary (bool isNewRun=true) const

void	setEventCached ()
	Called by the framework to merge or ached() const {return eventCached_;}. More...

void	setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)

void	setNewLumi ()

void	setNewRun ()

void	setRunAuxiliary (RunAuxiliary *rp)

void	setTimestamp (Timestamp const &theTime)
	To set the current time, as seen by the input source. More...

virtual void	skip (int offset)

ItemType	state () const

Private Member Functions
void	closeFile_ () final

virtual void	genuineCloseFile ()

ItemType	getNextItemType () override

void	readEvent_ (EventPrincipal &eventPrincipal) override

std::shared_ptr< LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary_ () override

std::shared_ptr< RunAuxiliary >	readRunAuxiliary_ () override

virtual void	reset_ ()

void	rewind_ () override

Private Attributes
bool	fakeInputFileTransition_

bool	inputFileTransitionsEachEvent_

Additional Inherited Members
Public Types inherited from edm::InputSource
enum	ItemType { IsInvalid, IsStop, IsFile, IsRun, IsLumi, IsEvent, IsRepeat, IsSynchronize }

enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }

Public Attributes inherited from edm::InputSource
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	postEventReadFromSourceSignal_

signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	preEventReadFromSourceSignal_

Detailed Description

Definition at line 17 of file RawInputSource.h.

Constructor & Destructor Documentation

edm::RawInputSource::RawInputSource	(	ParameterSet const &	pset,
		InputSourceDescription const &	desc
	)

explicit

Definition at line 15 of file RawInputSource.cc.

References edm::Timestamp::beginOfTime(), and edm::InputSource::setTimestamp().

       : InputSource(pset, desc),
         // The default value for the following parameter get defined in at least one derived class
         // where it has a different default value.
         inputFileTransitionsEachEvent_(pset.getUntrackedParameter<bool>("inputFileTransitionsEachEvent", false)),
         fakeInputFileTransition_(false) {
     setTimestamp(Timestamp::beginOfTime());
   }

edm::RawInputSource::~RawInputSource ( )

override

Definition at line 24 of file RawInputSource.cc.

24 {}

Member Function Documentation

virtual bool edm::RawInputSource::checkNextEvent ( )

protectedpure virtual

Implemented in FedRawDataInputSource, dqmservices::DQMStreamerReader, edm::StreamerInputModule< Producer >, and edm::StreamerFileReader.

Referenced by getNextItemType().

void edm::RawInputSource::closeFile_ ( )

finalprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 103 of file RawInputSource.cc.

References fakeInputFileTransition_, and genuineCloseFile().

Referenced by setInputFileTransitionsEachEvent().

                                   {
     if (!fakeInputFileTransition_) {
       genuineCloseFile();
     } else {
       // Do nothing because we returned a fake input file transition
       // value from getNextItemType which resulted in this call
       // to closeFile_.
 
       // Reset the flag because the next call to closeFile_ might
       // be real.
       fakeInputFileTransition_ = false;
     }
   }

void edm::RawInputSource::fillDescription ( ParameterSetDescription & description )

static

Definition at line 97 of file RawInputSource.cc.

References edm::InputSource::fillDescription().

Referenced by edm::RawInputSourceFromFiles::fillDescription(), and edm::StreamerInputSource::fillDescription().

                                                                            {
     // The default value for "inputFileTransitionsEachEvent" gets defined in the derived class
     // as it depends on the derived class. So, we cannot redefine it here.
     InputSource::fillDescription(description);
   }

virtual void edm::RawInputSource::genuineCloseFile ( )

inlineprivatevirtual

Reimplemented in edm::StreamerFileReader, and edm::StreamerInputModule< Producer >.

Definition at line 37 of file RawInputSource.h.

Referenced by closeFile_().

37 {}

InputSource::ItemType edm::RawInputSource::getNextItemType ( )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 53 of file RawInputSource.cc.

Referenced by setInputFileTransitionsEachEvent().

                                                       {
     if (state() == IsInvalid) {
       return IsFile;
     }
     if (newRun() && runAuxiliary()) {
       return IsRun;
     }
     if (newLumi() && luminosityBlockAuxiliary()) {
       return IsLumi;
     }
     if (eventCached()) {
       return IsEvent;
     }
     if (inputFileTransitionsEachEvent_) {
       // The following two lines are here because after a source
       // tells the state machine the next ItemType is IsFile,
       // the source should then always follow that with IsRun
       // and then IsLumi. These two lines will cause that to happen.
       resetRunAuxiliary(newRun());
       resetLuminosityBlockAuxiliary(newLumi());
     }
     bool another = checkNextEvent();
     if (!another || (!newLumi() && !eventCached())) {
       return IsStop;
     } else if (inputFileTransitionsEachEvent_) {
       fakeInputFileTransition_ = true;
       return IsFile;
     }
     if (newRun()) {
       return IsRun;
     } else if (newLumi()) {
       return IsLumi;
     }
     return IsEvent;
   }

void edm::RawInputSource::makeEvent	(	EventPrincipal &	eventPrincipal,
		EventAuxiliary const &	eventAuxiliary
	)

protected

Definition at line 49 of file RawInputSource.cc.

References edm::EventPrincipal::fillEventPrincipal(), and edm::InputSource::processHistoryRegistry().

Referenced by FedRawDataInputSource::read().

                                                                                                      {
     eventPrincipal.fillEventPrincipal(eventAuxiliary, processHistoryRegistry());
   }

virtual void edm::RawInputSource::read ( EventPrincipal & eventPrincipal )

protectedpure virtual

Implemented in edm::StreamerInputSource, and FedRawDataInputSource.

Referenced by edmIntegrityCheck.PublishToFileSystem::get(), and readEvent_().

void edm::RawInputSource::readEvent_ ( EventPrincipal & eventPrincipal )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 41 of file RawInputSource.cc.

References edm::InputSource::eventCached(), edm::InputSource::newLumi(), edm::InputSource::newRun(), read(), and edm::InputSource::resetEventCached().

Referenced by setInputFileTransitionsEachEvent().

                                                                 {
     assert(!newRun());
     assert(!newLumi());
     assert(eventCached());
     resetEventCached();
     read(eventPrincipal);
   }

std::shared_ptr< LuminosityBlockAuxiliary > edm::RawInputSource::readLuminosityBlockAuxiliary_ ( )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 33 of file RawInputSource.cc.

References edm::InputSource::luminosityBlockAuxiliary(), edm::InputSource::newLumi(), edm::InputSource::newRun(), and edm::InputSource::resetNewLumi().

Referenced by setInputFileTransitionsEachEvent().

                                                                                         {
     assert(!newRun());
     assert(newLumi());
     assert(luminosityBlockAuxiliary());
     resetNewLumi();
     return luminosityBlockAuxiliary();
   }

std::shared_ptr< RunAuxiliary > edm::RawInputSource::readRunAuxiliary_ ( )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 26 of file RawInputSource.cc.

References edm::InputSource::newRun(), edm::InputSource::resetNewRun(), and edm::InputSource::runAuxiliary().

Referenced by setInputFileTransitionsEachEvent().

                                                                 {
     assert(newRun());
     assert(runAuxiliary());
     resetNewRun();
     return runAuxiliary();
   }

void edm::RawInputSource::reset_ ( )

privatevirtual

Reimplemented in dqmservices::DQMStreamerReader, and edm::StreamerFileReader.

Definition at line 89 of file RawInputSource.cc.

References Exception, and edm::errors::LogicError.

Referenced by rewind_(), and setInputFileTransitionsEachEvent().

                               {
     throw Exception(errors::LogicError) << "RawInputSource::reset()\n"
                                         << "Forking is not implemented for this type of RawInputSource\n"
                                         << "Contact a Framework Developer\n";
   }