edm::stream::EDProducerBase Class Reference

#include "FWCore/Framework/interface/stream/EDProducerBase.h"

Inheritance diagram for edm::stream::EDProducerBase:

Public Types
typedef EDProducerAdaptorBase	ModuleType
Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
virtual	~EDProducerBase ()
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 ()
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, std::unordered_multimap< std::string, edm::ProductResolverIndex > const &iIndicies, std::string const &moduleLabel)
virtual	~ProducerBase () noexcept(false)
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
virtual void	beginLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &)
virtual void	beginRun (edm::Run const &, edm::EventSetup const &)
virtual void	beginStream (StreamID)
	EDProducerBase (const EDProducerBase &)=delete
virtual void	endLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &)
virtual void	endRun (edm::Run const &, edm::EventSetup const &)
virtual void	endStream ()
const EDProducerBase &	operator= (const EDProducerBase &)=delete
virtual void	postForkReacquireResources (unsigned int, unsigned int)
virtual void	preForkReleaseResources ()
virtual void	produce (Event &, EventSetup const &)=0
virtual void	registerThinnedAssociations (ProductRegistry const &, ThinnedAssociationsHelper &)
void	setModuleDescriptionPtr (ModuleDescription const *iDesc)

Private Attributes
ModuleDescription const *	moduleDescriptionPtr_
std::vector< BranchID >	previousParentage_
ParentageID	previousParentageId_

Friends
class	EDProducerAdaptorBase
class	ProducingModuleAdaptorBase< EDProducerBase >

Additional Inherited Members
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

Description: [one line class summary]

Usage: <usage>

Definition at line 41 of file EDProducerBase.h.

Member Typedef Documentation

typedef EDProducerAdaptorBase edm::stream::EDProducerBase::ModuleType

Definition at line 48 of file EDProducerBase.h.

Constructor & Destructor Documentation

EDProducerBase::EDProducerBase

(

)

Definition at line 34 of file EDProducerBase.cc.

Referenced by moduleDescription().

                              : moduleDescriptionPtr_(nullptr)
{
}

EDProducerBase::~EDProducerBase ( )

virtual

Definition at line 43 of file EDProducerBase.cc.

{
}

edm::stream::EDProducerBase::EDProducerBase ( const EDProducerBase &  )

privatedelete

Member Function Documentation

const std::string & EDProducerBase::baseType ( )

static

Definition at line 85 of file EDProducerBase.cc.

References edm::kBaseType().

                         {
  return kBaseType;
}

virtual void edm::stream::EDProducerBase::beginLuminosityBlock ( edm::LuminosityBlock const &  , edm::EventSetup const &    )

inlineprivatevirtual

Reimplemented in edm::DataMixingModule, edm::MixingModule, l1t::L1TDigiToRaw, l1t::L1TRawToDigi, PFBlockProducer, BetafuncEvtVtxGenerator, and GsfElectronFull5x5Filler.

Definition at line 68 of file EDProducerBase.h.

References produce().

{}

virtual void edm::stream::EDProducerBase::beginRun ( edm::Run const &  , edm::EventSetup const &    )

inlineprivatevirtual

Reimplemented in HBHEPhase1Reconstructor, AlCaIsoTracksProducer, ME0SegmentMatcher, CSCChamberMasker, DTChamberMasker, edm::DataMixingModule, RPCChamberMasker, AlCaHBHEMuonProducer, edm::MixingModule, l1t::L1TDigiToRaw, l1t::L1TRawToDigi, HcalHitReconstructor, CtfSpecialSeedGenerator, ElectronSeedProducer, GEDPhotonProducer, ME0ChamberMasker, ConversionTrackCandidateProducer, PhotonProducer, GEMChamberMasker, EgammaHLTElectronDetaDphiProducer, cms::CkfTrajectoryMaker, CastorRawToDigi, RPCTwinMuxRawToDigi, cms::CkfTrackCandidateMaker, ZdcHitReconstructor, RPCTwinMuxDigiToRaw, HcalSimpleReconstructor, FastTSGFromL2Muon, ZdcSimpleReconstructor, ParticleBasedIsoProducer, and HFEMClusterProducer.

Definition at line 67 of file EDProducerBase.h.

{}

virtual void edm::stream::EDProducerBase::beginStream ( StreamID  )

inlineprivatevirtual

Reimplemented in edm::BMixingModule, L1TCaloLayer1RawToDigi, CTPPSRecHitProducer, ClusterSummaryProducer, DeepFlavourJetTagsProducer, CTPPSFastTrackingProducer, BoostedDoubleSVProducer, DeepCMVATagInfoProducer, CTPPSSimHitProducer, HIMultiTrackSelector, TemplatedDeepNNTagInfoProducer< IPTag, SVTag >, TrackingRecHitProducer, __class__< T >, MultiTrackSelector, TestBXVectorRefProducer, MuMuForEmbeddingSelector, __class__< T >, TrackMVAClassifierBase, FastTrackerRecHitCombiner, HiFJRhoProducer, and HiFJGridEmptyAreaCalculator.

Definition at line 66 of file EDProducerBase.h.

{}

virtual void edm::stream::EDProducerBase::endLuminosityBlock ( edm::LuminosityBlock const &  , edm::EventSetup const &    )

inlineprivatevirtual

Reimplemented in edm::DataMixingModule, edm::MixingModule, l1t::L1TDigiToRaw, and l1t::L1TRawToDigi.

Definition at line 70 of file EDProducerBase.h.

{}

virtual void edm::stream::EDProducerBase::endRun ( edm::Run const &  , edm::EventSetup const &    )

inlineprivatevirtual

