edm::EDConsumerBase Class Reference

#include <EDConsumerBase.h>

Inheritance diagram for edm::EDConsumerBase:

Classes
struct	LabelPlacement
struct	TokenLookupInfo

Public Types
typedef ProductLabels	Labels

Public Member Functions
std::vector< ConsumesInfo >	consumesInfo () const
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesDependentUpon (std::string const &iProcessName, std::string const &iModuleLabel, bool iPrint, std::vector< char const * > &oModuleLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Protected 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	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)

Private Types
enum	{ kLookupInfo, kAlwaysGets, kLabels, kKind }

Private Member Functions
edm::InputTag const &	checkIfEmpty (edm::InputTag const &tag)
	EDConsumerBase (const EDConsumerBase &)=delete
const EDConsumerBase &	operator= (const EDConsumerBase &)=delete
unsigned int	recordConsumes (BranchType iBranch, TypeToGet const &iType, edm::InputTag const &iTag, bool iAlwaysGets)
void	throwBadToken (edm::TypeID const &iType, EDGetToken iToken) const
void	throwBranchMismatch (BranchType, EDGetToken) const
void	throwConsumesCallAfterFrozen (TypeToGet const &, InputTag const &) const
void	throwTypeMismatch (edm::TypeID const &, EDGetToken) const

Private Attributes
bool	frozen_
std::vector < ProductHolderIndexAndSkipBit >	itemsToGetFromEvent_
edm::SoATuple< TokenLookupInfo, bool, LabelPlacement, edm::KindOfType >	m_tokenInfo
std::vector< char >	m_tokenLabels

Friends
class	ConsumesCollector
template<typename T >
class	WillGetIfMatch

Detailed Description

Description: Allows declaration of what data is being consumed

Usage: The EDM modules all inherit from this base class

Definition at line 49 of file EDConsumerBase.h.

Member Typedef Documentation

typedef ProductLabels edm::EDConsumerBase::Labels

Definition at line 75 of file EDConsumerBase.h.

Member Enumeration Documentation

anonymous enum

private

Enumerator
kLookupInfo
kAlwaysGets
kLabels
kKind

Definition at line 180 of file EDConsumerBase.h.

{kLookupInfo,kAlwaysGets,kLabels,kKind};

Constructor & Destructor Documentation

edm::EDConsumerBase::EDConsumerBase ( )

inline

Definition at line 53 of file EDConsumerBase.h.

: frozen_(false) {}

EDConsumerBase::~EDConsumerBase ( )

virtual

Definition at line 52 of file EDConsumerBase.cc.

{
}

edm::EDConsumerBase::EDConsumerBase ( const EDConsumerBase &  )

privatedelete

Member Function Documentation

edm::InputTag const & EDConsumerBase::checkIfEmpty ( edm::InputTag const &  tag )

private

Definition at line 80 of file EDConsumerBase.cc.

References kWasEmpty, and edm::InputTag::label().

Referenced by consumes(), and mayConsume().

                                                    {
  if (iTag.label().empty()) {
    return kWasEmpty;
  }
  return iTag;
}

template<typename ProductType , BranchType B = InEvent>

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

inlineprotected

Definition at line 97 of file EDConsumerBase.h.

References checkIfEmpty(), and recordConsumes().

Referenced by AlCaECALRecHitReducer::AlCaECALRecHitReducer(), MixCollectionValidation::bookHistograms(), BTagPerformanceAnalyzerMC::BTagPerformanceAnalyzerMC(), BTagPerformanceAnalyzerOnData::BTagPerformanceAnalyzerOnData(), pat::CandidateSummaryTable::CandidateSummaryTable(), EcalPileUpDepMonitor::EcalPileUpDepMonitor(), EGammaCutBasedEleIdAnalyzer::EGammaCutBasedEleIdAnalyzer(), EmDQMReco::EmDQMReco(), edm::EventContentAnalyzer::EventContentAnalyzer(), EcalDQMonitorTask::formSchedule(), GoodSeedProducer::GoodSeedProducer(), HITrackClusterRemover::HITrackClusterRemover(), HLTMuonIsoFilter::HLTMuonIsoFilter(), HLTMuonPFIsoFilter::HLTMuonPFIsoFilter(), JetTagProducer::JetTagProducer(), edm::OutputModule::keepThisBranch(), edm::one::OutputModuleBase::keepThisBranch(), edm::global::OutputModuleBase::keepThisBranch(), cms::METSignificanceProducer::METSignificanceProducer(), MultiplicityCorrelator::MultiplicityCorrelator(), MultiTrackValidator::MultiTrackValidator(), MuonProducer::MuonProducer(), MuonTrackValidator::MuonTrackValidator(), NoPileUpPFMEtProducer::NoPileUpPFMEtProducer(), pat::PATElectronProducer::PATElectronProducer(), pat::PATGenericParticleProducer::PATGenericParticleProducer(), pat::PATJetProducer::PATJetProducer(), pat::PATMETProducer::PATMETProducer(), pat::PATMuonProducer::PATMuonProducer(), pat::PATPackedCandidateProducer::PATPackedCandidateProducer(), pat::PATPFParticleProducer::PATPFParticleProducer(), pat::PATPhotonProducer::PATPhotonProducer(), pat::PATSingleVertexSelector::PATSingleVertexSelector(), pat::PATTauProducer::PATTauProducer(), pat::PATVertexAssociationProducer::PATVertexAssociationProducer(), PFTrackProducer::PFTrackProducer(), PrimaryVertexAnalyzer4PUSlimmed::PrimaryVertexAnalyzer4PUSlimmed(), ReducedEGProducer::ReducedEGProducer(), SeedMultiplicityAnalyzer::SeedMultiplicityAnalyzer(), ShallowSimhitClustersProducer::ShallowSimhitClustersProducer(), SiStripMonitorDigi::SiStripMonitorDigi(), and TrackingParticleNumberOfLayersProducer::TrackingParticleNumberOfLayersProducer().

                                                              {
      TypeToGet tid=TypeToGet::make<ProductType>();
      return EDGetTokenT<ProductType>{recordConsumes(B,tid, checkIfEmpty(tag),true)};
    }

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

