edm::ConsumesCollector Class Reference

#include "FWCore/Framework/interface/ConsumesCollector.h"

Public Member Functions
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
ConsumesCollectorAdaptor< B >	consumes (edm::InputTag tag)
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
	ConsumesCollector ()=delete
	ConsumesCollector (ConsumesCollector const &)
	ConsumesCollector (ConsumesCollector &&)=default
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<typename ESProduct , Transition Tr = Transition::Event>
auto	esConsumes (eventsetup::EventSetupRecordKey const &key, ESInputTag const &tag)
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept
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)
ConsumesCollector &	operator= (ConsumesCollector const &)
ConsumesCollector &	operator= (ConsumesCollector &&)=default

Private Member Functions
	ConsumesCollector (EDConsumerBase *iConsumer)

Private Attributes
edm::propagate_const< EDConsumerBase * >	m_consumer

Friends
class	EDConsumerBase

Detailed Description

Description: Helper class to gather consumes information for EDConsumerBase class.

Usage: The constructor of a module can get an instance of edm::ConsumesCollector by calling its consumesCollector() method. This instance can then be passed to helper classes in order to register the data the helper will request from an Event, LuminosityBlock or Run on behalf of the module.

 WARNING: The ConsumesCollector should be used during the time that modules are being

constructed. It should not be saved and used later. It will not work if it is used to call the consumes function during beginJob, beginRun, beginLuminosity block, event processing or at any later time. It can be used while the module constructor is running or be contained in a functor passed to the Framework with a call to callWhenNewProductsRegistered.

Definition at line 45 of file ConsumesCollector.h.

Constructor & Destructor Documentation

ConsumesCollector() [1/4]

edm::ConsumesCollector::ConsumesCollector ( )

delete

ConsumesCollector() [2/4]

edm::ConsumesCollector::ConsumesCollector

(

ConsumesCollector const &

other

)

Definition at line 5 of file ConsumesCollector.cc.

: m_consumer(get_underlying(other.m_consumer)) {}

ConsumesCollector() [3/4]

edm::ConsumesCollector::ConsumesCollector ( ConsumesCollector &&  )

default

ConsumesCollector() [4/4]

edm::ConsumesCollector::ConsumesCollector ( EDConsumerBase *  iConsumer )

inlineprivate

Definition at line 113 of file ConsumesCollector.h.

: m_consumer(iConsumer) {}

Member Function Documentation

consumes() [1/4]

template<typename ProductType , BranchType B = InEvent>

EDGetTokenT<ProductType> edm::ConsumesCollector::consumes ( edm::InputTag const &  tag )

inline

Definition at line 55 of file ConsumesCollector.h.

References B, m_consumer, and makeGlobalPositionRcd_cfg::tag.

