edm::RefProd< C > Class Template Reference

#include <EDProductfwd.h>

Public Types
typedef C	product_type
typedef C	value_type

Public Member Functions
product_type const *	get () const
bool	hasCache () const
	Checks if product is in memory. More...
bool	hasProductCache () const
	Checks if product is in memory. More...
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 RefProd is transient (i.e. not persistable). More...
bool	operator! () const
	Checks for null. More...
product_type const &	operator* () const
	Dereference operator. More...
product_type const *	operator-> () const
	Member dereference operator. More...
product_type const *	product () const
EDProductGetter const *	productGetter () const
	Accessor for product getter. More...
RefCore const &	refCore () const
	RefProd ()
	Default constructor needed for reading from persistent store. Not for direct use. More...
	RefProd (Handle< C > const &handle)
	General purpose constructor from handle. More...
	RefProd (OrphanHandle< C > const &handle)
	General purpose constructor from orphan handle. More...
	RefProd (C const *iProduct)
	Constructor for ref to object that is not in an event. More...
	RefProd (TestHandle< C > const &handle)
	General purpose constructor from test handle. More...
	RefProd (ProductID const &productID, EDProductGetter const *prodGetter)
void	swap (RefProd< C > &)
	~RefProd ()
	Destructor. More...

Static Public Member Functions
static short	Class_Version ()

Private Member Functions
void	checkTypeAtCompileTime (C const *)

Private Attributes
RefCore	product_

Detailed Description

template<typename C>
class edm::RefProd< C >

Definition at line 25 of file EDProductfwd.h.

Member Typedef Documentation

product_type

template<typename C>

typedef C edm::RefProd< C >::product_type

Definition at line 57 of file RefProd.h.

value_type

template<typename C>

typedef C edm::RefProd< C >::value_type

Definition at line 58 of file RefProd.h.

Constructor & Destructor Documentation

RefProd() [1/6]

template<typename C>

edm::RefProd< C >::RefProd ( )

inline

Default constructor needed for reading from persistent store. Not for direct use.

Definition at line 61 of file RefProd.h.

: product_() {}

RefProd() [2/6]

template<typename C>

edm::RefProd< C >::RefProd ( Handle< C > const &  handle )

inlineexplicit

General purpose constructor from handle.

Definition at line 64 of file RefProd.h.

                                              : product_(handle.id(), handle.product(), nullptr, false) {
      checkTypeAtCompileTime(handle.product());
    }

RefProd() [3/6]

template<typename C>

edm::RefProd< C >::RefProd ( OrphanHandle< C > const &  handle )

inlineexplicit

General purpose constructor from orphan handle.

Definition at line 69 of file RefProd.h.

                                                    : product_(handle.id(), handle.product(), nullptr, false) {
      checkTypeAtCompileTime(handle.product());
    }

RefProd() [4/6]

template<typename C>

edm::RefProd< C >::RefProd ( C const *  iProduct )

inline

Constructor for ref to object that is not in an event.

Definition at line 78 of file RefProd.h.

: product_(ProductID(), iProduct, nullptr, true) { checkTypeAtCompileTime(iProduct); }

RefProd() [5/6]

template<typename C>

edm::RefProd< C >::RefProd ( TestHandle< C > const &  handle )

inlineexplicit

General purpose constructor from test handle.

Definition at line 85 of file RefProd.h.

                                                  : product_(handle.id(), handle.product(), nullptr, true) {
      checkTypeAtCompileTime(handle.product());
    }

RefProd() [6/6]

template<typename C>

edm::RefProd< C >::RefProd ( ProductID const &  productID, EDProductGetter const *  prodGetter  )

inline

Definition at line 92 of file RefProd.h.

        : product_(productID, nullptr, mustBeNonZero(prodGetter, "RefProd", productID), false) {}

~RefProd()

template<typename C>

edm::RefProd< C >::~RefProd ( )

inline

Destructor.

Definition at line 96 of file RefProd.h.

{}

Member Function Documentation

checkTypeAtCompileTime()

template<typename C>

void edm::RefProd< C >::checkTypeAtCompileTime ( C const *  )

inlineprivate

Definition at line 152 of file RefProd.h.

Referenced by edm::RefProd< Phase2TrackerCluster1Ds >::RefProd().

{}

Class_Version()

template<typename C>

static short edm::RefProd< C >::Class_Version ( )

inlinestatic

Definition at line 147 of file RefProd.h.

:
    // Compile time check that the argument is a C* or C const*

get()

template<typename C>

product_type const* edm::RefProd< C >::get ( ) const

inline

Returns C++ pointer to the product Will attempt to retrieve product

Definition at line 106 of file RefProd.h.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), pat::TriggerEvent::algorithms(), l1extra::L1ParticleMap::candidateInCombo(), util.rrapi.RRApi::columns(), rrapi.RRApi::columns(), pat::TriggerEvent::conditions(), util.rrapi.RRApi::count(), rrapi.RRApi::count(), util.rrapi.RRApi::data(), rrapi.RRApi::data(), l1extra::L1ParticleMap::etMissParticleInCombo(), pat::TriggerEvent::filters(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), pat::TriggerEvent::objects(), pat::TriggerEvent::paths(), rrapi.RRApi::report(), util.rrapi.RRApi::report(), rrapi.RRApi::reports(), util.rrapi.RRApi::reports(), util.rrapi.RRApi::tables(), rrapi.RRApi::tables(), util.rrapi.RRApi::tags(), rrapi.RRApi::tags(), util.rrapi.RRApi::templates(), rrapi.RRApi::templates(), rrapi.RRApi::workspaces(), and util.rrapi.RRApi::workspaces().

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

