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)
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 &)=default
	ConsumesCollector (ConsumesCollector &&)=default
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)
ConsumesCollector &	operator= (ConsumesCollector const &)=default
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 39 of file ConsumesCollector.h.

Constructor & Destructor Documentation

edm::ConsumesCollector::ConsumesCollector ( )

delete

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

default

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

default

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

inlineprivate

Definition at line 100 of file ConsumesCollector.h.

                                                :
    m_consumer(iConsumer) {}

Member Function Documentation

template<typename ProductType , BranchType B = InEvent>

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

inline

Definition at line 52 of file ConsumesCollector.h.

References m_consumer, and GlobalPosition_Frontier_DevDB_cff::tag.

Referenced by tnp::BaseTreeFiller::addBranches_(), AlignmentGlobalTrackSelector::AlignmentGlobalTrackSelector(), AlignmentTrackSelector::AlignmentTrackSelector(), AlignmentTwoBodyDecayTrackSelector::AlignmentTwoBodyDecayTrackSelector(), tnp::BaseTreeFiller::BaseTreeFiller(), l1t::stage2::BMTFTokens::BMTFTokens(), HLTHiggsSubAnalysis::bookobjects(), MuonTrackingRegionBuilder::build(), l1t::stage2::CaloTokens::CaloTokens(), l1t::stage1::CaloTokens::CaloTokens(), CastorDigiProducer::CastorDigiProducer(), ClusterChecker::ClusterChecker(), ConversionSeedFinder::ConversionSeedFinder(), CutBasedElectronID::CutBasedElectronID(), DualByL2TSG::DualByL2TSG(), EcalRecHitWorkerRecover::EcalRecHitWorkerRecover(), EcalTBDigiProducer::EcalTBDigiProducer(), EcalUncalibRecHitWorkerMultiFit::EcalUncalibRecHitWorkerMultiFit(), ElectronIDSelectorLikelihood::ElectronIDSelectorLikelihood(), l1t::stage2::EMTFTokens::EMTFTokens(), ExpressionVariable< Object, label >::ExpressionVariable(), FastTSGFromIOHit::FastTSGFromIOHit(), GetLumi::GetLumi(), GlobalCosmicMuonTrajectoryBuilder::GlobalCosmicMuonTrajectoryBuilder(), GlobalMuonRefitter::GlobalMuonRefitter(), GlobalMuonTrajectoryBuilder::GlobalMuonTrajectoryBuilder(), GlobalTrackingRegionProducerFromBeamSpot::GlobalTrackingRegionProducerFromBeamSpot(), l1t::stage2::GMTTokens::GMTTokens(), l1t::stage2::GTTokens::GTTokens(), HcalDigitizer::HcalDigitizer(), HcalTBDigiProducer::HcalTBDigiProducer(), HGCDigitizer::HGCDigitizer(), HLTBitComputer::HLTBitComputer(), HLTEventSelector::HLTEventSelector(), PVFitter::initialize(), JetMETDQMDCSFilter::JetMETDQMDCSFilter(), L1BitComputer::L1BitComputer(), L1GtUtilsHelper::L1GtUtilsHelper(), L1JPTOffsetCorrectorImplMaker::L1JPTOffsetCorrectorImplMaker(), L3MuonTrajectoryBuilder::L3MuonTrajectoryBuilder(), TrackAssociatorParameters::loadParameters(), reco::modules::ParameterAdapter< MCMatchCandRefSelector >::make(), MuonCosmicCompatibilityFiller::MuonCosmicCompatibilityFiller(), MuonDetLayerMeasurements::MuonDetLayerMeasurements(), MuonSegmentMatcher::MuonSegmentMatcher(), MuonShowerInformationFiller::MuonShowerInformationFiller(), MuonTrackLoader::MuonTrackLoader(), MuonTrackValidatorBase::MuonTrackValidatorBase(), MuonVPlusJetsIDSelectionFunctor::MuonVPlusJetsIDSelectionFunctor(), L1GtUtilsHelper::operator()(), pat::PATUserDataMerger< ObjectType, Operation >::PATUserDataMerger(), PF_PU_AssoMapAlgos::PF_PU_AssoMapAlgos(), PFEcalRecHitCreator< Geometry, Layer, Detector >::PFEcalRecHitCreator(), PFEcalRecHitCreatorMaxSample< Geometry, Layer, Detector >::PFEcalRecHitCreatorMaxSample(), PFHBHERecHitCreator::PFHBHERecHitCreator(), PFHBHERecHitCreatorMaxSample::PFHBHERecHitCreatorMaxSample(), PFHcalRecHitCreator< Digi, Geometry, Layer, Detector >::PFHcalRecHitCreator(), PFHFRecHitCreator::PFHFRecHitCreator(), PFHGCalRecHitCreator< DET, Layer, subdet >::PFHGCalRecHitCreator(), PFPSRecHitCreator::PFPSRecHitCreator(), cms::PileupVertexAccumulator::PileupVertexAccumulator(), PixelClusterShapeSeedComparitor::PixelClusterShapeSeedComparitor(), RazorComputer::RazorComputer(), RecoTrackAccumulator::RecoTrackAccumulator(), RecoTrackSelectorBase::RecoTrackSelectorBase(), HLTExoticaSubAnalysis::registerConsumes(), SeedFilter::SeedFilter(), SegmentsTrackAssociator::SegmentsTrackAssociator(), PhoFull5x5SigmaIEtaIEtaValueMapCut::setConsumes(), GsfEleMVACut::setConsumes(), PhoMVACut::setConsumes(), PhoAnyPFIsoWithEAAndQuadScalingCut::setConsumes(), GsfEleEffAreaPFIsoCut::setConsumes(), PhoAnyPFIsoWithEAAndExpoScalingCut::setConsumes(), PhoAnyPFIsoWithEACut::setConsumes(), PhoAnyPFIsoWithEAAndExpoScalingEBCut::setConsumes(), MuonPOGStandardCut::setConsumes(), GsfEleDeltaBetaIsoCut::setConsumes(), GsfEleConversionVetoCut::setConsumes(), MuonDxyCut::setConsumes(), MuonDzCut::setConsumes(), GsfEleEmHadD1IsoRhoCut::setConsumes(), EGExtraInfoModifierFromIntValueMaps::setConsumes(), EGExtraInfoModifierFromFloatValueMaps::setConsumes(), EGPfIsolationModifierFromValueMaps::setConsumes(), EGExtraInfoModifierFromDB::setConsumes(), EGFull5x5ShowerShapeModifierFromValueMaps::setConsumes(), SETPatternRecognition::SETPatternRecognition(), CollHandle< EEDigiCollection >::setToken(), SCEnergyCorrectorSemiParm::setTokens(), ecaldqm::ClusterTask::setTokens(), cms::SiPixelDigitizer::SiPixelDigitizer(), SiStripDCSStatus::SiStripDCSStatus(), SiStripDigitizer::SiStripDigitizer(), TrackAnalyzer::TrackAnalyzer(), TrackerSeedCleaner::TrackerSeedCleaner(), TrackingTruthAccumulator::TrackingTruthAccumulator(), TSGForRoadSearch::TSGForRoadSearch(), TSGFromPropagation::TSGFromPropagation(), METCorrectionAlgorithm::type2BinningEntryType::type2BinningEntryType(), ctfseeding::HitExtractorSTRP::useMatchedHits(), ctfseeding::HitExtractorSTRP::useRPhiHits(), ctfseeding::HitExtractorPIX::useSkipClusters_(), ctfseeding::HitExtractorSTRP::useSkipClusters_(), ctfseeding::HitExtractorSTRP::useStereoHits(), VertexMonitor::VertexMonitor(), and WeightManager::WeightManager().

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

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