Referenced by tnp::BaseTreeFiller::addBranches_(), AlignmentGlobalTrackSelector::AlignmentGlobalTrackSelector(), AlignmentTrackSelector::AlignmentTrackSelector(), AlignmentTwoBodyDecayTrackSelector::AlignmentTwoBodyDecayTrackSelector(), AreaSeededTrackingRegionsBuilder::AreaSeededTrackingRegionsBuilder(), tnp::BaseTreeFiller::BaseTreeFiller(), HLTHiggsSubAnalysis::bookobjects(), MuonTrackingRegionByPtBuilder::build(), MuonTrackingRegionBuilder::build(), CaloParticleDebugger::CaloParticleDebugger(), CaloTruthAccumulator::CaloTruthAccumulator(), ClusterChecker::ClusterChecker(), DTHitAssociator::Config::Config(), GEMHitAssociator::Config::Config(), RPCHitAssociator::Config::Config(), ConversionSeedFinder::ConversionSeedFinder(), CosmicSplitterValidation::CosmicSplitterValidation(), CutBasedElectronID::CutBasedElectronID(), DTSegmentSelector::DTSegmentSelector(), DualByL2TSG::DualByL2TSG(), ExpressionVariable< Object, label >::ExpressionVariable(), FastTSGFromIOHit::FastTSGFromIOHit(), GetLumi::GetLumi(), GlobalCosmicMuonTrajectoryBuilder::GlobalCosmicMuonTrajectoryBuilder(), GlobalMuonRefitter::GlobalMuonRefitter(), GlobalMuonTrajectoryBuilder::GlobalMuonTrajectoryBuilder(), GlobalTrackingRegionProducerFromBeamSpot::GlobalTrackingRegionProducerFromBeamSpot(), HcalTBDigiProducer::HcalTBDigiProducer(), HLTBitComputer::HLTBitComputer(), HLTEventSelector::HLTEventSelector(), pathStatusExpression::Operand::init(), edm::pathStatusExpression::Operand::init(), PVFitter::initialize(), JetMETDQMDCSFilter::JetMETDQMDCSFilter(), L1BitComputer::L1BitComputer(), L1GtUtilsHelper::L1GtUtilsHelper(), L1JPTOffsetCorrectorImplMaker::L1JPTOffsetCorrectorImplMaker(), l1t::L1TGlobalUtilHelper::L1TGlobalUtilHelper(), L3MuonTrajectoryBuilder::L3MuonTrajectoryBuilder(), TrackAssociatorParameters::loadParameters(), reco::modules::ParameterAdapter< MCMatchCandRefSelector >::make(), MTDDigitizerBase::MTDDigitizerBase(), MtdTruthAccumulator::MtdTruthAccumulator(), MuonCosmicCompatibilityFiller::MuonCosmicCompatibilityFiller(), MuonDetLayerMeasurements::MuonDetLayerMeasurements(), MuonSegmentMatcher::MuonSegmentMatcher(), MuonShowerInformationFiller::MuonShowerInformationFiller(), MuonTrackLoader::MuonTrackLoader(), MuonTrackValidatorBase::MuonTrackValidatorBase(), MuonVPlusJetsIDSelectionFunctor::MuonVPlusJetsIDSelectionFunctor(), OverlapValidation::OverlapValidation(), pat::PATUserDataMerger< pat::Jet, pat::helper::AddUserInt >::PATUserDataMerger(), PF_PU_AssoMapAlgos::PF_PU_AssoMapAlgos(), cms::PileupVertexAccumulator::PileupVertexAccumulator(), PixelClusterShapeSeedComparitor::PixelClusterShapeSeedComparitor(), RazorComputer::RazorComputer(), RecoTrackAccumulator::RecoTrackAccumulator(), RecoTrackSelectorBase::RecoTrackSelectorBase(), HLTExoticaSubAnalysis::registerConsumes(), SeedingLayerSetsBuilder::SeedingLayerSetsBuilder(), SegmentsTrackAssociator::SegmentsTrackAssociator(), SETPatternRecognition::SETPatternRecognition(), CollHandle< EEDigiCollection >::setToken(), ecaldqm::OccupancyTask::setTokens(), ecaldqm::TrigPrimTask::setTokens(), ecaldqm::ClusterTask::setTokens(), cms::SiPixelDigitizer::SiPixelDigitizer(), SiStripDCSStatus::SiStripDCSStatus(), SiStripDigitizer::SiStripDigitizer(), tadqm::TrackAnalyzer::TrackAnalyzer(), TrackerSeedCleaner::TrackerSeedCleaner(), TrackingSeedCandidates::TrackingSeedCandidates(), TrackingTruthAccumulator::TrackingTruthAccumulator(), TSGForRoadSearch::TSGForRoadSearch(), METCorrectionAlgorithm::type2BinningEntryType::type2BinningEntryType(), ctfseeding::HitExtractorSTRP::useMatchedHits(), ctfseeding::HitExtractorSTRP::useRPhiHits(), ctfseeding::HitExtractorPIX::useSkipClusters_(), ctfseeding::HitExtractorSTRP::useSkipClusters_(), ctfseeding::HitExtractorSTRP::useStereoHits(), ctfseeding::HitExtractorSTRP::useVectorHits(), VertexBeamspotOrigins::VertexBeamspotOrigins(), VertexClassifier::VertexClassifier(), VertexHistory::VertexHistory(), VertexMonitor::VertexMonitor(), and WeightManager::WeightManager().

                                                              {
      return m_consumer->consumes<ProductType, B>(tag);
    }

consumes() [2/4]

template<BranchType B = InEvent>

ConsumesCollectorAdaptor<B> edm::ConsumesCollector::consumes ( edm::InputTag  tag )

inline

Definition at line 60 of file ConsumesCollector.h.

References eostools::move(), and makeGlobalPositionRcd_cfg::tag.

                                                                        {
      return ConsumesCollectorAdaptor<B>(*this, std::move(tag));
    }

consumes() [3/4]

EDGetToken edm::ConsumesCollector::consumes ( const TypeToGet &  id, edm::InputTag const &  tag  )

inline

Definition at line 64 of file ConsumesCollector.h.

References m_consumer, and makeGlobalPositionRcd_cfg::tag.

{ return m_consumer->consumes(id, tag); }

consumes() [4/4]

template<BranchType B>

EDGetToken edm::ConsumesCollector::consumes ( TypeToGet const &  id, edm::InputTag const &  tag  )

inline

Definition at line 67 of file ConsumesCollector.h.

