#include <StreamerFileReader.h>

Inheritance diagram for edm::StreamerFileReader:

Public Member Functions
InitMsgView const *	getHeader ()

EventMsgView const *	getNextEvent ()

bool	newHeader ()

	StreamerFileReader (ParameterSet const &pset, InputSourceDescription const &desc)

	~StreamerFileReader () override

Public Member Functions inherited from edm::StreamerInputSource
void	deserializeAndMergeWithRegistry (InitMsgView const &initView, bool subsequent=false)

void	deserializeEvent (EventMsgView const &eventView)

std::unique_ptr< SendJobHeader >	deserializeRegistry (InitMsgView const &initView)

	StreamerInputSource (ParameterSet const &pset, InputSourceDescription const &desc)

	~StreamerInputSource () override

Public Member Functions inherited from edm::RawInputSource
	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	fillDescriptions (ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::StreamerInputSource
static void	fillDescription (ParameterSetDescription &description)

static void	mergeIntoRegistry (SendJobHeader const &header, ProductRegistry &, BranchIDListHelper &, ThinnedAssociationsHelper &, bool subsequent)

static unsigned int	uncompressBuffer (unsigned char *inputBuffer, unsigned int inputSize, std::vector< unsigned char > &outputBuffer, unsigned int expectedFullSize)

Static Public Member Functions inherited from edm::RawInputSource
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 &)

Private Member Functions
bool	checkNextEvent () override

std::shared_ptr< EventSkipperByID const >	eventSkipperByID () const

std::shared_ptr< EventSkipperByID > &	eventSkipperByID ()

void	genuineCloseFile () override

void	reset_ () override

void	skip (int toSkip) override

Private Attributes
edm::propagate_const< std::shared_ptr< EventSkipperByID > >	eventSkipperByID_

int	initialNumberOfEventsToSkip_

std::vector< std::string >	streamerNames_

edm::propagate_const< std::unique_ptr< StreamerInputFile > >	streamReader_

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_

Protected Member Functions inherited from edm::StreamerInputSource
void	resetAfterEndRun ()

Protected Member Functions inherited from edm::RawInputSource
void	makeEvent (EventPrincipal &eventPrincipal, EventAuxiliary const &eventAuxiliary)

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

ItemType	state () const

Static Protected Member Functions inherited from edm::StreamerInputSource
static void	buildClassCache (SendDescs const &descs)

static void	declareStreamers (SendDescs const &descs)

Detailed Description

Definition at line 21 of file StreamerFileReader.h.

Constructor & Destructor Documentation

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

Definition at line 14 of file StreamerFileReader.cc.

References getEcalConditions_orcoffint2r_cff::catalog, edm::InputFileCatalog::fileNames(), edm::ParameterSet::getUntrackedParameter(), reset_(), streamerNames_, and AlCaHLTBitMon_QueryRunRegistry::string.

       : StreamerInputSource(pset, desc),
         streamerNames_(pset.getUntrackedParameter<std::vector<std::string> >("fileNames")),
         streamReader_(),
         eventSkipperByID_(EventSkipperByID::create(pset).release()),
         initialNumberOfEventsToSkip_(pset.getUntrackedParameter<unsigned int>("skipEvents")) {
     InputFileCatalog catalog(pset.getUntrackedParameter<std::vector<std::string> >("fileNames"),
                              pset.getUntrackedParameter<std::string>("overrideCatalog"));
     streamerNames_ = catalog.fileNames();
     reset_();
   }

edm::StreamerFileReader::~StreamerFileReader ( )

override

Definition at line 26 of file StreamerFileReader.cc.

26 {}

Member Function Documentation

bool edm::StreamerFileReader::checkNextEvent ( )

overrideprivatevirtual

Implements edm::RawInputSource.

Definition at line 44 of file StreamerFileReader.cc.

References edm::StreamerInputSource::deserializeAndMergeWithRegistry(), edm::StreamerInputSource::deserializeEvent(), getHeader(), getNextEvent(), RecoTauValidation_cfi::header, and newHeader().

                                           {
     EventMsgView const* eview = getNextEvent();
 
     if (newHeader()) {
       // FDEBUG(6) << "A new file has been opened and we must compare Headers here !!" << std::endl;
       // A new file has been opened and we must compare Heraders here !!
       //Get header/init from reader
       InitMsgView const* header = getHeader();
       deserializeAndMergeWithRegistry(*header, true);
     }
     if (eview == nullptr) {
       return false;
     }
     deserializeEvent(*eview);
     return true;
   }

std::shared_ptr<EventSkipperByID const> edm::StreamerFileReader::eventSkipperByID ( ) const

inlineprivate

Definition at line 37 of file StreamerFileReader.h.

References eventSkipperByID_, and edm::get_underlying_safe().

Referenced by reset_().

37 { return get_underlying_safe(eventSkipperByID_); }

edm::get_underlying_safe

std::shared_ptr< T > & get_underlying_safe(propagate_const< std::shared_ptr< T >> &iP)

Definition: get_underlying_safe.h:40

edm::StreamerFileReader::eventSkipperByID_

edm::propagate_const< std::shared_ptr< EventSkipperByID > > eventSkipperByID_

Definition: StreamerFileReader.h:42

std::shared_ptr<EventSkipperByID>& edm::StreamerFileReader::eventSkipperByID ( )

inlineprivate

Definition at line 38 of file StreamerFileReader.h.

References eventSkipperByID_, and edm::get_underlying_safe().

38 { return get_underlying_safe(eventSkipperByID_); }

edm::get_underlying_safe

std::shared_ptr< T > & get_underlying_safe(propagate_const< std::shared_ptr< T >> &iP)

Definition: get_underlying_safe.h:40

edm::StreamerFileReader::eventSkipperByID_