inlineprotected

Definition at line 102 of file EDConsumerBase.h.

References checkIfEmpty(), edm::InEvent, and recordConsumes().

                                                                     {
      return EDGetToken{recordConsumes(InEvent, id, checkIfEmpty(tag), true)};
    }

template<BranchType B>

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

inlineprotected

Definition at line 107 of file EDConsumerBase.h.

References checkIfEmpty(), and recordConsumes().

                                                                     {
      return EDGetToken{recordConsumes(B, id, checkIfEmpty(tag), true)};
    }

ConsumesCollector EDConsumerBase::consumesCollector ( )

protected

Use a ConsumesCollector to gather consumes information from helper functions.

Definition at line 72 of file EDConsumerBase.cc.

References EnergyCorrector::c.

Referenced by AlcaBeamMonitor::AlcaBeamMonitor(), AlcaBeamSpotProducer::AlcaBeamSpotProducer(), IsolatedParticlesGeneratedJets::analyze(), BCToEFilter::BCToEFilter(), BeamMonitor::BeamMonitor(), BeamMonitorBx::BeamMonitorBx(), BeamSpotAnalyzer::BeamSpotAnalyzer(), TSGFromL1Muon::beginRun(), FastTSGFromL2Muon::beginRun(), DTTrigTest::beginRun(), CandIsoDepositProducer::CandIsoDepositProducer(), CandIsolatorFromDeposits::CandIsolatorFromDeposits(), ConfigurableAnalysis::ConfigurableAnalysis(), CorrectedECALPFClusterProducer::CorrectedECALPFClusterProducer(), CorrectedMETProducerT< T >::CorrectedMETProducerT(), CosmicsMuonIdProducer::CosmicsMuonIdProducer(), CosmicSplitterValidation::CosmicSplitterValidation(), CSCDigiValidation::CSCDigiValidation(), CSCMonitorModule::CSCMonitorModule(), CSCRecHitValidation::CSCRecHitValidation(), CtfSpecialSeedGenerator::CtfSpecialSeedGenerator(), edm::DataMixingModule::DataMixingModule(), DTTrigProd::DTTrigProd(), EcalCosmicsHists::EcalCosmicsHists(), EcalDQMonitorTask::EcalDQMonitorTask(), EcalRecHitProducer::EcalRecHitProducer(), EcalSelectiveReadoutValidation::EcalSelectiveReadoutValidation(), EcalUncalibRecHitProducer::EcalUncalibRecHitProducer(), EDMtoMEConverter::EDMtoMEConverter(), EgammaHLTPixelMatchElectronProducers::EgammaHLTPixelMatchElectronProducers(), EgHLTOfflineSource::EgHLTOfflineSource(), ElectronSeedProducer::ElectronSeedProducer(), EopTreeWriter::EopTreeWriter(), EventWithHistoryEDFilter::EventWithHistoryEDFilter(), edm::FilterWrapper< T >::FilterWrapper(), FSQDiJetAve::FSQDiJetAve(), GEDPhotonProducer::GEDPhotonProducer(), GlobalCosmicMuonProducer::GlobalCosmicMuonProducer(), GlobalTrackQualityProducer::GlobalTrackQualityProducer(), HighPtTrackEcalDetIdProducer::HighPtTrackEcalDetIdProducer(), HLTAnalyzer::HLTAnalyzer(), HLTBitAnalyzer::HLTBitAnalyzer(), HLTExoticaValidator::HLTExoticaValidator(), HLTHiggsValidator::HLTHiggsValidator(), HLTMuonIsoFilter::HLTMuonIsoFilter(), HLTMuonValidator::HLTMuonValidator(), HLTTauDQMOfflineSource::HLTTauDQMOfflineSource(), cms::CkfDebugTrackCandidateMaker::initDebugger(), InterestingTrackEcalDetIdProducer::InterestingTrackEcalDetIdProducer(), IsolatedTracksCone::IsolatedTracksCone(), JetCorrectorProducer< T >::JetCorrectorProducer(), JetMETHLTOfflineSource::JetMETHLTOfflineSource(), L1GlobalTrigger::L1GlobalTrigger(), L1MuGlobalMuonTrigger::L1MuGlobalMuonTrigger(), l1t::L1TDigiToRaw::L1TDigiToRaw(), L2MuonIsolationProducer::L2MuonIsolationProducer(), L3MuonCombinedRelativeIsolationProducer::L3MuonCombinedRelativeIsolationProducer(), L3MuonIsolationProducer::L3MuonIsolationProducer(), LogMessageMonitor::LogMessageMonitor(), pat::helper::ManyThingsToValueMaps< Adaptor, Collection, value_type >::ManyThingsToValueMaps(), edm::MixingModule::MixingModule(), pat::ModifiedObjectProducer< T >::ModifiedObjectProducer(), MuIsoDepositProducer::MuIsoDepositProducer(), MultiplicityCorrelator::MultiplicityCorrelator(), MultiplicityInvestigator::MultiplicityInvestigator(), MultiplicityTimeCorrelations::MultiplicityTimeCorrelations(), MultiTrackValidator::MultiTrackValidator(), MuonAssociatorEDProducer::MuonAssociatorEDProducer(), MuonCaloCleanerAllCrossed::MuonCaloCleanerAllCrossed(), MuonCaloDistanceProducer::MuonCaloDistanceProducer(), MuonDetCleaner::MuonDetCleaner(), MuonIdProducer::MuonIdProducer(), cms::MuonMETValueMapProducer::MuonMETValueMapProducer(), MuonProducer::MuonProducer(), MuonSeedGenerator::MuonSeedGenerator(), MuonSeedProducer::MuonSeedProducer(), MuonShowerInformationProducer::MuonShowerInformationProducer(), MuonTimingProducer::MuonTimingProducer(), MuonToTrackingParticleAssociatorEDProducer::MuonToTrackingParticleAssociatorEDProducer(), MuPFIsoEmbedder::MuPFIsoEmbedder(), OscarMTProducer::OscarMTProducer(), pat::PATCleaner< PATObjType >::PATCleaner(), pat::PATCompositeCandidateProducer::PATCompositeCandidateProducer(), pat::PATElectronSlimmer::PATElectronSlimmer(), pat::PATJetSlimmer::PATJetSlimmer(), pat::PATMETProducer::PATMETProducer(), pat::PATMuonSlimmer::PATMuonSlimmer(), pat::PATPhotonSlimmer::PATPhotonSlimmer(), pat::PATTauSlimmer::PATTauSlimmer(), PFCandIsolatorFromDeposits::PFCandIsolatorFromDeposits(), PFRecHitProducer::PFRecHitProducer(), PFRecoTauChargedHadronProducer::PFRecoTauChargedHadronProducer(), PFRecoTauDiscriminationByNProngs::PFRecoTauDiscriminationByNProngs(), PFTauPrimaryVertexProducer::PFTauPrimaryVertexProducer(), PhotonConversionTrajectorySeedProducerFromQuadruplets::PhotonConversionTrajectorySeedProducerFromQuadruplets(), PhotonConversionTrajectorySeedProducerFromSingleLeg::PhotonConversionTrajectorySeedProducerFromSingleLeg(), PhotonProducer::PhotonProducer(), PixelTracksProducer::PixelTracksProducer(), PlottingDevice::PlottingDevice(), RecoTauPiZeroProducer::RecoTauPiZeroProducer(), RecoTauProducer::RecoTauProducer(), ReduceHcalRecHitCollectionProducer::ReduceHcalRecHitCollectionProducer(), SeedGeneratorFromRegionHitsEDProducer::SeedGeneratorFromRegionHitsEDProducer(), SeedMultiplicityAnalyzer::SeedMultiplicityAnalyzer(), SelectReplacementCandidates::SelectReplacementCandidates(), SETMuonSeedProducer::SETMuonSeedProducer(), SingleTopTChannelLeptonDQM::SingleTopTChannelLeptonDQM(), SingleTopTChannelLeptonDQM_miniAOD::SingleTopTChannelLeptonDQM_miniAOD(), SiPixelRawToDigi::SiPixelRawToDigi(), SiStripDCSFilter::SiStripDCSFilter(), SiStripMonitorCluster::SiStripMonitorCluster(), SiStripMonitorDigi::SiStripMonitorDigi(), SiStripMonitorTrack::SiStripMonitorTrack(), SmearedJetProducerT< T >::SmearedJetProducerT(), TagProbeFitTreeProducer::TagProbeFitTreeProducer(), Tau3MuSkim::Tau3MuSkim(), TauTagValidation::TauTagValidation(), cms::TCMETProducer::TCMETProducer(), TopDiLeptonHLTOfflineDQM::TopDiLeptonHLTOfflineDQM(), TopDiLeptonOfflineDQM::TopDiLeptonOfflineDQM(), TopSingleLeptonDQM::TopSingleLeptonDQM(), TopSingleLeptonDQM_miniAOD::TopSingleLeptonDQM_miniAOD(), TopSingleLeptonHLTOfflineDQM::TopSingleLeptonHLTOfflineDQM(), TrackingMonitor::TrackingMonitor(), TrajectorySeedProducer::TrajectorySeedProducer(), TSGFromL1Muon::TSGFromL1Muon(), TSGFromL2Muon::TSGFromL2Muon(), TtDilepEvtSolutionMaker::TtDilepEvtSolutionMaker(), TtSemiEvtSolutionMaker::TtSemiEvtSolutionMaker(), Type2CorrectionProducer::Type2CorrectionProducer(), and VirtualJetProducer::VirtualJetProducer().

                                  {
  ConsumesCollector c{this};
  return c;
}