References B, EcalPhiSymFlatTableProducers_cfi::id, m_consumer, and makeGlobalPositionRcd_cfg::tag.

                                                                     {
      return m_consumer->consumes<B>(id, tag);
    }

esConsumes() [1/5]

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>

auto edm::ConsumesCollector::esConsumes ( )

inline

Definition at line 85 of file ConsumesCollector.h.

Referenced by ConcreteFFTJetRcdMapper< DataType, RecordType >::acquireToken(), AngleConverter::AngleConverter(), AreaSeededTrackingRegionsBuilder::AreaSeededTrackingRegionsBuilder(), MuonTrackingRegionByPtBuilder::build(), MuonTrackingRegionBuilder::build(), CaloParticleDebugger::CaloParticleDebugger(), hgcal::ClusterTools::ClusterTools(), CSCTFPtLUT::consumes(), CSCTFSectorProcessor::consumes(), L1TMenuHelper::consumes(), ConversionSeedFinder::ConversionSeedFinder(), DTSegmentSelector::DTSegmentSelector(), deDxTools::esConsumes(), l1t::L1TGlobalUtil::eventSetupConsumes(), L1RegionData< T1 >::eventSetupConsumes(), GenericTriggerEventFlag::GenericTriggerEventFlag(), GlobalMuonRefitter::GlobalMuonRefitter(), GlobalTrackingRegionProducerFromBeamSpot::GlobalTrackingRegionProducerFromBeamSpot(), GlobalTrajectoryBuilderBase::GlobalTrajectoryBuilderBase(), HcalDigitizer::HcalDigitizer(), HcalPulseShapes::HcalPulseShapes(), HLTInfo::HLTInfo(), HoughGrouping::HoughGrouping(), pat::helper::KinResolutionsLoader::KinResolutionsLoader(), L1GtUtils::L1GtUtils(), TrackAssociatorParameters::loadParameters(), MTDRecHitAlgo::MTDRecHitAlgo(), MultiHitGeneratorFromChi2::MultiHitGeneratorFromChi2(), MuonCosmicCompatibilityFiller::MuonCosmicCompatibilityFiller(), MuonPathAnalyticAnalyzer::MuonPathAnalyticAnalyzer(), MuonPathAnalyzerInChamber::MuonPathAnalyzerInChamber(), MuonPathAssociator::MuonPathAssociator(), MuonPathFitter::MuonPathFitter(), MuonShowerInformationFiller::MuonShowerInformationFiller(), MuonTrackLoader::MuonTrackLoader(), PFMETAlgorithmMVA::PFMETAlgorithmMVA(), edm::PileUp::PileUp(), PixelDigitizerAlgorithm::PixelDigitizerAlgorithm(), PixelTripletHLTGenerator::PixelTripletHLTGenerator(), PixelTripletLargeTipGenerator::PixelTripletLargeTipGenerator(), PSPDigitizerAlgorithm::PSPDigitizerAlgorithm(), PSSDigitizerAlgorithm::PSSDigitizerAlgorithm(), RPCIntegrator::RPCIntegrator(), SeedingLayerSetsBuilder::SeedingLayerSetsBuilder(), ticl::SeedingRegionByHF::SeedingRegionByHF(), ticl::SeedingRegionByTracks::SeedingRegionByTracks(), SeedTransformer::SeedTransformer(), SegmentsTrackAssociator::SegmentsTrackAssociator(), ecaldqm::IntegrityClient::setTokens(), ecaldqm::PresampleTask::setTokens(), ecaldqm::TowerStatusTask::setTokens(), ecaldqm::OccupancyTask::setTokens(), ecaldqm::SelectiveReadoutTask::setTokens(), ecaldqm::TrigPrimTask::setTokens(), ecaldqm::ClusterTask::setTokens(), ecaldqm::DQWorker::setTokens(), HGCalShowerShapeHelper::setTokens(), sistriptools::algorithm::SingleMultiplicity< T >::SingleMultiplicity(), SiPixelChargeReweightingAlgorithm::SiPixelChargeReweightingAlgorithm(), SiPixelDigitizerAlgorithm::SiPixelDigitizerAlgorithm(), SiStripClassToMonitorCondData::SiStripClassToMonitorCondData(), SiStripDCSStatus::SiStripDCSStatus(), SiStripDigitizer::SiStripDigitizer(), SiStripQualityWithFromFedErrorsHelper::SiStripQualityWithFromFedErrorsHelper(), SiStripRecHitConverterAlgorithm::SiStripRecHitConverterAlgorithm(), SSDigitizerAlgorithm::SSDigitizerAlgorithm(), L1GetHistLimits::Tokens::Tokens(), tadqm::TrackAnalyzer::TrackAnalyzer(), TrackerSeedCleaner::TrackerSeedCleaner(), and TrackTransformer::TrackTransformer().

                      {
      return esConsumes<ESProduct, ESRecord, Tr>(ESInputTag{});
    }

