edm::StreamerInputModule< Producer > Class Template Reference

#include <StreamerInputModule.h>

Inheritance diagram for edm::StreamerInputModule< Producer >:

Public Member Functions
	StreamerInputModule (ParameterSet const &pset, InputSourceDescription const &desc)
	~StreamerInputModule () 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)
bool	isBufferLZMA (unsigned char const *inputBuffer, unsigned int inputSize)
bool	isBufferZSTD (unsigned char const *inputBuffer, unsigned int inputSize)
	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...
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...
ItemType	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...
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::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)
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...

Private Member Functions
Next	checkNext () override
void	genuineCloseFile () override
void	genuineReadFile () override

Private Attributes
bool	isFirstFile_ = true
edm::propagate_const < std::unique_ptr< Producer > >	pr_

Additional Inherited Members
Public Types inherited from edm::RawInputSource
enum	Next { Next::kEvent, Next::kFile, Next::kStop }
Public Types inherited from edm::InputSource
enum	ItemType {   IsInvalid, IsStop, IsFile, IsRun,   IsLumi, IsEvent, IsRepeat, IsSynchronize }
enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
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 unsigned int	uncompressBufferLZMA (unsigned char *inputBuffer, unsigned int inputSize, std::vector< unsigned char > &outputBuffer, unsigned int expectedFullSize, bool hasHeader=true)
static unsigned int	uncompressBufferZSTD (unsigned char *inputBuffer, unsigned int inputSize, std::vector< unsigned char > &outputBuffer, unsigned int expectedFullSize, bool hasHeader=true)
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 &)
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
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)
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

template<typename Producer>
class edm::StreamerInputModule< Producer >

Definition at line 20 of file StreamerInputModule.h.

Constructor & Destructor Documentation

template<typename Producer >

edm::StreamerInputModule< Producer >::StreamerInputModule ( ParameterSet const &  pset, InputSourceDescription const &  desc  )

explicit

Requires the Producer class to provide following functions const InitMsgView* getHeader(); const EventMsgView* getNextEvent(); bool newHeader() const;

Definition at line 57 of file StreamerInputModule.h.

References edm::StreamerInputSource::deserializeAndMergeWithRegistry(), and edm::StreamerInputModule< Producer >::pr_.

      : StreamerInputSource(pset, desc),
        //prod_reg_(&productRegistry()),
        pr_(new Producer(pset)) {
    //Get header/init from Producer
    InitMsgView const* header = pr_->getHeader();
    deserializeAndMergeWithRegistry(*header);
  }

template<typename Producer >

edm::StreamerInputModule< Producer >::~StreamerInputModule ( )

override

Definition at line 54 of file StreamerInputModule.h.

{}

Member Function Documentation

template<typename Producer >

StreamerInputSource::Next edm::StreamerInputModule< Producer >::checkNext ( )

overrideprivatevirtual

Implements edm::RawInputSource.

Definition at line 67 of file StreamerInputModule.h.

References FDEBUG, and edm::shared_memory::channel_names::kStop.

                                                                   {
    EventMsgView const* eview = pr_->getNextEvent();

    if (pr_->newHeader()) {
      FDEBUG(6) << "A new file has been opened and we must compare Headers here !!" << std::endl;
      return Next::kFile;
    }
    if (eview == nullptr) {
      return Next::kStop;
    }
    deserializeEvent(*eview);
    return Next::kEvent;
  }

template<typename Producer >

void edm::StreamerInputModule< Producer >::genuineCloseFile ( )

inlineoverrideprivatevirtual

Reimplemented from edm::RawInputSource.

Definition at line 32 of file StreamerInputModule.h.

References edm::propagate_const< T >::get(), and edm::StreamerInputModule< Producer >::pr_.

                                     {
      if (pr_.get() != nullptr)
        pr_->closeFile();
    }

template<typename Producer >

void edm::StreamerInputModule< Producer >::genuineReadFile ( )

inlineoverrideprivatevirtual

Reimplemented from edm::RawInputSource.

Definition at line 37 of file StreamerInputModule.h.

References edm::StreamerInputSource::deserializeAndMergeWithRegistry(), edm::StreamerInputModule< Producer >::isFirstFile_, and edm::StreamerInputModule< Producer >::pr_.

                                    {
      if (isFirstFile_) {
        isFirstFile_ = false;
        return;
      }

      InitMsgView const* header = pr_->getHeader();
      deserializeAndMergeWithRegistry(*header);
    }

Member Data Documentation

template<typename Producer >

bool edm::StreamerInputModule< Producer >::isFirstFile_ = true

private

Definition at line 50 of file StreamerInputModule.h.

Referenced by edm::StreamerInputModule< Producer >::genuineReadFile().

template<typename Producer >

edm::propagate_const<std::unique_ptr<Producer> > edm::StreamerInputModule< Producer >::pr_

private

Definition at line 49 of file StreamerInputModule.h.

Referenced by edm::StreamerInputModule< Producer >::genuineCloseFile(), edm::StreamerInputModule< Producer >::genuineReadFile(), and edm::StreamerInputModule< Producer >::StreamerInputModule().