std::vector< ConsumesInfo > EDConsumerBase::consumesInfo

(

)

const

Definition at line 510 of file EDConsumerBase.cc.

References kAlwaysGets, kKind, kLabels, kLookupInfo, m_tokenInfo, m_tokenLabels, and mps_fire::result.

                                   {

  // Use this to eliminate duplicate entries related
  // to consumesMany items where only the type was specified
  // and the there are multiple matches. In these cases the
  // label, instance, and process will be empty.
  std::set<edm::TypeID> alreadySeenTypes;

  std::vector<ConsumesInfo> result;
  auto itAlways = m_tokenInfo.begin<kAlwaysGets>();
  auto itKind = m_tokenInfo.begin<kKind>();
  auto itLabels = m_tokenInfo.begin<kLabels>();
  for(auto itInfo = m_tokenInfo.begin<kLookupInfo>(),itEnd = m_tokenInfo.end<kLookupInfo>();
      itInfo != itEnd; ++itInfo,++itKind,++itLabels, ++itAlways) {

    const unsigned int labelStart = itLabels->m_startOfModuleLabel;
    const char* consumedModuleLabel = &(m_tokenLabels[labelStart]);
    const char* consumedInstance = consumedModuleLabel+itLabels->m_deltaToProductInstance;
    const char* consumedProcessName = consumedModuleLabel+itLabels->m_deltaToProcessName;

    // consumesMany case
    if(*consumedModuleLabel == '\0') {
      if(!alreadySeenTypes.insert(itInfo->m_type).second) {
        continue;
      }
    }

    // Just copy the information into the ConsumesInfo data structure
    result.emplace_back(itInfo->m_type,
                        consumedModuleLabel,
                        consumedInstance,
                        consumedProcessName,
                        itInfo->m_branchType,
                        *itKind,
                        *itAlways,
                        itInfo->m_index.skipCurrentProcess());
  }
  return result;
}

