edm::Ptr< T > Class Template Reference

#include <DataFormats/Common/interface/Ptr.h>

Public Types
typedef unsigned long	key_type
typedef T	value_type

Public Member Functions
T const *	get () const
	Returns C++ pointer to the item. More...
bool	hasProductCache () const
ProductID	id () const
	Accessor for product ID. More...
bool	isAvailable () const
bool	isNonnull () const
	Checks for non-null. More...
bool	isNull () const
	Checks for null. More...
bool	isTransient () const
	Checks if this Ptr is transient (i.e. not persistable). More...
key_type	key () const
bool	operator! () const
	Checks for null. More...
T const &	operator* () const
	Dereference operator. More...
T const *	operator-> () const
	Member dereference operator. More...
void const *	product () const
EDProductGetter const *	productGetter () const
	Accessor for product getter. More...
template<typename C >
	Ptr (Handle< C > const &handle, key_type itemKey, bool=true)
template<typename C >
	Ptr (OrphanHandle< C > const &handle, key_type itemKey, bool=true)
template<typename C >
	Ptr (C const *iProduct, key_type iItemKey, bool=true)
	Ptr (T const *item, key_type iItemKey)
template<typename C >
	Ptr (TestHandle< C > const &handle, key_type itemKey, bool=true)
	Ptr (ProductID const &productID, key_type itemKey, EDProductGetter const *prodGetter)
	Ptr (ProductID const &productID, T const *item, key_type item_key)
	Ptr (ProductID const &productID, T const *item, key_type item_key, bool transient)
	Ptr (ProductID const &iId)
	Ptr ()
template<typename U >
	Ptr (Ptr< U > const &iOther, std::enable_if_t< std::is_base_of< T, U >::value > *=nullptr)
template<typename U >
	Ptr (Ptr< U > const &iOther, std::enable_if_t< std::is_base_of< U, T >::value > *=nullptr)
RefCore const &	refCore () const
	~Ptr ()
	Destructor. More...

Static Public Member Functions
static short	Class_Version ()

Private Member Functions
void	getData_ (bool throwIfNotFound=true) const
template<typename C >
T const *	getItem_ (C const *product, key_type iKey)

Private Attributes
RefCore	core_
key_type	key_

Friends
class	PtrVectorBase

Detailed Description

template<typename T>
class edm::Ptr< T >

Description: Persistent 'pointer' to an item in a collection where the collection is in the edm::Event

Usage: <usage>

Definition at line 31 of file AssociationVector.h.

Member Typedef Documentation

key_type

template<typename T>

typedef unsigned long edm::Ptr< T >::key_type

Definition at line 44 of file Ptr.h.

value_type

template<typename T>

typedef T edm::Ptr< T >::value_type

Definition at line 45 of file Ptr.h.

Constructor & Destructor Documentation

Ptr() [1/12]

template<typename T>

template<typename C >

edm::Ptr< T >::Ptr ( Handle< C > const &  handle, key_type  itemKey, bool  = true  )

inline

Definition at line 49 of file Ptr.h.

        : core_(handle.id(), getItem_(handle.product(), itemKey), nullptr, false), key_(itemKey) {}

Ptr() [2/12]

template<typename T>

template<typename C >

edm::Ptr< T >::Ptr ( OrphanHandle< C > const &  handle, key_type  itemKey, bool  = true  )

inline

Definition at line 54 of file Ptr.h.

        : core_(handle.id(), getItem_(handle.product(), itemKey), nullptr, false), key_(itemKey) {}

Ptr() [3/12]

template<typename T>

template<typename C >

edm::Ptr< T >::Ptr ( C const *  iProduct, key_type  iItemKey, bool  = true  )

inline

Definition at line 70 of file Ptr.h.

        : core_(ProductID(), iProduct != nullptr ? getItem_(iProduct, iItemKey) : nullptr, nullptr, true),
          key_(iProduct != nullptr ? iItemKey : key_traits<key_type>::value) {}

Ptr() [4/12]

template<typename T>

edm::Ptr< T >::Ptr ( T const *  item, key_type  iItemKey  )

inline

Definition at line 74 of file Ptr.h.

        : core_(ProductID(), item, nullptr, true), key_(item != nullptr ? iItemKey : key_traits<key_type>::value) {}

Ptr() [5/12]

template<typename T>

template<typename C >

edm::Ptr< T >::Ptr ( TestHandle< C > const &  handle, key_type  itemKey, bool  = true  )

inline

Definition at line 81 of file Ptr.h.

        : core_(handle.id(), getItem_(handle.product(), itemKey), nullptr, true), key_(itemKey) {}

Ptr() [6/12]

template<typename T>

edm::Ptr< T >::Ptr ( ProductID const &  productID, key_type  itemKey, EDProductGetter const *  prodGetter  )

inline

Constructor for those users who do not have a product handle, but have a pointer to a product getter (such as the EventPrincipal). prodGetter will ususally be a pointer to the event principal.

Definition at line 87 of file Ptr.h.

        : core_(productID, nullptr, mustBeNonZero(prodGetter, "Ptr", productID), false), key_(itemKey) {}

Ptr() [7/12]

template<typename T>

edm::Ptr< T >::Ptr ( ProductID const &  productID, T const *  item, key_type  item_key  )

inline

Constructor for use in the various X::fillView(...) functions or for extracting a persistent Ptr from a PtrVector. It is an error (not diagnosable at compile- or run-time) to call this constructor with a pointer to a T unless the pointed-to T object is already in a collection of type C stored in the Event. The given ProductID must be the id of the collection in the Event.

Definition at line 97 of file Ptr.h.

        : core_(productID, item, nullptr, false), key_(item_key) {}

Ptr() [8/12]

template<typename T>

edm::Ptr< T >::Ptr ( ProductID const &  productID, T const *  item, key_type  item_key, bool  transient  )

inline

Definition at line 100 of file Ptr.h.

        : core_(productID, item, nullptr, transient), key_(item_key) {}

Ptr() [9/12]

template<typename T>

edm::Ptr< T >::Ptr ( ProductID const &  iId )

inlineexplicit

Constructor that creates an invalid ("null") Ptr that is associated with a given product (denoted by that product's ProductID).

Definition at line 107 of file Ptr.h.

: core_(iId, nullptr, nullptr, false), key_(key_traits<key_type>::value) {}

Ptr() [10/12]

template<typename T>

edm::Ptr< T >::Ptr ( )

inline

Definition at line 109 of file Ptr.h.

: core_(), key_(key_traits<key_type>::value) {}

Ptr() [11/12]

template<typename T>

template<typename U >

edm::Ptr< T >::Ptr ( Ptr< U > const &  iOther, std::enable_if_t< std::is_base_of< T, U >::value > *  = nullptr  )

inline

Definition at line 112 of file Ptr.h.

        : core_(iOther.id(),
                (iOther.hasProductCache() ? static_cast<T const*>(iOther.get()) : static_cast<T const*>(nullptr)),
                iOther.productGetter(),
                iOther.isTransient()),
          key_(iOther.key()) {
      //make sure a race condition didn't happen where between the call to hasProductCache() and
      // productGetter() the object was gotten
      if (iOther.hasProductCache() and not hasProductCache()) {
        core_.setProductPtr(static_cast<T const*>(iOther.get()));
      }
    }

Ptr() [12/12]

template<typename T>

template<typename U >

edm::Ptr< T >::Ptr ( Ptr< U > const &  iOther, std::enable_if_t< std::is_base_of< U, T >::value > *  = nullptr  )

inlineexplicit

Definition at line 126 of file Ptr.h.

        : core_(iOther.id(), dynamic_cast<T const*>(iOther.get()), nullptr, iOther.isTransient()), key_(iOther.key()) {}

~Ptr()

template<typename T>

edm::Ptr< T >::~Ptr ( )

inline

Destructor.

Definition at line 130 of file Ptr.h.

{}

Member Function Documentation

Class_Version()

template<typename T>

static short edm::Ptr< T >::Class_Version ( )

inlinestatic

Definition at line 175 of file Ptr.h.

:
    template <typename C>

get()

template<typename T>

T const* edm::Ptr< T >::get ( ) const

inline

Returns C++ pointer to the item.

Definition at line 139 of file Ptr.h.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), TransientTrackBuilder::build(), PFEGammaAlgo::buildRefinedSuperCluster(), util.rrapi.RRApi::columns(), rrapi.RRApi::columns(), PileupJetIdAlgo::computeIdVariables(), util.rrapi.RRApi::count(), rrapi.RRApi::count(), util.rrapi.RRApi::data(), rrapi.RRApi::data(), TauDiscriminationAgainstElectronMVA6< TauType, TauDiscriminator, ElectronType >::discriminate(), l1tVertexFinder::TP::fillUse(), l1tVertexFinder::TP::fillUseForEff(), l1tVertexFinder::TP::fillUseForVertexReco(), PFECALSuperClusterAlgo::finalizeSuperCluster(), edm::FwdPtr< T >::get(), pat::EventHypothesis::getAs(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), AntiElectronIDMVA6< TauType, ElectronType >::getTauVarsTypeSpecific(), TTClusterAssociationMap< T >::isCombinatoric(), TTClusterAssociationMap< T >::isGenuine(), MuonPFIsolationWithConeVeto::isInIsolationCone(), ElectronPFIsolationWithConeVeto::isInIsolationCone(), PhotonPFIsolationWithConeVeto::isInIsolationCone(), PhotonPFIsolationWithMapBasedVeto::isInIsolationCone(), ElectronPFIsolationWithMapBasedVeto::isInIsolationCone(), TTClusterAssociationMap< T >::isUnknown(), reco::tau::lead_track_chi2(), pat::MET::MET(), AntiElectronDeadECAL::operator()(), reco::PFClusterJet::pfCluster(), reco::RecoTauPiZero::print(), EcalDigiSelector::produce(), pat::PATTauProducer::produce(), SoftPFMuonTagInfoProducer::produce(), util.rrapi.RRApi::report(), rrapi.RRApi::report(), rrapi.RRApi::reports(), util.rrapi.RRApi::reports(), BoostedDoubleSVProducer::setTracksPV(), rrapi.RRApi::tables(), util.rrapi.RRApi::tables(), rrapi.RRApi::tags(), util.rrapi.RRApi::tags(), util.rrapi.RRApi::templates(), rrapi.RRApi::templates(), toTrackRef(), reco::TrackJet::track(), GsfEleCalPFClusterIsoCut::value(), rrapi.RRApi::workspaces(), and util.rrapi.RRApi::workspaces().

{ return isNull() ? nullptr : this->operator->(); }

getData_()

template<typename T>

void edm::Ptr< T >::getData_ ( bool  throwIfNotFound = true ) const

inlineprivate

Definition at line 181 of file Ptr.h.

                                                     {
      EDProductGetter const* getter = productGetter();
      if (getter != nullptr) {
        WrapperBase const* prod = getter->getIt(core_.id());
        unsigned int iKey = key_;
        if (prod == nullptr) {
          auto optionalProd = getter->getThinnedProduct(core_.id(), key_);
          if (not optionalProd.has_value()) {
            if (throwIfNotFound) {
              core_.productNotFoundException(typeid(T));
            } else {
              return;
            }
          }
          std::tie(prod, iKey) = *optionalProd;
        }
        void const* ad = nullptr;
        prod->setPtr(typeid(T), iKey, ad);
        core_.setProductPtr(ad);
      }
    }

getItem_()

template<typename T >

template<typename C >

T const * edm::Ptr< T >::getItem_ ( C const *  product, key_type  iKey  )

private

Definition at line 209 of file Ptr.h.

                                                            {
    assert(iProduct != nullptr);
    typename C::const_iterator it = iProduct->begin();
    std::advance(it, iKey);
    T const* address = detail::GetProduct<C>::address(it);
    return address;
  }

hasProductCache()

template<typename T>

bool edm::Ptr< T >::hasProductCache ( ) const

inline

Definition at line 167 of file Ptr.h.

Referenced by edm::FwdPtr< T >::hasProductCache(), edm::Ptr< CaloRecHit >::Ptr(), and edm::PtrVector< reco::CaloCluster >::push_back().

{ return nullptr != core_.productPtr(); }

id()

template<typename T>

ProductID edm::Ptr< T >::id ( ) const

inline

Accessor for product ID.

Definition at line 160 of file Ptr.h.

Referenced by MuonTrajectoryCleaner::clean(), pat::PATElectronProducer::fillElectron2(), edm::PtrVector< reco::CaloCluster >::fillView(), pat::helper::getPtrForProd(), edm::FwdPtr< T >::id(), ClusterClusterMapping::overlap(), reco::PFRecoTauChargedHadron::print(), ShiftedParticleMETcorrInputProducer::produce(), ShiftedParticleProducer::produce(), edmtest::OtherThingAlgorithm::run(), ConvertedPhotonProducer::solveAmbiguity(), and metsig::SignPFSpecificAlgo::useOriginalPtrs().

{ return core_.id(); }

isAvailable()

template<typename T >

bool edm::Ptr< T >::isAvailable ( ) const

inline

Checks if collection is in memory or available in the event. No type checking is done. This function is potentially costly as it might cause a disk read (note that it does not cause the data to be cached locally)

Definition at line 232 of file Ptr.h.

Referenced by B2GDQM::analyzeAllHad(), B2GDQM::analyzeSemiE(), B2GDQM::analyzeSemiMu(), MVAJetPuId::computeIdVariables(), edm::FwdPtr< T >::get(), edm::FwdPtr< T >::isAvailable(), reco::PFCandidateFwdPtrFactory::operator()(), TopProjectorFwdPtrOverlap< Top, Bottom >::operator()(), edm::FwdPtr< T >::operator*(), edm::FwdPtr< T >::operator->(), reco::PFClusterJet::pfCluster(), JetFlavourClustering::produce(), and reco::TrackJet::track().

                                        {
    getData_(false);
    return hasProductCache();
  }

isNonnull()

template<typename T>

bool edm::Ptr< T >::isNonnull ( ) const

inline

Checks for non-null.

Definition at line 146 of file Ptr.h.

Referenced by reco::tau::RecoTauConstructor::addTauChargedHadron(), ZCountingElectrons::analyze(), B2GDoubleLeptonHLTValidation::analyze(), B2GHadronicHLTValidation::analyze(), B2GSingleLeptonHLTValidation::analyze(), reco::FlavorHistoryEvent::cache(), BoostedDoubleSVProducer::calcNsubjettiness(), ConversionProducer::checkTrackPair(), MVAJetPuId::computeIdVariables(), reco::tau::RecoTauConstructor::convertToPtr(), EGEnergyCorrector::CorrectedEnergyWithError(), PFRecoTauDiscriminationByNProngs::discriminate(), TauDiscriminationAgainstElectronMVA6< TauType, TauDiscriminator, ElectronType >::discriminate(), PFRecoTauDiscriminationAgainstMuon2Helper::eval(), PATTauHybridProducer::fillTauFromJet(), AntiElectronIDMVA6< TauType, ElectronType >::getTauVarsTypeSpecific(), reco::FlavorHistory::hasMatchedJet(), reco::PFTau::hasMuonReference(), reco::FlavorHistory::hasParton(), reco::FlavorHistory::hasProgenitor(), reco::FlavorHistory::hasSister(), reco::FlavorHistory::hasSisterJet(), edm::FwdPtr< T >::id(), MuonPFIsolationWithConeVeto::isInIsolationCone(), ElectronPFIsolationWithConeVeto::isInIsolationCone(), PhotonPFIsolationWithConeVeto::isInIsolationCone(), PhotonPFIsolationWithMapBasedVeto::isInIsolationCone(), edm::FwdPtr< T >::isNonnull(), edm::Ptr< CaloRecHit >::isNull(), edm::FwdPtr< T >::key(), reco::tau::lead_track_chi2(), pat::Muon::numberOfSourceCandidatePtrs(), reco::PFCandidateFwdPtrFactory::operator()(), reco::tau::RecoTauElectronRejectionPlugin::operator()(), reco::tau::RecoTauBuilderConePlugin::operator()(), AntiElectronDeadECAL::operator()(), TopProjectorFwdPtrOverlap< Top, Bottom >::operator()(), reco::PFCandidate::overlap(), reco::PFClusterJet::pfCluster(), reco::PFRecoTauChargedHadron::print(), PFTauElecRejectionBenchmark::process(), L1THLTTauMatching::produce(), L1HLTTauMatching::produce(), PseudoTopProducer::produce(), PATMuonMerger::produce(), LowPtGsfElectronIDProducer::produce(), PFTauPrimaryVertexProducerBase::produce(), pat::PATTauProducer::produce(), pat::PATElectronProducer::produce(), JetFlavourClustering::produce(), edm::FwdPtr< T >::refCore(), reco::tau::setChargedHadronP4(), reco::tau::RecoTauBuilderConePlugin::setTauQuantities(), and reco::TrackJet::track().

{ return key_traits<key_type>::value != key_; }

isNull()

template<typename T>

bool edm::Ptr< T >::isNull ( ) const

inline

Checks for null.

Definition at line 142 of file Ptr.h.