hasCache()

template<typename C>

bool edm::RefProd< C >::hasCache ( ) const

inline

Checks if product is in memory.

Definition at line 130 of file RefProd.h.

Referenced by edm::RefProd< Phase2TrackerCluster1Ds >::hasProductCache().

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

hasProductCache()

template<typename C>

bool edm::RefProd< C >::hasProductCache ( ) const

inline

Checks if product is in memory.

Definition at line 133 of file RefProd.h.

{ return hasCache(); }

id()

template<typename C>

ProductID edm::RefProd< C >::id ( ) const

inline

Accessor for product ID.

Definition at line 124 of file RefProd.h.

Referenced by ctfseeding::HitExtractorPIX::hits(), l1t::RegionalOutput< T >::id(), LowPtGsfElectronSCProducer::produce(), TrackListMerger::produce(), HITrackClusterRemover::produce(), pat::GenPlusSimParticleProducer::produce(), GenParticleProducer::produce(), edm::RefToBaseProd< T >::RefToBaseProd(), edm::Association< C >::setRef(), edm::thinnedRefFrom(), and edm::tryThinnedRefFrom().

{ return product_.id(); }

isAvailable()

template<typename C>

bool edm::RefProd< C >::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 139 of file RefProd.h.

{ return product_.isAvailable(); }

isNonnull()

template<typename C>

bool edm::RefProd< C >::isNonnull ( ) const

inline

Checks for non-null.

Definition at line 118 of file RefProd.h.

Referenced by reco::ClusterRemovalInfo::hasPhase2OT(), reco::ClusterRemovalInfo::hasPixel(), reco::ClusterRemovalInfo::hasStrip(), and edm::RefProd< Phase2TrackerCluster1Ds >::isNull().

{ return product_.isNonnull(); }

isNull()

template<typename C>

bool edm::RefProd< C >::isNull ( ) const

inline

Checks for null.

Definition at line 115 of file RefProd.h.

Referenced by edm::RefProd< Phase2TrackerCluster1Ds >::get(), edm::RefProd< Phase2TrackerCluster1Ds >::operator!(), edm::RefProd< Phase2TrackerCluster1Ds >::product(), and edm::Association< C >::setRef().

{ return !isNonnull(); }

isTransient()

template<typename C>

bool edm::RefProd< C >::isTransient ( ) const

inline

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

Definition at line 142 of file RefProd.h.

{ return product_.isTransient(); }

operator!()

template<typename C>

bool edm::RefProd< C >::operator! ( ) const

inline

Checks for null.

Definition at line 121 of file RefProd.h.

{ return isNull(); }

operator*()

template<typename C >

C const & edm::RefProd< C >::operator* ( ) const

inline

Dereference operator.

Definition at line 164 of file RefProd.h.

                                              {
    return *(edm::template getProduct<C>(product_));
  }

operator->()

template<typename C >

C const * edm::RefProd< C >::operator-> ( ) const

inline

Member dereference operator.

Definition at line 170 of file RefProd.h.

Referenced by edm::RefProd< Phase2TrackerCluster1Ds >::get(), and edm::RefProd< Phase2TrackerCluster1Ds >::product().

                                               {
    return edm::template getProduct<C>(product_);
  }

product()

template<typename C>

product_type const* edm::RefProd< C >::product ( ) const

inline

Returns C++ pointer to the product Will attempt to retrieve product

Definition at line 110 of file RefProd.h.

Referenced by edm::ContainerMask< T >::ContainerMask(), edm::ContainerMask< T >::mask(), and edm::RefToBaseProd< T >::RefToBaseProd().

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

productGetter()

template<typename C>

EDProductGetter const* edm::RefProd< C >::productGetter ( ) const

inline

Accessor for product getter.

Definition at line 127 of file RefProd.h.

{ return product_.productGetter(); }

refCore()

template<typename C>

RefCore const& edm::RefProd< C >::refCore ( ) const

inline

Definition at line 112 of file RefProd.h.

Referenced by edm::Ref< L1GctEmCandCollection >::Ref(), and edm::RefToBaseProd< T >::RefToBaseProd().

{ return product_; }

swap()

template<typename C>

void edm::RefProd< C >::swap ( RefProd< C > &  other )

inline

Definition at line 175 of file RefProd.h.

Referenced by edm::ContainerMask< T >::swap(), edm::Association< C >::swap(), and reco::ClusterRemovalInfo::swap().

                                                {
    edm::swap(product_, other.product_);
  }

Member Data Documentation

product_

template<typename C>

RefCore edm::RefProd< C >::product_

private

Definition at line 154 of file RefProd.h.

Referenced by edm::RefProd< Phase2TrackerCluster1Ds >::hasCache(), edm::RefProd< Phase2TrackerCluster1Ds >::id(), edm::RefProd< Phase2TrackerCluster1Ds >::isAvailable(), edm::RefProd< Phase2TrackerCluster1Ds >::isNonnull(), edm::RefProd< Phase2TrackerCluster1Ds >::isTransient(), edm::RefProd< Phase2TrackerCluster1Ds >::productGetter(), and edm::RefProd< Phase2TrackerCluster1Ds >::refCore().