template<typename ProductType , BranchType B = InEvent>

void edm::EDConsumerBase::consumesMany ( )

inlineprotected

Definition at line 127 of file EDConsumerBase.h.

                        {
      TypeToGet tid=TypeToGet::make<ProductType>();
      consumesMany<B>(tid);
    }

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

inlineprotected

Definition at line 132 of file EDConsumerBase.h.

                                           {
      consumesMany<InEvent>(id);
    }

template<BranchType B>

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

inlineprotected

Definition at line 137 of file EDConsumerBase.h.

References recordConsumes().

                                           {
      recordConsumes(B,id,edm::InputTag{},true);
    }

ProductHolderIndexAndSkipBit EDConsumerBase::indexFrom	(	EDGetToken	iToken,
		BranchType	iBranch,
		TypeID const &	iType
	)		const

Definition at line 198 of file EDConsumerBase.cc.

References edm::EDGetToken::index(), info(), kLookupInfo, likely, m_tokenInfo, edm::ProductHolderIndexInvalid, throwBadToken(), throwBranchMismatch(), throwTypeMismatch(), and unlikely.

Referenced by edm::PrincipalGetAdapter::getByToken_().

{
  if(unlikely(iToken.index()>=m_tokenInfo.size())) {
    throwBadToken(iType,iToken);
  }
  const auto& info = m_tokenInfo.get<kLookupInfo>(iToken.index());
  if (likely(iBranch == info.m_branchType)) {
    if (likely(iType == info.m_type)) {
      return info.m_index;
    } else {
      throwTypeMismatch(iType, iToken);
    }
  } else {
    throwBranchMismatch(iBranch,iToken);
  }
  return ProductHolderIndexAndSkipBit(edm::ProductHolderIndexInvalid, false);
}

void EDConsumerBase::itemsMayGet	(	BranchType	iBranch,
		std::vector< ProductHolderIndexAndSkipBit > &	oIndices
	)		const

Definition at line 253 of file EDConsumerBase.cc.

References KineDebug3::count(), kAlwaysGets, kLookupInfo, m_tokenInfo, and edm::ProductHolderIndexInvalid.

{
  //how many are we adding?
  unsigned int count=0;
  {
    auto itAlwaysGet = m_tokenInfo.begin<kAlwaysGets>();
    for(auto it = m_tokenInfo.begin<kLookupInfo>(),
        itEnd = m_tokenInfo.end<kLookupInfo>();
        it != itEnd; ++it,++itAlwaysGet) {
      if(iBranch==it->m_branchType) {
        if (it->m_index.productHolderIndex() != ProductHolderIndexInvalid) {
          if(not *itAlwaysGet) {
            ++count;
          }
        }
      }
    }
  }
  oIndices.reserve(oIndices.size()+count);
  {
    auto itAlwaysGet = m_tokenInfo.begin<kAlwaysGets>();
    for(auto it = m_tokenInfo.begin<kLookupInfo>(),
        itEnd = m_tokenInfo.end<kLookupInfo>();
        it != itEnd; ++it,++itAlwaysGet) {
      if(iBranch==it->m_branchType) {
        if (it->m_index.productHolderIndex() != ProductHolderIndexInvalid) {
          if(not *itAlwaysGet) {
            oIndices.push_back(it->m_index);
          }
        }
      }
    }
  }
}

void EDConsumerBase::itemsToGet	(	BranchType	iBranch,
		std::vector< ProductHolderIndexAndSkipBit > &	oIndices
	)		const

Definition at line 217 of file EDConsumerBase.cc.

References KineDebug3::count(), kAlwaysGets, kLookupInfo, m_tokenInfo, and edm::ProductHolderIndexInvalid.

Referenced by updateLookup().