inline

Definition at line 56 of file ConsumesCollector.h.

References m_consumer.

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

template<BranchType B>

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

inline

Definition at line 61 of file ConsumesCollector.h.

References m_consumer, and GlobalPosition_Frontier_DevDB_cff::tag.

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

template<typename ProductType , BranchType B = InEvent>

void edm::ConsumesCollector::consumesMany ( )

inline

Definition at line 81 of file ConsumesCollector.h.

References m_consumer.

                        {
      m_consumer->consumesMany<ProductType,B>();
    }

void edm::ConsumesCollector::consumesMany ( const TypeToGet &  id )

inline

Definition at line 86 of file ConsumesCollector.h.

References m_consumer.

                                           {
      m_consumer->consumesMany(id);
    }

template<BranchType B>

void edm::ConsumesCollector::consumesMany ( const TypeToGet &  id )

inline

Definition at line 91 of file ConsumesCollector.h.

References m_consumer.

                                           {
      m_consumer->consumesMany<B>(id);
    }

template<typename ProductType , BranchType B = InEvent>

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

inline

Definition at line 66 of file ConsumesCollector.h.

References m_consumer, and GlobalPosition_Frontier_DevDB_cff::tag.

Referenced by GenericTriggerEventFlag::GenericTriggerEventFlag(), cms::PileupVertexAccumulator::PileupVertexAccumulator(), PrescaleWeightProvider::PrescaleWeightProvider(), MuonIdTruthInfo::registerConsumes(), EDMtoMEConverter::Tokens< T >::set(), GsfEleDzCut::setConsumes(), GsfEleDxyCut::setConsumes(), GsfEleConversionVetoCut::setConsumes(), ElectronPFIsolationWithMapBasedVeto::setConsumes(), and PhotonPFIsolationWithMapBasedVeto::setConsumes().

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

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

inline

Definition at line 71 of file ConsumesCollector.h.

References m_consumer.

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

template<BranchType B>

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

inline

Definition at line 76 of file ConsumesCollector.h.

References m_consumer, and GlobalPosition_Frontier_DevDB_cff::tag.

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

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

default

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

default

Friends And Related Function Documentation

friend class EDConsumerBase

friend

Definition at line 98 of file ConsumesCollector.h.

Member Data Documentation

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

private

Definition at line 104 of file ConsumesCollector.h.

Referenced by consumes(), consumesMany(), and mayConsume().