Reimplemented in HBHEPhase1Reconstructor, AlCaIsoTracksProducer, RPCChamberMasker, AlCaHBHEMuonProducer, edm::MixingModule, l1t::L1TDigiToRaw, l1t::L1TRawToDigi, HcalHitReconstructor, CtfSpecialSeedGenerator, ElectronSeedProducer, GEDPhotonProducer, ME0ChamberMasker, PhotonProducer, GEMChamberMasker, ZdcHitReconstructor, HcalSimpleReconstructor, ZdcSimpleReconstructor, and ParticleBasedIsoProducer.

Definition at line 71 of file EDProducerBase.h.

{}

virtual void edm::stream::EDProducerBase::endStream ( )

inlineprivatevirtual

Reimplemented in AlCaIsoTracksProducer, TriggerSummaryProducerAOD, edm::BMixingModule, L1TCaloLayer1RawToDigi, CTPPSRecHitProducer, DeepFlavourJetTagsProducer, CTPPSFastTrackingProducer, BoostedDoubleSVProducer, DeepCMVATagInfoProducer, CTPPSSimHitProducer, TemplatedDeepNNTagInfoProducer< IPTag, SVTag >, TrackingRecHitProducer, AlCaHBHEMuonProducer, __class__< T >, TestBXVectorRefProducer, MuMuForEmbeddingSelector, __class__< T >, TotemVFATRawToDigi, OniaPhotonConversionProducer, FastTrackerRecHitCombiner, HiFJRhoProducer, HiFJGridEmptyAreaCalculator, and Multi5x5SuperClusterProducer.

Definition at line 72 of file EDProducerBase.h.

{}

void EDProducerBase::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 71 of file EDProducerBase.cc.

References edm::ConfigurationDescriptions::addDefault(), and edm::ParameterSetDescription::setUnknown().

                                                                        {
  ParameterSetDescription desc;
  desc.setUnknown();
  descriptions.addDefault(desc);
}

ModuleDescription const& edm::stream::EDProducerBase::moduleDescription ( ) const

inline

Definition at line 58 of file EDProducerBase.h.

References EDProducerBase(), moduleDescriptionPtr_, and operator=().

Referenced by pat::PATTriggerEventProducer::PATTriggerEventProducer(), pat::PATTriggerProducer::PATTriggerProducer(), edm::MixingModule::pileAllWorkers(), edm::DataMixingModule::pileWorker(), and edm::ThinningProducer< Collection, Selector >::registerThinnedAssociations().

                                                         {
        return *moduleDescriptionPtr_;
      }

const EDProducerBase& edm::stream::EDProducerBase::operator= ( const EDProducerBase &  )

privatedelete

Referenced by moduleDescription().

virtual void edm::stream::EDProducerBase::postForkReacquireResources ( unsigned  int, unsigned  int  )

inlineprivatevirtual

Definition at line 75 of file EDProducerBase.h.

{}

virtual void edm::stream::EDProducerBase::preForkReleaseResources ( )

inlineprivatevirtual

Definition at line 74 of file EDProducerBase.h.

{}

void EDProducerBase::prevalidate ( ConfigurationDescriptions &  descriptions )

static

Definition at line 78 of file EDProducerBase.cc.

References edm::edmodule_mightGet_config(), edm::kBaseType(), and AlCaHLTBitMon_QueryRunRegistry::string.

                                                              {
  edmodule_mightGet_config(iConfig);
}

virtual void edm::stream::EDProducerBase::produce ( Event &  , EventSetup const &    )

privatepure virtual

Implemented in AlCaIsoTracksProducer, HLTJetsCleanedFromLeadingLeptons< JetType >, JetConstituentSelector< T, C >, HLTRechitsToDigis, JetCorrectorProducer< T >, RPCTwinMuxRawToDigi, SubsystemNeutronWriter, edm::ThinningProducer< Collection, Selector >, RPCTwinMuxDigiToRaw, HFRecoEcalCandidateProducer, HFEMClusterProducer, and HLTDQMObjSelector< ObjType, ObjCollType >.

Referenced by beginLuminosityBlock(), JSONExport.JsonExport::export(), HTMLExport.HTMLExport::export(), HTMLExport.HTMLExportStatic::export(), MaskedMeasurementTrackerEventProducer::~MaskedMeasurementTrackerEventProducer(), MeasurementTrackerEventProducer::~MeasurementTrackerEventProducer(), and PhotonConversionTrajectorySeedProducerFromSingleLeg::~PhotonConversionTrajectorySeedProducerFromSingleLeg().

virtual void edm::stream::EDProducerBase::registerThinnedAssociations ( ProductRegistry const &  , ThinnedAssociationsHelper &    )

inlineprivatevirtual

Reimplemented in edm::ThinningProducer< Collection, Selector >.

Definition at line 76 of file EDProducerBase.h.

                                                                           { }

void edm::stream::EDProducerBase::setModuleDescriptionPtr ( ModuleDescription const *  iDesc )

inlineprivate

Definition at line 79 of file EDProducerBase.h.

References moduleDescriptionPtr_.

                                                                   {
        moduleDescriptionPtr_ = iDesc;
      }

Friends And Related Function Documentation

friend class EDProducerAdaptorBase

friend

Definition at line 44 of file EDProducerBase.h.

friend class ProducingModuleAdaptorBase< EDProducerBase >

friend

Definition at line 45 of file EDProducerBase.h.

Member Data Documentation

ModuleDescription const* edm::stream::EDProducerBase::moduleDescriptionPtr_

private

Definition at line 85 of file EDProducerBase.h.

Referenced by moduleDescription(), and setModuleDescriptionPtr().

std::vector<BranchID> edm::stream::EDProducerBase::previousParentage_

private

Definition at line 83 of file EDProducerBase.h.

ParentageID edm::stream::EDProducerBase::previousParentageId_

private

Definition at line 84 of file EDProducerBase.h.