{
  //how many are we adding?
  unsigned int count=0;
  {
    auto itAlwaysGet = m_tokenInfo.begin<kAlwaysGets>();
    for(auto it = m_tokenInfo.begin<kLookupInfo>(),
        itEnd = m_tokenInfo.end<kLookupInfo>();
        it != itEnd; ++it,++itAlwaysGet) {
      if(iBranch==it->m_branchType) {
        if (it->m_index.productHolderIndex() != ProductHolderIndexInvalid) {
          if(*itAlwaysGet) {
            ++count;
          }
        }
      }
    }
  }
  oIndices.reserve(oIndices.size()+count);
  {
    auto itAlwaysGet = m_tokenInfo.begin<kAlwaysGets>();
    for(auto it = m_tokenInfo.begin<kLookupInfo>(),
        itEnd = m_tokenInfo.end<kLookupInfo>();
        it != itEnd; ++it,++itAlwaysGet) {
      if(iBranch==it->m_branchType) {
        if (it->m_index.productHolderIndex() != ProductHolderIndexInvalid) {
          if(*itAlwaysGet) {
            oIndices.push_back(it->m_index);
          }
        }
      }
    }
  }
}

std::vector<ProductHolderIndexAndSkipBit> const& edm::EDConsumerBase::itemsToGetFromEvent ( ) const

inline

Definition at line 62 of file EDConsumerBase.h.

References itemsToGetFromEvent_.

{ return itemsToGetFromEvent_; }

void EDConsumerBase::labelsForToken	(	EDGetToken	iToken,
		Labels &	oLabels
	)		const

Definition at line 289 of file EDConsumerBase.cc.

References edm::EDGetToken::index(), cmsHarvester::index, kLabels, HLT_FULL_cff::labels, m_tokenInfo, m_tokenLabels, edm::ProductLabels::module, edm::ProductLabels::process, edm::ProductLabels::productInstance, and dqm_diff::start.

Referenced by EgammaBasicClusters::analyze(), AlCaElectronsTest::analyze(), EnergyScaleAnalyzer::analyze(), HLTScalers::analyze(), EgammaObjects::analyzeElectrons(), EgammaObjects::analyzePhotons(), ElectronTagProbeAnalyzer::bookHistograms(), TkAlCaRecoMonitor::bookHistograms(), ElectronAnalyzer::bookHistograms(), HLTVertexPerformanceAnalyzer::dqmBeginRun(), HLTBTagPerformanceAnalyzer::dqmBeginRun(), TriggerBxMonitor::dqmBeginRun(), TriggerRatesMonitor::dqmBeginRun(), edm::PrincipalGetAdapter::labelsForToken(), edm::PrincipalGetAdapter::makeFailToGetException(), MuonSimHitsValidAnalyzer::MuonSimHitsValidAnalyzer(), ReducedESRecHitCollectionProducer::produce(), GenTrackMatcher::produce(), ReducedRecHitCollectionProducer::produce(), SeedClusterRemover::produce(), EcalTrigPrimProducer::produce(), HITrackClusterRemover::produce(), cms::CosmicTrackFinder::produce(), and edm::PrincipalGetAdapter::throwAmbiguousException().

{
  unsigned int index = iToken.index();
  auto labels = m_tokenInfo.get<kLabels>(index);
  unsigned int start = labels.m_startOfModuleLabel;
  oLabels.module = &(m_tokenLabels[start]);
  oLabels.productInstance = oLabels.module+labels.m_deltaToProductInstance;
  oLabels.process = oLabels.module+labels.m_deltaToProcessName;
}

template<typename ProductType , BranchType B = InEvent>

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

inlineprotected

Definition at line 112 of file EDConsumerBase.h.

References checkIfEmpty(), and recordConsumes().

Referenced by pat::PATJetUpdater::PATJetUpdater(), and cms::PFMETProducer::PFMETProducer().

                                                                {
      TypeToGet tid=TypeToGet::make<ProductType>();
      return EDGetTokenT<ProductType>{recordConsumes(B, tid, checkIfEmpty(tag), false)};
    }

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

inlineprotected

Definition at line 117 of file EDConsumerBase.h.

References GlobalPosition_Frontier_DevDB_cff::tag.

                                                                       {
      return mayConsume<InEvent>(id,tag);
    }

template<BranchType B>

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

inlineprotected

Definition at line 122 of file EDConsumerBase.h.

References checkIfEmpty(), and recordConsumes().

                                                                       {
      return EDGetToken{recordConsumes(B,id,checkIfEmpty(tag),false)};
    }

void EDConsumerBase::modulesDependentUpon	(	std::string const &	iProcessName,
		std::string const &	iModuleLabel,
		bool	iPrint,
		std::vector< char const * > &	oModuleLabels
	)		const

Definition at line 383 of file EDConsumerBase.cc.

References cmsHarvester::index, info(), kLabels, kLookupInfo, HLT_FULL_cff::labels, m_tokenInfo, m_tokenLabels, or, FSQHLTOfflineSource_cfi::processName, and dqm_diff::start.

                                                                                  {
  std::set<char const*, CharStarComp> uniqueModules;
  for(unsigned int index = 0, iEnd = m_tokenInfo.size(); index < iEnd; ++index) {
    auto const& info = m_tokenInfo.get<kLookupInfo>(index);
    if(not info.m_index.skipCurrentProcess()) {
      auto const& labels = m_tokenInfo.get<kLabels>(index);
      unsigned int const start = labels.m_startOfModuleLabel;
      char const* processName = &(m_tokenLabels[start+labels.m_deltaToProcessName]);
      if(iPrint) {
        LogAbsolute("ModuleDependency") << "ModuleDependency '" << iModuleLabel <<
        "' may consume product of type '" << info.m_type.className() << 
        "' with input tag '" << &(m_tokenLabels[start]) <<
        ':' << &(m_tokenLabels[start+labels.m_deltaToProductInstance]) <<
        ':' << processName << "'";;
      }
      if((not processName) or processName[0]==0 or iProcessName == processName) {
        uniqueModules.insert(&(m_tokenLabels[start]));
      }
    }
  }
  
  oModuleLabels = std::vector<const char*>(uniqueModules.begin(),uniqueModules.end());
}