esConsumes() [2/5]

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>

auto edm::ConsumesCollector::esConsumes ( ESInputTag const &  tag )

inline

Definition at line 90 of file ConsumesCollector.h.

References m_consumer, and makeGlobalPositionRcd_cfg::tag.

                                           {
      return m_consumer->esConsumes<ESProduct, ESRecord, Tr>(tag);
    }

esConsumes() [3/5]

template<typename ESProduct , Transition Tr = Transition::Event>

auto edm::ConsumesCollector::esConsumes ( eventsetup::EventSetupRecordKey const &  key, ESInputTag const &  tag  )

inline

Definition at line 95 of file ConsumesCollector.h.

References submitPVResolutionJobs::key, m_consumer, and makeGlobalPositionRcd_cfg::tag.

                                                                                     {
      return m_consumer->esConsumes<ESProduct, Tr>(key, tag);
    }

esConsumes() [4/5]

template<Transition Tr = Transition::Event>

constexpr auto edm::ConsumesCollector::esConsumes ( )

inlinenoexcept

Definition at line 100 of file ConsumesCollector.h.

                                                       {
      return ConsumesCollectorESAdaptor<Tr>(*this);
    }

esConsumes() [5/5]

template<Transition Tr = Transition::Event>

auto edm::ConsumesCollector::esConsumes ( ESInputTag  tag )

inlinenoexcept

Definition at line 105 of file ConsumesCollector.h.

References eostools::move(), and makeGlobalPositionRcd_cfg::tag.

                                                           {
      return ConsumesCollectorWithTagESAdaptor<Tr>(*this, std::move(tag));
    }

mayConsume() [1/3]

template<typename ProductType , BranchType B = InEvent>

EDGetTokenT<ProductType> edm::ConsumesCollector::mayConsume ( edm::InputTag const &  tag )

inline

Definition at line 72 of file ConsumesCollector.h.

References B, m_consumer, and makeGlobalPositionRcd_cfg::tag.

Referenced by tnp::BaseTreeFiller::BaseTreeFiller(), GenericTriggerEventFlag::GenericTriggerEventFlag(), GlobalMuonTrajectoryBuilder::GlobalMuonTrajectoryBuilder(), cms::PileupVertexAccumulator::PileupVertexAccumulator(), PrescaleWeightProvider::PrescaleWeightProvider(), MuonIdTruthInfo::registerConsumes(), EDMtoMEConverter::Tokens< T >::set(), PhotonPFIsolationWithMapBasedVeto::setConsumes(), ElectronPFIsolationWithMapBasedVeto::setConsumes(), tadqm::TrackAnalyzer::TrackAnalyzer(), and TriggerHelper::TriggerHelper().

                                                                {
      return m_consumer->mayConsume<ProductType, B>(tag);
    }

mayConsume() [2/3]

EDGetToken edm::ConsumesCollector::mayConsume ( const TypeToGet &  id, edm::InputTag const &  tag  )

inline

Definition at line 76 of file ConsumesCollector.h.

References m_consumer, and makeGlobalPositionRcd_cfg::tag.

{ return m_consumer->mayConsume(id, tag); }

mayConsume() [3/3]

template<BranchType B>

EDGetToken edm::ConsumesCollector::mayConsume ( const TypeToGet &  id, edm::InputTag const &  tag  )

inline

Definition at line 79 of file ConsumesCollector.h.

References B, EcalPhiSymFlatTableProducers_cfi::id, m_consumer, and makeGlobalPositionRcd_cfg::tag.

                                                                       {
      return m_consumer->mayConsume<B>(id, tag);
    }

operator=() [1/2]

ConsumesCollector & edm::ConsumesCollector::operator=

(

ConsumesCollector const &

other

)

Definition at line 7 of file ConsumesCollector.cc.

References edm::get_underlying(), m_consumer, and trackingPlots::other.

                                                                                {
    m_consumer = get_underlying(other.m_consumer);
    return *this;
  }

operator=() [2/2]

ConsumesCollector& edm::ConsumesCollector::operator= ( ConsumesCollector &&  )

default

Friends And Related Function Documentation

EDConsumerBase

friend class EDConsumerBase

friend

Definition at line 111 of file ConsumesCollector.h.

Member Data Documentation

m_consumer

edm::propagate_const<EDConsumerBase*> edm::ConsumesCollector::m_consumer

private

Definition at line 116 of file ConsumesCollector.h.

Referenced by consumes(), esConsumes(), mayConsume(), and operator=().