#include <RawInputSource.h>

Inheritance diagram for edm::RawInputSource:

Public Types
enum	Next { Next::kEvent, Next::kFile, Next::kStop }

Public Types inherited from edm::InputSource
enum	ItemPosition : char { ItemPosition::Invalid, ItemPosition::LastItemToBeMerged, ItemPosition::NotLastItemToBeMerged }

enum	ItemType : char { ItemType::IsInvalid, ItemType::IsStop, ItemType::IsFile, ItemType::IsRun, ItemType::IsLumi, ItemType::IsEvent, ItemType::IsRepeat, ItemType::IsSynchronize }

enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }

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

void	fillProcessBlockHelper ()
	Fill the ProcessBlockHelper with info for the current file. 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...

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

bool	nextProcessBlock (ProcessBlockPrincipal &)
	Next process block, return false if there is none, sets the processName in the principal. More...

InputSource &	operator= (InputSource const &)=delete

std::shared_ptr< ProcessBlockHelper const >	processBlockHelper () const
	Accessors for processBlockHelper. More...

std::shared_ptr< ProcessBlockHelper > &	processBlockHelper ()

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

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::shared_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	readProcessBlock (ProcessBlockPrincipal &)
	Read next process block. 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)

void	switchTo (std::shared_ptr< ProductRegistry > iOther)
	switch to a different ProductRegistry. More...

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 Next	checkNext ()=0

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

virtual void	read (EventPrincipal &eventPrincipal)=0

void	setInputFileTransitionsEachEvent ()

Protected Member Functions inherited from edm::InputSource
virtual void	beginJob ()
	Begin protected makes it easier to do template programming. More...

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)

ItemTypeInfo	state () const

Private Member Functions
void	closeFile_ () final

virtual void	genuineCloseFile ()

virtual void	genuineReadFile ()

ItemTypeInfo	getNextItemType () override

void	readEvent_ (EventPrincipal &eventPrincipal) override

std::shared_ptr< FileBlock >	readFile_ () final

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

Member Enumeration Documentation

◆ Next

enum edm::RawInputSource::Next

strong

Enumerator
kEvent
kFile
kStop

Definition at line 24 of file RawInputSource.h.

24 { kEvent, kFile, kStop };

edm::shared_memory::channel_names::kStop

constexpr char const *const kStop

Definition: channel_names.h:34

Constructor & Destructor Documentation

◆ RawInputSource()

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

explicit

Definition at line 17 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());
   }

◆ ~RawInputSource()

edm::RawInputSource::~RawInputSource ( )

override

Definition at line 26 of file RawInputSource.cc.

26 {}

Member Function Documentation

◆ checkNext()

virtual Next edm::RawInputSource::checkNext ( )

protectedpure virtual

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

Referenced by getNextItemType().

◆ closeFile_()

void edm::RawInputSource::closeFile_ ( )

finalprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 111 of file RawInputSource.cc.

References fakeInputFileTransition_, and genuineCloseFile().

                                   {
     if (!fakeInputFileTransition_) {
       genuineCloseFile();
     }
   }

◆ fillDescription()

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

static

Definition at line 105 of file RawInputSource.cc.

References makeListRunsInFiles::description, and edm::InputSource::fillDescription().

Referenced by edm::RawInputSourceFromFiles::fillDescription(), and edm::streamer::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);
   }

◆ genuineCloseFile()

virtual void edm::RawInputSource::genuineCloseFile ( )

inlineprivatevirtual

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

Definition at line 41 of file RawInputSource.h.

Referenced by closeFile_().

41 {}

◆ genuineReadFile()

virtual void edm::RawInputSource::genuineReadFile ( )

inlineprivatevirtual

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

Definition at line 42 of file RawInputSource.h.

Referenced by readFile_().

42 {}

◆ getNextItemType()