void EDConsumerBase::modulesWhoseProductsAreConsumed	(	std::vector< ModuleDescription const * > &	modules,
		ProductRegistry const &	preg,
		std::map< std::string, ModuleDescription const * > const &	labelsToDesc,
		std::string const &	processName
	)		const

Definition at line 454 of file EDConsumerBase.cc.

References edm::ProductHolderIndexHelper::index(), edm::InEvent, j, kKind, kLabels, kLookupInfo, m_tokenInfo, m_tokenLabels, matches, edmConvertToStreamModule::modules, edm::preg, edm::ProductHolderIndexInvalid, edm::ProductRegistry::productLookup(), and edm::ProductHolderIndexHelper::relatedIndexes().

                                                                                    {

  ProductHolderIndexHelper const& iHelper = *preg.productLookup(InEvent);

  std::set<std::string> alreadyFound;

  auto itKind = m_tokenInfo.begin<kKind>();
  auto itLabels = m_tokenInfo.begin<kLabels>();
  for(auto itInfo = m_tokenInfo.begin<kLookupInfo>(),itEnd = m_tokenInfo.end<kLookupInfo>();
      itInfo != itEnd; ++itInfo,++itKind,++itLabels) {

    if(itInfo->m_branchType == InEvent) {

      const unsigned int labelStart = itLabels->m_startOfModuleLabel;
      const char* consumedModuleLabel = &(m_tokenLabels[labelStart]);
      const char* consumedProcessName = consumedModuleLabel+itLabels->m_deltaToProcessName;

      if(*consumedModuleLabel != '\0') { // not a consumesMany
        if(*consumedProcessName != '\0') { // process name is specified in consumes call
          if (processName == consumedProcessName &&
              iHelper.index(*itKind,
                            itInfo->m_type,
                            consumedModuleLabel,
                            consumedModuleLabel+itLabels->m_deltaToProductInstance,
                            consumedModuleLabel+itLabels->m_deltaToProcessName) != ProductHolderIndexInvalid) {
            insertFoundModuleLabel(consumedModuleLabel, modules, alreadyFound, labelsToDesc, preg);
          }
        } else { // process name was empty
          auto matches = iHelper.relatedIndexes(*itKind,
                                                itInfo->m_type,
                                                consumedModuleLabel,
                                                consumedModuleLabel+itLabels->m_deltaToProductInstance);
          for(unsigned int j = 0; j < matches.numberOfMatches(); ++j) {
            if(processName == matches.processName(j)) {
              insertFoundModuleLabel(consumedModuleLabel, modules, alreadyFound, labelsToDesc, preg);
            }
          }
        }
      // consumesMany case
      } else if(itInfo->m_index.productHolderIndex() == ProductHolderIndexInvalid) {
        auto matches = iHelper.relatedIndexes(*itKind,
                                              itInfo->m_type);
        for(unsigned int j = 0; j < matches.numberOfMatches(); ++j) {
          if(processName == matches.processName(j)) {
            insertFoundModuleLabel(matches.moduleLabel(j), modules, alreadyFound, labelsToDesc, preg);
          }
        }
      }
    }
  }
}

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

privatedelete

unsigned int EDConsumerBase::recordConsumes ( BranchType  iBranch, TypeToGet const &  iType, edm::InputTag const &  iTag, bool  iAlwaysGets  )

private

Definition at line 88 of file EDConsumerBase.cc.

References frozen_, cmsHarvester::index, edm::InputTag::instance(), edm::TypeToGet::kind(), edm::InputTag::label(), visualization-live-secondInstance_cfg::m, m_tokenInfo, m_tokenLabels, edm::InputTag::process(), edm::ProductHolderIndexInvalid, AlCaHLTBitMon_QueryRunRegistry::string, throwConsumesCallAfterFrozen(), edm::TypeToGet::type(), and edm::InputTag::willSkipCurrentProcess().

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

                                                                                                                    {

  if(frozen_) {
    throwConsumesCallAfterFrozen(iType, iTag);
  }

  unsigned int index =m_tokenInfo.size();

  bool skipCurrentProcess = iTag.willSkipCurrentProcess();

  const size_t labelSize = iTag.label().size();
  const size_t productInstanceSize = iTag.instance().size();
  unsigned int labelStart = m_tokenLabels.size();
  unsigned short delta1 = labelSize+1;
  unsigned short delta2 = labelSize+2+productInstanceSize;
  m_tokenInfo.emplace_back(TokenLookupInfo{iType.type(), ProductHolderIndexInvalid, skipCurrentProcess, iBranch},
                           iAlwaysGets,
                           LabelPlacement{labelStart,delta1,delta2},
                           iType.kind());

  const size_t additionalSize =
      skipCurrentProcess ?
      labelSize+productInstanceSize+3 :
      labelSize+productInstanceSize+iTag.process().size()+3;

  m_tokenLabels.reserve(m_tokenLabels.size()+additionalSize);
  {
    const std::string& m =iTag.label();
    m_tokenLabels.insert(m_tokenLabels.end(),m.begin(),m.end());
    m_tokenLabels.push_back('\0');
  }
  {
    const std::string& m =iTag.instance();
    m_tokenLabels.insert(m_tokenLabels.end(),m.begin(),m.end());
    m_tokenLabels.push_back('\0');
  }
  {
    if (!skipCurrentProcess) {
      const std::string& m =iTag.process();
      m_tokenLabels.insert(m_tokenLabels.end(),m.begin(),m.end());
      m_tokenLabels.push_back('\0');
    } else {
      m_tokenLabels.push_back('\0');
    }
  }
  return index;
}

