CMS 3D CMS Logo

List of all members | Public Member Functions | Protected Member Functions | Private Member Functions
edm::PuttableSourceBase Class Reference

#include <PuttableSourceBase.h>

Inheritance diagram for edm::PuttableSourceBase:
edm::InputSource edm::ProducerBase edm::ProductRegistryHelper dqmservices::DQMProtobufReader edm::ProducerSourceBase cond::EmptyIOVSource edm::EmptySource edm::ProducerSourceFromFiles LmfSource AlpgenSource edm::MCFileSource FRDStreamSource HcalTBSource L1MuGMTHWFileReader LHESource MCatNLOSource PixelSLinkDataInputSource

Public Member Functions

 PuttableSourceBase (ParameterSet const &, InputSourceDescription const &)
 
void registerProducts () final
 Register any produced products. More...
 
- Public Member Functions inherited from edm::InputSource
std::shared_ptr< ActivityRegistryactReg () 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...
 
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)
 issue an event report More...
 
LuminosityBlockNumber_t luminosityBlock () const
 Accessor for current luminosity block number. More...
 
std::shared_ptr< LuminosityBlockAuxiliaryluminosityBlockAuxiliary () 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...
 
InputSourceoperator= (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...
 
ProcessHistoryRegistryprocessHistoryRegistry ()
 
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< FileBlockreadFile ()
 Read next file. More...
 
void readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
 Read next luminosity block (new lumi) More...
 
std::shared_ptr< LuminosityBlockAuxiliaryreadLuminosityBlockAuxiliary ()
 Read next luminosity block Auxilary. More...
 
void readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
 Read next run (new run) More...
 
std::shared_ptr< RunAuxiliaryreadRunAuxiliary ()
 Read next run Auxiliary. More...
 
ProcessHistoryID const & reducedProcessHistoryID () const
 
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< RunAuxiliaryrunAuxiliary () 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...
 
- Public Member Functions inherited from edm::ProducerBase
void callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
 
std::vector< edm::ProductResolverIndex > const & indiciesForPutProducts (BranchType iBranchType) const
 
 ProducerBase ()
 
std::vector< edm::ProductResolverIndex > const & putTokenIndexToProductResolverIndex () const
 
void registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
 
std::function< void(BranchDescription const &)> registrationCallback () const
 used by the fwk to register list of products More...
 
void resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
 
virtual ~ProducerBase () noexcept(false)
 

Protected Member Functions

void beginJob () override
 
- Protected Member Functions inherited from edm::InputSource
void decreaseRemainingEventsBy (int iSkipped)
 
bool eventCached () const
 
bool newLumi () const
 
bool newRun () const
 
ProcessHistoryRegistryprocessHistoryRegistryForUpdate ()
 
ProductRegistryproductRegistryUpdate ()
 
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

virtual void beginLuminosityBlock (LuminosityBlock &)
 
virtual void beginRun (Run &)
 
void doBeginLumi (LuminosityBlockPrincipal &lbp, ProcessContext const *) override
 Called by framework at beginning of lumi block. More...
 
void doBeginRun (RunPrincipal &rp, ProcessContext const *) override
 Called by framework at beginning of run. More...
 
void doEndLumi (LuminosityBlockPrincipal &lbp, bool cleaningUpAfterException, ProcessContext const *) override
 Called by framework at end of lumi block. More...
 
void doEndRun (RunPrincipal &rp, bool cleaningUpAfterException, ProcessContext const *) override
 Called by framework at end of run. More...
 
virtual void endLuminosityBlock (LuminosityBlock &)
 
virtual void endRun (Run &)
 
PuttableSourceBaseoperator= (const PuttableSourceBase &)=delete
 
 PuttableSourceBase (const PuttableSourceBase &)=delete
 

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 Types inherited from edm::ProducerBase
using ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex >>
 
typedef ProductRegistryHelper::TypeLabelList TypeLabelList
 
- 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_
 

Detailed Description

Definition at line 30 of file PuttableSourceBase.h.

Constructor & Destructor Documentation

PuttableSourceBase::PuttableSourceBase ( ParameterSet const &  iPSet,
InputSourceDescription const &  iISD 
)

Definition at line 38 of file PuttableSourceBase.cc.

38  :
39 InputSource(iPSet,iISD)
40 {
41 }
InputSource(ParameterSet const &, InputSourceDescription const &)
Constructor.
Definition: InputSource.cc:44
edm::PuttableSourceBase::PuttableSourceBase ( const PuttableSourceBase )
privatedelete

Member Function Documentation

void PuttableSourceBase::beginJob ( void  )
overrideprotectedvirtual

Reimplemented from edm::InputSource.

Definition at line 49 of file PuttableSourceBase.cc.

References edm::InEvent, edm::InLumi, edm::InRun, edm::InputSource::moduleDescription(), edm::ModuleDescription::moduleLabel(), modifiedElectrons_cfi::processName, edm::ModuleDescription::processName(), edm::InputSource::productRegistry(), alignCSCRings::r, and edm::ProducerBase::resolvePutIndicies().

Referenced by edm::ProducerSourceBase::beginJob().

49  {
50  auto r = productRegistry();
51  auto const runLookup = r->productLookup(InRun);
52  auto const lumiLookup = r->productLookup(InLumi);
53  auto const eventLookup = r->productLookup(InEvent);
54  auto const& processName = moduleDescription().processName();
55  auto const& moduleLabel = moduleDescription().moduleLabel();
56 
57  auto const& runModuleToIndicies = runLookup->indiciesForModulesInProcess(processName);
58  auto const& lumiModuleToIndicies = lumiLookup->indiciesForModulesInProcess(processName);
59  auto const& eventModuleToIndicies = eventLookup->indiciesForModulesInProcess(processName);
60  resolvePutIndicies(InRun,runModuleToIndicies,moduleLabel);
61  resolvePutIndicies(InLumi,lumiModuleToIndicies,moduleLabel);
62  resolvePutIndicies(InEvent,eventModuleToIndicies,moduleLabel);
63 }
std::string const & processName() const
std::string const & moduleLabel() const
void resolvePutIndicies(BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
Definition: ProducerBase.cc:85
std::shared_ptr< ProductRegistry const > productRegistry() const
Accessors for product registry.
Definition: InputSource.h:162
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:203
void PuttableSourceBase::beginLuminosityBlock ( LuminosityBlock )
privatevirtual

Reimplemented in FRDStreamSource, and dqmservices::DQMProtobufReader.

Definition at line 106 of file PuttableSourceBase.cc.

Referenced by doBeginLumi().

106  {
107 }
void PuttableSourceBase::beginRun ( Run )
privatevirtual

Reimplemented in MCatNLOSource, AlpgenSource, LHESource, and FRDStreamSource.

Definition at line 98 of file PuttableSourceBase.cc.

Referenced by doBeginRun().

98  {
99 }
void PuttableSourceBase::doBeginLumi ( LuminosityBlockPrincipal lbp,
ProcessContext const *   
)
overrideprivatevirtual

Called by framework at beginning of lumi block.

Reimplemented from edm::InputSource.

Definition at line 82 of file PuttableSourceBase.cc.

References beginLuminosityBlock(), edm::ProducerBase::commit_(), edm::InputSource::moduleDescription(), and edm::LuminosityBlock::setProducer().

82  {
83  LuminosityBlock lb(lbp, moduleDescription(), nullptr);
84  lb.setProducer(this);
85  callWithTryCatchAndPrint<void>( [this,&lb](){ beginLuminosityBlock(lb); }, "Calling Source::beginLuminosityBlock" );
86  commit_(lb);
87 }
virtual void beginLuminosityBlock(LuminosityBlock &)
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:203
void commit_(P &iPrincipal)
Definition: ProducerBase.h:107
void PuttableSourceBase::doBeginRun ( RunPrincipal rp,
ProcessContext const *   
)
overrideprivatevirtual

Called by framework at beginning of run.

Reimplemented from edm::InputSource.

Definition at line 66 of file PuttableSourceBase.cc.

References beginRun(), edm::ProducerBase::commit_(), edm::InputSource::moduleDescription(), edm::InputSource::run(), and edm::Run::setProducer().

66  {
67  Run run(rp, moduleDescription(), nullptr);
68  run.setProducer(this);
69  callWithTryCatchAndPrint<void>( [this,&run](){ beginRun(run); }, "Calling Source::beginRun" );
70  commit_(run);
71 }
virtual void beginRun(Run &)
RunNumber_t run() const
Accessor for current run number.
Definition: InputSource.cc:504
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:203
void commit_(P &iPrincipal)
Definition: ProducerBase.h:107
Definition: Run.h:43
void PuttableSourceBase::doEndLumi ( LuminosityBlockPrincipal lbp,
bool  cleaningUpAfterException,
ProcessContext const *   
)
overrideprivatevirtual

Called by framework at end of lumi block.

Reimplemented from edm::InputSource.

Definition at line 90 of file PuttableSourceBase.cc.

References edm::ProducerBase::commit_(), endLuminosityBlock(), edm::InputSource::moduleDescription(), and edm::LuminosityBlock::setProducer().

90  {
91  LuminosityBlock lb(lbp, moduleDescription(), nullptr);
92  lb.setProducer(this);
93  callWithTryCatchAndPrint<void>( [this,&lb](){ endLuminosityBlock(lb); }, "Calling Source::endLuminosityBlock", cleaningUpAfterException );
94  commit_(lb);
95 }
virtual void endLuminosityBlock(LuminosityBlock &)
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:203
void commit_(P &iPrincipal)
Definition: ProducerBase.h:107
void PuttableSourceBase::doEndRun ( RunPrincipal rp,
bool  cleaningUpAfterException,
ProcessContext const *   
)
overrideprivatevirtual

Called by framework at end of run.

Reimplemented from edm::InputSource.

Definition at line 74 of file PuttableSourceBase.cc.

References edm::ProducerBase::commit_(), endRun(), edm::InputSource::moduleDescription(), edm::InputSource::run(), and edm::Run::setProducer().

74  {
75  Run run(rp, moduleDescription(), nullptr);
76  run.setProducer(this);
77  callWithTryCatchAndPrint<void>( [this,&run](){ endRun(run); }, "Calling Source::endRun", cleaningUpAfterException );
78  commit_(run);
79 }
RunNumber_t run() const
Accessor for current run number.
Definition: InputSource.cc:504
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:203
virtual void endRun(Run &)
void commit_(P &iPrincipal)
Definition: ProducerBase.h:107
Definition: Run.h:43
void PuttableSourceBase::endLuminosityBlock ( LuminosityBlock )
privatevirtual

Reimplemented in FRDStreamSource.

Definition at line 110 of file PuttableSourceBase.cc.

Referenced by doEndLumi().

110  {
111 }
void PuttableSourceBase::endRun ( Run )
privatevirtual

Reimplemented in LHESource, and FRDStreamSource.

Definition at line 102 of file PuttableSourceBase.cc.

Referenced by doEndRun().

102  {
103 }
PuttableSourceBase& edm::PuttableSourceBase::operator= ( const PuttableSourceBase )
privatedelete
void PuttableSourceBase::registerProducts ( )
finalvirtual

Register any produced products.

Reimplemented from edm::InputSource.

Definition at line 44 of file PuttableSourceBase.cc.

References edm::InputSource::moduleDescription(), and edm::InputSource::productRegistryUpdate().

44  {
46 }
ProductRegistry & productRegistryUpdate()
Definition: InputSource.h:339
void registerProducts() final
Register any produced products.
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:203