InputSource::ItemTypeInfo edm::RawInputSource::getNextItemType ( )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 56 of file RawInputSource.cc.

                                                           {
     if (state() == ItemType::IsInvalid) {
       return ItemType::IsFile;
     }
     if (newRun() && runAuxiliary()) {
       return ItemType::IsRun;
     }
     if (newLumi() && luminosityBlockAuxiliary()) {
       return ItemType::IsLumi;
     }
     if (eventCached()) {
       return ItemType::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());
     }
     Next another = checkNext();
     if (another == Next::kStop) {
       return ItemType::IsStop;
     } else if (another == Next::kEvent and inputFileTransitionsEachEvent_) {
       fakeInputFileTransition_ = true;
       return ItemType::IsFile;
     } else if (another == Next::kFile) {
       setNewRun();
       setNewLumi();
       resetEventCached();
       return ItemType::IsFile;
     }
     if (newRun()) {
       return ItemType::IsRun;
     } else if (newLumi()) {
       return ItemType::IsLumi;
     }
     return ItemType::IsEvent;
   }

◆ makeEvent()

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

protected

Definition at line 51 of file RawInputSource.cc.

References edm::EventPrincipal::fillEventPrincipal(), edm::ProcessHistoryRegistry::getMapped(), edm::EventAuxiliary::processHistoryID(), and edm::InputSource::processHistoryRegistry().

Referenced by DAQSource::makeEventWrapper(), and FedRawDataInputSource::read().

                                                                                                      {
     auto history = processHistoryRegistry().getMapped(eventAuxiliary.processHistoryID());
     eventPrincipal.fillEventPrincipal(eventAuxiliary, history);
   }

◆ read()

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

protectedpure virtual

Implemented in edm::streamer::StreamerInputSource, DAQSource, and FedRawDataInputSource.

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

◆ readEvent_()

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

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 43 of file RawInputSource.cc.

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

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

◆ readFile_()

std::shared_ptr< edm::FileBlock > edm::RawInputSource::readFile_ ( )

finalprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 117 of file RawInputSource.cc.

References fakeInputFileTransition_, and genuineReadFile().

                                                         {
     if (!fakeInputFileTransition_) {
       genuineReadFile();
     }
     fakeInputFileTransition_ = false;
     return std::make_shared<FileBlock>();
   }

◆ readLuminosityBlockAuxiliary_()

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

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 35 of file RawInputSource.cc.

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

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

◆ readRunAuxiliary_()

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

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 28 of file RawInputSource.cc.

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

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

◆ reset_()

void edm::RawInputSource::reset_ ( )

privatevirtual

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

Definition at line 97 of file RawInputSource.cc.

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

Referenced by rewind_().

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

◆ rewind_()

void edm::RawInputSource::rewind_ ( )

overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 103 of file RawInputSource.cc.

References reset_().

103 { reset_(); }

edm::RawInputSource::reset_

virtual void reset_()

Definition: RawInputSource.cc:97

◆ setInputFileTransitionsEachEvent()

void edm::RawInputSource::setInputFileTransitionsEachEvent ( )

inlineprotected

Definition at line 30 of file RawInputSource.h.

References inputFileTransitionsEachEvent_.

30 { inputFileTransitionsEachEvent_ = true; }

edm::RawInputSource::inputFileTransitionsEachEvent_

bool inputFileTransitionsEachEvent_

Definition: RawInputSource.h:44

Member Data Documentation

◆ fakeInputFileTransition_

bool edm::RawInputSource::fakeInputFileTransition_

private

Definition at line 45 of file RawInputSource.h.

Referenced by closeFile_(), getNextItemType(), and readFile_().

◆ inputFileTransitionsEachEvent_

bool edm::RawInputSource::inputFileTransitionsEachEvent_

private

Definition at line 44 of file RawInputSource.h.

Referenced by getNextItemType(), and setInputFileTransitionsEachEvent().

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Next

Constructor & Destructor Documentation

◆ RawInputSource()

◆ ~RawInputSource()

Member Function Documentation

◆ checkNext()

◆ closeFile_()

◆ fillDescription()

◆ genuineCloseFile()

◆ genuineReadFile()

◆ getNextItemType()

◆ makeEvent()

◆ read()

◆ readEvent_()

◆ readFile_()

◆ readLuminosityBlockAuxiliary_()

◆ readRunAuxiliary_()

◆ reset_()

◆ rewind_()

◆ setInputFileTransitionsEachEvent()

Member Data Documentation

◆ fakeInputFileTransition_

◆ inputFileTransitionsEachEvent_