bool EDConsumerBase::registeredToConsume	(	ProductHolderIndex	iIndex,
		bool	skipCurrentProcess,
		BranchType	iBranch
	)		const

Returns

true if the product corresponding to the index was registered via consumes or mayConsume call

Definition at line 300 of file EDConsumerBase.cc.

References kLookupInfo, m_tokenInfo, and edm::PRODUCT_TYPE.

Referenced by edm::Principal::findProductByLabel().

{
  for(auto it = m_tokenInfo.begin<kLookupInfo>(),
      itEnd = m_tokenInfo.end<kLookupInfo>();
      it != itEnd; ++it) {
    if(it->m_index.productHolderIndex() == iIndex and
       it->m_index.skipCurrentProcess() == skipCurrentProcess and
       it->m_branchType == iBranch) {
      return true;
    }
  }
  //TEMPORARY: Remember so we do not have to do this again
  //non thread-safe
  EDConsumerBase* nonConstThis = const_cast<EDConsumerBase*>(this);
  nonConstThis->m_tokenInfo.emplace_back(TokenLookupInfo{TypeID{}, iIndex, skipCurrentProcess, iBranch},
                                         true,
                                         LabelPlacement{0,0,0},
                                         PRODUCT_TYPE);

  return false;
}

bool EDConsumerBase::registeredToConsumeMany	(	TypeID const &	iType,
		BranchType	iBranch
	)		const

Returns

true of TypeID corresponds to a type specified in a consumesMany call

Definition at line 323 of file EDConsumerBase.cc.

References kLookupInfo, m_tokenInfo, edm::PRODUCT_TYPE, and edm::ProductHolderIndexInvalid.

Referenced by edm::Principal::getManyByType().

{
  for(auto it = m_tokenInfo.begin<kLookupInfo>(),
      itEnd = m_tokenInfo.end<kLookupInfo>();
      it != itEnd; ++it) {
    //consumesMany entries do not have their index resolved
    if(it->m_index.productHolderIndex() == ProductHolderIndexInvalid and
       it->m_type == iType and
       it->m_branchType == iBranch) {
      return true;
    }
  }
  //TEMPORARY: Remember so we do not have to do this again
  //non thread-safe
  EDConsumerBase* nonConstThis = const_cast<EDConsumerBase*>(this);
  nonConstThis->m_tokenInfo.emplace_back(TokenLookupInfo{iType,ProductHolderIndexInvalid, false, iBranch},
                           true,
                           LabelPlacement{0,0,0},
                           PRODUCT_TYPE);
  return false;
  
}

void EDConsumerBase::throwBadToken ( edm::TypeID const &  iType, EDGetToken  iToken  ) const

private

Definition at line 358 of file EDConsumerBase.cc.

References edm::TypeID::className(), Exception, edm::EDGetToken::index(), and edm::EDGetToken::isUninitialized().

Referenced by indexFrom().

{
  if(iToken.isUninitialized()) {
    throw cms::Exception("BadToken")<<"A get using a EDGetToken with the C++ type '"<<iType.className()<<"' was made using an uninitialized token.\n Please check that the variable is being initialized from a 'consumes' call.";
  }
  throw cms::Exception("BadToken")<<"A get using a EDGetToken with the C++ type '"<<iType.className()<<"' was made using a token with a value "<<iToken.index()<<" which is beyond the range used by this module.\n Please check that the variable is being initialized from a 'consumes' call from this module.\n You can not share EDGetToken values between modules.";
}

void EDConsumerBase::throwBranchMismatch ( BranchType  iBranch, EDGetToken  iToken  ) const

private

Definition at line 353 of file EDConsumerBase.cc.

References edm::BranchTypeToString(), Exception, edm::EDGetToken::index(), kLookupInfo, and m_tokenInfo.

Referenced by indexFrom().

                                                                               {
  throw cms::Exception("BranchTypeMismatch")<<"A get using a EDGetToken was done in "<<BranchTypeToString(iBranch)<<" but the consumes call was for "<<BranchTypeToString(m_tokenInfo.get<kLookupInfo>(iToken.index()).m_branchType)<<".\n Please modify the consumes call to use the correct branch type.";
}

void EDConsumerBase::throwConsumesCallAfterFrozen ( TypeToGet const &  typeToGet, InputTag const &  inputTag  ) const

private

Definition at line 367 of file EDConsumerBase.cc.

References Exception, and edm::TypeToGet::type().

Referenced by recordConsumes().

                                                                                                       {
  throw cms::Exception("LogicError") << "A module declared it consumes a product after its constructor.\n"
                                     << "This must be done in the contructor\n"
                                     << "The product type was: " << typeToGet.type() << "\n"
                                     << "and " << inputTag << "\n";
}

void EDConsumerBase::throwTypeMismatch ( edm::TypeID const &  iType, EDGetToken  iToken  ) const

private

Definition at line 348 of file EDConsumerBase.cc.

References edm::TypeID::className(), Exception, edm::EDGetToken::index(), kLookupInfo, and m_tokenInfo.

Referenced by indexFrom().

{
  throw cms::Exception("TypeMismatch")<<"A get using a EDGetToken used the C++ type '"<<iType.className()<<"' but the consumes call was for type '"<<m_tokenInfo.get<kLookupInfo>(iToken.index()).m_type.className()<<"'.\n Please modify either the consumes or get call so the types match.";
}

void EDConsumerBase::updateLookup	(	BranchType	iBranchType,
		ProductHolderIndexHelper const &	iHelper
	)

Definition at line 137 of file EDConsumerBase.cc.

References frozen_, i, edm::ProductHolderIndexHelper::index(), cmsHarvester::index, edm::InEvent, info(), itemsToGet(), itemsToGetFromEvent_, j, kAlwaysGets, class-composition::kind, kKind, kLabels, kLookupInfo, HLT_FULL_cff::labels, m_tokenInfo, m_tokenLabels, matches, edm::ProductHolderIndexInvalid, and edm::ProductHolderIndexHelper::relatedIndexes().

{
  frozen_ = true;
  {
    auto itKind = m_tokenInfo.begin<kKind>();
    auto itLabels = m_tokenInfo.begin<kLabels>();
    for(auto itInfo = m_tokenInfo.begin<kLookupInfo>(),itEnd = m_tokenInfo.end<kLookupInfo>();
        itInfo != itEnd; ++itInfo,++itKind,++itLabels) {
      if(itInfo->m_branchType == iBranchType) {
        const unsigned int labelStart = itLabels->m_startOfModuleLabel;
        const char* moduleLabel = &(m_tokenLabels[labelStart]);
        itInfo->m_index = ProductHolderIndexAndSkipBit(iHelper.index(*itKind,
                                                                     itInfo->m_type,
                                                                     moduleLabel,
                                                                     moduleLabel+itLabels->m_deltaToProductInstance,
                                                                     moduleLabel+itLabels->m_deltaToProcessName),
                                                       itInfo->m_index.skipCurrentProcess());
      }
    }
  }

  //now add resolved requests to get many to the end of our list
  // a get many will have an empty module label
  for(size_t i=0, iEnd = m_tokenInfo.size(); i!=iEnd;++i) {
    //need to copy since pointer could be invalidated by emplace_back
    auto const info = m_tokenInfo.get<kLookupInfo>(i);
    if(info.m_branchType == iBranchType &&
       info.m_index.productHolderIndex() == ProductHolderIndexInvalid &&
       m_tokenLabels[m_tokenInfo.get<kLabels>(i).m_startOfModuleLabel]=='\0') {
      //find all matching types
      const auto kind=m_tokenInfo.get<kKind>(i);
      auto matches = iHelper.relatedIndexes(kind,info.m_type);

      //NOTE: This could be changed to contain the true labels for what is being
      // requested but for now I want to remember these are part of a get many
      const LabelPlacement labels= m_tokenInfo.get<kLabels>(i);
      bool alwaysGet = m_tokenInfo.get<kAlwaysGets>(i);
      for(unsigned int j=0;j!=matches.numberOfMatches();++j) {
        //only keep the ones that are for a specific data item and not a collection
        if(matches.isFullyResolved(j)) {
          auto index =matches.index(j);
          m_tokenInfo.emplace_back(TokenLookupInfo{info.m_type, index, info.m_index.skipCurrentProcess(), info.m_branchType},
                                   alwaysGet,
                                   labels,
                                   kind);
        }
      }
    }
  }
  m_tokenInfo.shrink_to_fit();

  if(iBranchType == InEvent) {
    itemsToGet(iBranchType, itemsToGetFromEvent_);
  }
}

Friends And Related Function Documentation

friend class ConsumesCollector

friend

Definition at line 91 of file EDConsumerBase.h.

template<typename T >

friend class WillGetIfMatch

friend

Definition at line 92 of file EDConsumerBase.h.

Member Data Documentation

bool edm::EDConsumerBase::frozen_

private

Definition at line 189 of file EDConsumerBase.h.

Referenced by recordConsumes(), and updateLookup().

std::vector<ProductHolderIndexAndSkipBit> edm::EDConsumerBase::itemsToGetFromEvent_

private

Definition at line 187 of file EDConsumerBase.h.

Referenced by itemsToGetFromEvent(), and updateLookup().

edm::SoATuple<TokenLookupInfo,bool,LabelPlacement,edm::KindOfType> edm::EDConsumerBase::m_tokenInfo

private

Definition at line 181 of file EDConsumerBase.h.

Referenced by consumesInfo(), indexFrom(), itemsMayGet(), itemsToGet(), labelsForToken(), modulesDependentUpon(), modulesWhoseProductsAreConsumed(), recordConsumes(), registeredToConsume(), registeredToConsumeMany(), throwBranchMismatch(), throwTypeMismatch(), and updateLookup().

std::vector<char> edm::EDConsumerBase::m_tokenLabels

private

Definition at line 185 of file EDConsumerBase.h.

Referenced by consumesInfo(), labelsForToken(), modulesDependentUpon(), modulesWhoseProductsAreConsumed(), recordConsumes(), and updateLookup().