edm::propagate_const< std::shared_ptr< EventSkipperByID > > eventSkipperByID_

Definition: StreamerFileReader.h:42

void edm::StreamerFileReader::fillDescriptions ( ConfigurationDescriptions & descriptions )

static

Definition at line 98 of file StreamerFileReader.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), edm::EventSkipperByID::fillDescription(), edm::StreamerInputSource::fillDescription(), edm::ParameterSetDescription::setComment(), AlCaHLTBitMon_QueryRunRegistry::string, and mitigatedMETSequence_cff::U.

                                                                                    {
     ParameterSetDescription desc;
     desc.setComment("Reads events from streamer files.");
     desc.addUntracked<std::vector<std::string> >("fileNames")->setComment("Names of files to be processed.");
     desc.addUntracked<unsigned int>("skipEvents", 0U)
         ->setComment("Skip the first 'skipEvents' events that otherwise would have been processed.");
     desc.addUntracked<std::string>("overrideCatalog", std::string());
     //This next parameter is read in the base class, but its default value depends on the derived class, so it is set here.
     desc.addUntracked<bool>("inputFileTransitionsEachEvent", false);
     StreamerInputSource::fillDescription(desc);
     EventSkipperByID::fillDescription(desc);
     descriptions.add("source", desc);
   }

void edm::StreamerFileReader::genuineCloseFile ( )

overrideprivatevirtual

Reimplemented from edm::RawInputSource.

Definition at line 74 of file StreamerFileReader.cc.

References streamReader_.

                                             {
     if (streamReader_.get() != nullptr)
       streamReader_->closeStreamerFile();
   }

InitMsgView const * edm::StreamerFileReader::getHeader ( )

Definition at line 81 of file StreamerFileReader.cc.

References InitMsgView::code(), Exception, edm::errors::FileReadError, RecoTauValidation_cfi::header, Header::INIT, and streamReader_.

Referenced by checkNextEvent(), and reset_().

                                                    {
     InitMsgView const* header = streamReader_->startMessage();
 
     if (header->code() != Header::INIT) {  //INIT Msg
       throw Exception(errors::FileReadError, "StreamerFileReader::readHeader")
           << "received wrong message type: expected INIT, got " << header->code() << "\n";
     }
     return header;
   }

EventMsgView const * edm::StreamerFileReader::getNextEvent ( )

Definition at line 91 of file StreamerFileReader.cc.

References streamReader_.

Referenced by checkNextEvent(), and skip().

                                                        {
     if (!streamReader_->next()) {
       return nullptr;
     }
     return streamReader_->currentRecord();
   }

bool edm::StreamerFileReader::newHeader ( )

Definition at line 79 of file StreamerFileReader.cc.

References streamReader_.

Referenced by checkNextEvent().

79 { return streamReader_->newHeader(); }

edm::StreamerFileReader::streamReader_

edm::propagate_const< std::unique_ptr< StreamerInputFile > > streamReader_

Definition: StreamerFileReader.h:41

void edm::StreamerFileReader::reset_ ( )

overrideprivatevirtual

Reimplemented from edm::RawInputSource.

Definition at line 28 of file StreamerFileReader.cc.

References edm::StreamerInputSource::deserializeAndMergeWithRegistry(), eventSkipperByID(), Exception, edm::errors::FileReadError, getHeader(), RecoTauValidation_cfi::header, initialNumberOfEventsToSkip_, skip(), streamerNames_, and streamReader_.

Referenced by StreamerFileReader().

                                   {
     if (streamerNames_.size() > 1) {
       streamReader_ = std::make_unique<StreamerInputFile>(streamerNames_, eventSkipperByID());
     } else if (streamerNames_.size() == 1) {
       streamReader_ = std::make_unique<StreamerInputFile>(streamerNames_.at(0), eventSkipperByID());
     } else {
       throw Exception(errors::FileReadError, "StreamerFileReader::StreamerFileReader")
           << "No fileNames were specified\n";
     }
     InitMsgView const* header = getHeader();
     deserializeAndMergeWithRegistry(*header, false);
     if (initialNumberOfEventsToSkip_) {
       skip(initialNumberOfEventsToSkip_);
     }
   }

void edm::StreamerFileReader::skip ( int toSkip )

overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 61 of file StreamerFileReader.cc.

References EventMsgView::event(), eventSkipperByID_, getNextEvent(), mps_fire::i, EventMsgView::lumi(), and EventMsgView::run().

Referenced by reset_().

                                           {
     for (int i = 0; i != toSkip; ++i) {
       EventMsgView const* evMsg = getNextEvent();
       if (evMsg == nullptr) {
         return;
       }
       // If the event would have been skipped anyway, don't count it as a skipped event.
       if (eventSkipperByID_ && eventSkipperByID_->skipIt(evMsg->run(), evMsg->lumi(), evMsg->event())) {
         --i;
       }
     }
   }

Member Data Documentation

edm::propagate_const<std::shared_ptr<EventSkipperByID> > edm::StreamerFileReader::eventSkipperByID_

private

Definition at line 42 of file StreamerFileReader.h.

Referenced by eventSkipperByID(), and skip().

int edm::StreamerFileReader::initialNumberOfEventsToSkip_

private

Definition at line 43 of file StreamerFileReader.h.

Referenced by reset_().

std::vector<std::string> edm::StreamerFileReader::streamerNames_

private

Definition at line 40 of file StreamerFileReader.h.

Referenced by reset_(), and StreamerFileReader().

edm::propagate_const<std::unique_ptr<StreamerInputFile> > edm::StreamerFileReader::streamReader_

private

Definition at line 41 of file StreamerFileReader.h.

Referenced by genuineCloseFile(), getHeader(), getNextEvent(), newHeader(), and reset_().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation