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

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 &iId)

	Ptr ()

template<typename U >
	Ptr (Ptr< U > const &iOther, typename boost::enable_if_c< boost::is_base_of< T, U >::value >::type *=0)

template<typename U >
	Ptr (Ptr< U > const &iOther, typename boost::enable_if_c< boost::is_base_of< U, T >::value >::type *=0)

RefCore const &	refCore () const

	~Ptr ()
	Destructor. More...

Private Member Functions
void	getData_ () const

template<typename C >
T const *	getItem_ (C const *product, key_type iKey)

	Ptr (T const *item, key_type item_key)

Private Attributes
RefCore	core_

key_type	key_

Friends
class	PtrVectorBase

Detailed Description

template<class 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 51 of file AssociativeIterator.h.

Member Typedef Documentation

template<class T>

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

Definition at line 43 of file Ptr.h.

template<class T>

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

Definition at line 44 of file Ptr.h.

Constructor & Destructor Documentation

template<class T>

template<typename C >

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

inline

Definition at line 48 of file Ptr.h.

48 :

49 core_(handle.id(), getItem_(handle.product(), itemKey), 0, false), key_(itemKey) {}

edm::Ptr::key_

key_type key_

Definition: Ptr.h:207

edm::Ptr::core_

RefCore core_

Definition: Ptr.h:206

edm::Ptr::getItem_

T const * getItem_(C const *product, key_type iKey)

Definition: Ptr.h:212

template<class T>

template<typename C >

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

inline

Definition at line 53 of file Ptr.h.

53 :

54 core_(handle.id(), getItem_(handle.product(), itemKey), 0, false), key_(itemKey) {}

edm::Ptr::key_

key_type key_

Definition: Ptr.h:207

patZpeak.handle

tuple handle

Definition: patZpeak.py:22

edm::Ptr::core_

RefCore core_

Definition: Ptr.h:206

edm::Ptr::getItem_

T const * getItem_(C const *product, key_type iKey)

Definition: Ptr.h:212

template<class T>

template<typename C >

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

inline

Definition at line 68 of file Ptr.h.

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

template<class T>

template<typename C >

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

inline

Definition at line 76 of file Ptr.h.

76 :

77 core_(handle.id(), getItem_(handle.product(), itemKey), 0, true), key_(itemKey) {}

edm::Ptr::key_

key_type key_

Definition: Ptr.h:207

patZpeak.handle

tuple handle

Definition: patZpeak.py:22

edm::Ptr::core_

RefCore core_

Definition: Ptr.h:206

edm::Ptr::getItem_

T const * getItem_(C const *product, key_type iKey)

Definition: Ptr.h:212

template<class 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 82 of file Ptr.h.

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

template<class 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 93 of file Ptr.h.

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

template<class 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 102 of file Ptr.h.

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

template<class T>

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

inline

Definition at line 107 of file Ptr.h.

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

template<class T>

template<typename U >

edm::Ptr< T >::Ptr	(	Ptr< U > const &	iOther,
		typename boost::enable_if_c< boost::is_base_of< T, U >::value >::type *	= `0`
	)

inline

Definition at line 113 of file Ptr.h.

                                                                                               :
     core_(iOther.id(),
           (iOther.hasProductCache() ? static_cast<T const*>(iOther.get()): static_cast<T const*>(0)),
           iOther.productGetter(),
           iOther.isTransient()),
     key_(iOther.key()) {
     }

template<class T>

template<typename U >

edm::Ptr< T >::Ptr	(	Ptr< U > const &	iOther,
		typename boost::enable_if_c< boost::is_base_of< U, T >::value >::type *	= `0`
	)

inlineexplicit

Definition at line 123 of file Ptr.h.

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

template<class T>

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

inline

Destructor.

Definition at line 132 of file Ptr.h.

132 {}

template<class T>

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

inlineprivate

Constructor for extracting a transient Ptr from a PtrVector.

Definition at line 185 of file Ptr.h.

                                           :
     core_(ProductID(), item, 0, true),
     key_(item_key) {
     }

Member Function Documentation

template<class T>

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

inline

Returns C++ pointer to the item.

Definition at line 143 of file Ptr.h.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), PFECALSuperClusterAlgo::buildSuperCluster(), pat::Jet::cacheCaloTowers(), pat::Jet::cachePFCandidates(), edm::FwdPtr< T >::get(), pat::EventHypothesis::getAs(), reco::CaloJet::getCaloConstituent(), pat::Jet::getCaloConstituent(), betterConfigParser.BetterConfigParser::getCompares(), MultipleAlgoIterator::getEt(), ReflectedIterator::getEt(), ParametrizedSubtractor::getEt(), MultipleAlgoIterator::getEta(), ReflectedIterator::getEta(), ParametrizedSubtractor::getEta(), betterConfigParser.BetterConfigParser::getGeneral(), reco::PFJet::getPFConstituent(), pat::Jet::getPFConstituent(), betterConfigParser.BetterConfigParser::getResultingSection(), PileUpSubtractor::ieta(), cms::SubEventGenJetProducer::inputTowers(), VirtualJetProducer::inputTowers(), PileUpSubtractor::iphi(), pat::MET::MET(), std::hash< edm::Ptr< reco::PFCluster > >::operator()(), reco::PFClusterJet::pfCluster(), EcalDigiSelector::produce(), pat::Tau::Tau(), and reco::TrackJet::track().

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

template<class T>

void edm::Ptr< T >::getData_ ( ) const

inlineprivate

Definition at line 194 of file Ptr.h.

                           {
       if(!hasProductCache() && 0 != productGetter()) {
         void const* ad = 0;
         WrapperHolder prod = productGetter()->getIt(core_.id());
         if(!prod.isValid()) {
           core_.productNotFoundException(typeid(T));
         }
         prod.setPtr(typeid(T), key_, ad);
         core_.setProductPtr(ad);
       }
     }

template<typename T >

template<typename C >

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

private

Definition at line 212 of file Ptr.h.

References edm::detail::GetProduct< COLLECTION >::address().

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

template<class T>

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

inline

Definition at line 171 of file Ptr.h.

Referenced by edm::Ptr< reco::Muon >::getData_(), edm::FwdPtr< T >::hasProductCache(), and edm::PtrVector< reco::reco::PFCluster >::push_back().

171 { return 0 != core_.productPtr(); }

edm::RefCore::productPtr

void const * productPtr() const

Definition: RefCore.h:32

edm::Ptr::core_

RefCore core_

Definition: Ptr.h:206

template<class T>

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

inline

Accessor for product ID.

Definition at line 164 of file Ptr.h.

Referenced by pat::PATUserDataMerger< ObjectType, Operation >::add(), pat::Jet::cacheCaloTowers(), pat::Jet::cachePFCandidates(), ConvertedPhotonProducer::cleanCollections(), pat::PATElectronProducer::fillElectron2(), reco::CaloJet::getCaloConstituent(), pat::Jet::getCaloConstituent(), reco::PFJet::getPFConstituent(), pat::Jet::getPFConstituent(), edm::FwdPtr< T >::id(), reco::operator<<(), pat::helper::RefHelper< T >::parentOrNull(), reco::Jet::print(), pat::helper::RefHelper< T >::recursiveLookup(), ConvertedPhotonProducer::solveAmbiguity(), and metsig::SignPFSpecificAlgo::useOriginalPtrs().

164 {return core_.id();}

edm::Ptr::core_

RefCore core_

Definition: Ptr.h:206

edm::RefCore::id

ProductID id() const

Definition: RefCore.h:29

template<class T>

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

inline

Checks if collection is in memory or available in the event. No type checking is done.

Definition at line 158 of file Ptr.h.

Referenced by PileupJetIdAlgo::computeIdVariables(), reco::CaloJet::getCaloConstituent(), reco::PFJet::getPFConstituent(), edm::FwdPtr< T >::isAvailable(), reco::PFCandidateFwdPtrFactory::operator()(), TopProjectorFwdPtrOverlap< Top, Bottom >::operator()(), reco::PFClusterJet::pfCluster(), and reco::TrackJet::track().

158 {return core_.isAvailable();}

edm::RefCore::isAvailable

bool isAvailable() const

Definition: RefCore.cc:112

edm::Ptr::core_

RefCore core_

Definition: Ptr.h:206

template<class T>

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

inline

Checks for non-null.

Definition at line 152 of file Ptr.h.

Referenced by reco::FlavorHistoryEvent::cache(), ConversionProducer::checkTrackPair(), PileupJetIdAlgo::computeIdVariables(), reco::tau::RecoTauConstructor::convertToRef(), EGEnergyCorrector::CorrectedEnergyWithError(), edm::FwdPtr< T >::get(), reco::CaloJet::getCaloConstituent(), reco::tau::RecoTauVertexAssociator::getLeadTrack(), reco::PFJet::getPFConstituent(), reco::FlavorHistory::hasMatchedJet(), reco::FlavorHistory::hasParton(), reco::FlavorHistory::hasProgenitor(), reco::FlavorHistory::hasSister(), reco::FlavorHistory::hasSisterJet(), edm::FwdPtr< T >::id(), pat::helper::RefHelper< T >::isAncestorOf(), edm::FwdPtr< T >::isNonnull(), edm::Ptr< reco::Muon >::isNull(), edm::FwdPtr< T >::key(), PFECALSuperClusterAlgo::loadAndSortPFClusters(), reco::PFCandidateFwdPtrFactory::operator()(), TopProjectorFwdPtrOverlap< Top, Bottom >::operator()(), edm::FwdPtr< T >::operator*(), edm::FwdPtr< T >::operator->(), reco::PFCandidate::overlap(), pat::helper::RefHelper< T >::parentOrSelf(), reco::PFClusterJet::pfCluster(), reco::Jet::print(), reco::ParticleFlowForChargedMETProducer::produce(), pat::PATJetProducer::produce(), pat::PATElectronProducer::produce(), pat::helper::RefHelper< T >::recursiveLookup(), edm::FwdPtr< T >::refCore(), and reco::TrackJet::track().

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

edm::Ptr::key_

key_type key_

Definition: Ptr.h:207

relativeConstraints.value

tuple value

Definition: relativeConstraints.py:54

template<class T>

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

inline

Checks for null.

Definition at line 148 of file Ptr.h.

Referenced by pat::helper::RefHelper< T >::ancestorOrSelf(), PileupJetIdAlgo::computeIdVariables(), pat::helper::OverlapBySuperClusterSeed::fillOverlapsForItem(), edm::PtrVector< T >::fillView(), edm::Ptr< reco::Muon >::get(), edm::Ptr< reco::Muon >::operator!(), reco::PFCandidate::overlap(), WMuNuProducer::produce(), and metsig::SignPFSpecificAlgo::useOriginalPtrs().

148 {return !isNonnull(); }

edm::Ptr::isNonnull

bool isNonnull() const

Checks for non-null.

Definition: Ptr.h:152

template<class T>

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

inline

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

Definition at line 161 of file Ptr.h.

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

161 {return core_.isTransient();}

edm::Ptr::core_

RefCore core_

Definition: Ptr.h:206

edm::RefCore::isTransient

bool isTransient() const

Definition: RefCore.h:69

template<class T>

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

inline

Definition at line 169 of file Ptr.h.

Referenced by pat::Jet::cacheCaloTowers(), pat::Jet::cachePFCandidates(), ConvertedPhotonProducer::cleanCollections(), reco::tau::RecoTauConstructor::convertToRef(), reco::CaloJet::getCaloConstituent(), pat::Jet::getCaloConstituent(), reco::PFJet::getPFConstituent(), pat::Jet::getPFConstituent(), reco::tau::isTauSignalPFCandidate(), edm::FwdPtr< T >::key(), reco::tau::RecoTauPhotonFilter::operator()(), TopProjectorFwdPtrOverlap< Top, Bottom >::operator()(), reco::FlavorHistory::operator<(), operator<<(), reco::operator<<(), reco::FlavorHistory::operator==(), reco::FlavorHistory::operator>(), reco::RecoTauPiZero::print(), reco::Jet::print(), TriggerMatcherToHLTDebug::produce(), edm::PtrVector< reco::reco::PFCluster >::push_back(), and ConvertedPhotonProducer::solveAmbiguity().

169 {return key_;}

edm::Ptr::key_

key_type key_

Definition: Ptr.h:207

template<class T>

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

inline

Checks for null.

Definition at line 154 of file Ptr.h.

154 {return isNull();}

edm::Ptr::isNull

bool isNull() const

Checks for null.

Definition: Ptr.h:148

template<typename T >

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

inline

Dereference operator.

Definition at line 224 of file Ptr.h.

References compareJSON::const.

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

template<typename T >

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

inline

Member dereference operator.

Definition at line 233 of file Ptr.h.

References compareJSON::const.

Referenced by edm::Ptr< reco::Muon >::get().

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

template<class T>

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

inline

Definition at line 176 of file Ptr.h.

176 {return 0;}

template<class T>

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

inline

Accessor for product getter.

Definition at line 167 of file Ptr.h.

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

167 {return core_.productGetter();}

edm::Ptr::core_

RefCore core_

Definition: Ptr.h:206

edm::RefCore::productGetter

EDProductGetter const * productGetter() const

Definition: RefCore.h:53

template<class T>

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

inline

Definition at line 173 of file Ptr.h.

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

173 {return core_;}

edm::Ptr::core_

RefCore core_

Definition: Ptr.h:206

Friends And Related Function Documentation

template<class T>

friend class PtrVectorBase

friend

Definition at line 40 of file Ptr.h.

Member Data Documentation

template<class T>

RefCore edm::Ptr< T >::core_

private

Definition at line 206 of file Ptr.h.

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

template<class T>

key_type edm::Ptr< T >::key_

private

Definition at line 207 of file Ptr.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

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