Referenced by l1tVertexFinder::VertexNTupler::analyze(), MVAJetPuId::computeIdVariables(), PATTauHybridProducer::fillTauFromJet(), l1tVertexFinder::Stub::fillTruth(), edm::PtrVector< reco::CaloCluster >::fillView(), pat::PATSingleVertexSelector::filter_(), edm::Ptr< CaloRecHit >::get(), reco::PFTau::hasMuonReference(), TTClusterAssociationMap< T >::isCombinatoric(), TTClusterAssociationMap< T >::isGenuine(), TTClusterAssociationMap< T >::isUnknown(), EG9X105XObjectUpdateModifier::modifyObject(), edm::Ptr< CaloRecHit >::operator!(), reco::CaloRecHitCandidate::overlap(), reco::PFCandidate::overlap(), PseudoTopProducer::produce(), LowPtGsfElectronSCProducer::produce(), citk::PFIsolationSumProducerForPUPPI::produce(), L1TruthTrackFastJetProducer::produce(), TemplatedSecondaryVertexProducer< IPTI, VTX >::produce(), and metsig::SignPFSpecificAlgo::useOriginalPtrs().

{ return !isNonnull(); }

isTransient()

template<typename T>

bool edm::Ptr< T >::isTransient ( ) const

inline

Checks if this Ptr is transient (i.e. not persistable).

Definition at line 157 of file Ptr.h.

Referenced by edm::FwdPtr< T >::isTransient().

{ return core_.isTransient(); }

key()

template<typename T>

key_type edm::Ptr< T >::key ( ) const

inline

Definition at line 165 of file Ptr.h.

Referenced by PFEGammaAlgo::attachPSClusters(), reco::tau::RecoTauConstructor::convertToPtr(), edm::PtrVector< reco::CaloCluster >::fillView(), edm::FwdPtr< T >::key(), TopProjectorFwdPtrOverlap< Top, Bottom >::operator()(), reco::FlavorHistory::operator<(), reco::FlavorHistory::operator==(), reco::FlavorHistory::operator>(), ClusterClusterMapping::overlap(), reco::PFRecoTauChargedHadron::print(), TriggerMatcherToHLTDebug::produce(), edm::PtrVector< reco::CaloCluster >::push_back(), and ConvertedPhotonProducer::solveAmbiguity().

{ return key_; }

operator!()

template<typename T>

bool edm::Ptr< T >::operator! ( ) const

inline

Checks for null.

Definition at line 148 of file Ptr.h.

{ return isNull(); }

operator*()

template<typename T >

T const & edm::Ptr< T >::operator* ( ) const

inline

Dereference operator.

Definition at line 219 of file Ptr.h.

                                          {
    getData_();
    return *reinterpret_cast<T const*>(core_.productPtr());
  }

operator->()

template<typename T >

T const * edm::Ptr< T >::operator-> ( ) const

inline

Member dereference operator.

Definition at line 226 of file Ptr.h.

Referenced by edm::Ptr< CaloRecHit >::get().

                                           {
    getData_();
    return reinterpret_cast<T const*>(core_.productPtr());
  }

product()

template<typename T>

void const* edm::Ptr< T >::product ( ) const

inline

Definition at line 172 of file Ptr.h.

{ return nullptr; }

productGetter()

template<typename T>

EDProductGetter const* edm::Ptr< T >::productGetter ( ) const

inline

Accessor for product getter.

Definition at line 163 of file Ptr.h.

Referenced by edm::Ptr< CaloRecHit >::getData_(), and edm::FwdPtr< T >::productGetter().

{ return core_.productGetter(); }

refCore()

template<typename T>

RefCore const& edm::Ptr< T >::refCore ( ) const

inline

Definition at line 169 of file Ptr.h.

Referenced by TopProjectorFwdPtrOverlap< Top, Bottom >::operator()(), edm::PtrVector< reco::CaloCluster >::push_back(), and edm::FwdPtr< T >::refCore().

{ return core_; }

Friends And Related Function Documentation

PtrVectorBase

template<typename T>

friend class PtrVectorBase

friend

Definition at line 41 of file Ptr.h.

Member Data Documentation

core_

template<typename T>

RefCore edm::Ptr< T >::core_

private

Definition at line 203 of file Ptr.h.

Referenced by edm::Ptr< CaloRecHit >::getData_(), edm::Ptr< CaloRecHit >::hasProductCache(), edm::Ptr< CaloRecHit >::id(), edm::Ptr< CaloRecHit >::isTransient(), edm::Ptr< CaloRecHit >::productGetter(), edm::Ptr< CaloRecHit >::Ptr(), and edm::Ptr< CaloRecHit >::refCore().

key_

template<typename T>

key_type edm::Ptr< T >::key_

private

Definition at line 204 of file Ptr.h.

Referenced by edm::Ptr< CaloRecHit >::getData_(), edm::Ptr< CaloRecHit >::isNonnull(), and edm::Ptr< CaloRecHit >::key().