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 22 of file EDProductfwd.h.

Member Typedef Documentation

template<typename C>

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

Definition at line 57 of file RefProd.h.

template<typename C>

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

Definition at line 58 of file RefProd.h.

Constructor & Destructor Documentation

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_() {}

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());
    }

template<typename C>

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

inlineexplicit

General purpose constructor from orphan handle.

Definition at line 70 of file RefProd.h.

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

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 80 of file RefProd.h.

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

template<typename C>

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

inlineexplicit

General purpose constructor from test handle.

Definition at line 90 of file RefProd.h.

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

template<typename C>

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

inline

Definition at line 98 of file RefProd.h.

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

template<typename C>

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

inline

Destructor.

Definition at line 103 of file RefProd.h.

{}

Member Function Documentation

template<typename C>

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

inlineprivate

Definition at line 163 of file RefProd.h.

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

{}

template<typename C>

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

inlinestatic

Definition at line 158 of file RefProd.h.

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

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 113 of file RefProd.h.

Referenced by Options.Options::__getitem__(), betterConfigParser.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(), pat::TriggerEvent::objects(), pat::TriggerEvent::paths(), util.rrapi.RRApi::report(), rrapi.RRApi::report(), util.rrapi.RRApi::reports(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), util.rrapi.RRApi::tables(), rrapi.RRApi::tags(), util.rrapi.RRApi::tags(), rrapi.RRApi::templates(), util.rrapi.RRApi::templates(), util.rrapi.RRApi::workspaces(), and rrapi.RRApi::workspaces().

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

template<typename C>

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

inline

Checks if product is in memory.

Definition at line 143 of file RefProd.h.

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

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

template<typename C>

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

inline

Checks if product is in memory.

Definition at line 146 of file RefProd.h.

{return hasCache();}

template<typename C>

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

inline

Accessor for product ID.

Definition at line 137 of file RefProd.h.

Referenced by PseudoTopProducer::buildGenParticle(), ctfseeding::HitExtractorPIX::hits(), pat::GenPlusSimParticleProducer::produce(), GenParticleProducer::produce(), edm::RefToBaseProd< T >::RefToBaseProd(), and edm::Association< reco::FFTJPTJetCollection >::setRef().

{return product_.id();}

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.

Definition at line 150 of file RefProd.h.

{return product_.isAvailable();}

template<typename C>

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

inline

Checks for non-null.

Definition at line 131 of file RefProd.h.

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

{return product_.isNonnull();}

template<typename C>

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

inline

Checks for null.

Definition at line 128 of file RefProd.h.

Referenced by edm::RefProd< Phase2TrackerCluster1Ds >::get(), TTStubAssociationMap< T >::isUnknown(), edm::RefProd< Phase2TrackerCluster1Ds >::operator!(), edm::RefProd< Phase2TrackerCluster1Ds >::product(), and edm::Association< reco::FFTJPTJetCollection >::setRef().

{return !isNonnull();}

template<typename C>

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

inline

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

Definition at line 153 of file RefProd.h.

{return product_.isTransient();}

template<typename C>

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

inline

Checks for null.

Definition at line 134 of file RefProd.h.

{return isNull();}

template<typename C >

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

inline

Dereference operator.

Definition at line 176 of file RefProd.h.

References edm::RefProd< C >::product_, and svgfig::template().

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

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

template<typename C >

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

inline

Member dereference operator.

Definition at line 183 of file RefProd.h.

References edm::RefProd< C >::product_, and svgfig::template().

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

                                        {
    return edm::template getProduct<C>(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 119 of file RefProd.h.

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

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

template<typename C>

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

inline

Accessor for product getter.

Definition at line 140 of file RefProd.h.

{return product_.productGetter();}

template<typename C>

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

inline

Definition at line 123 of file RefProd.h.

Referenced by edm::Ref< C, T, F >::Ref(), edm::RefToBaseProd< T >::RefToBaseProd(), and reco::TrackExtraBase::setHits().

                                   {
      return product_;
    }

template<typename C>

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

inline

Definition at line 190 of file RefProd.h.

References edm::RefProd< C >::product_, and edm::swap().

Referenced by edm::RefProd< Phase2TrackerCluster1Ds >::isTransient(), edm::ContainerMask< T >::swap(), edm::Association< reco::FFTJPTJetCollection >::swap(), and reco::ClusterRemovalInfo::swap().

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

Member Data Documentation

template<typename C>

RefCore edm::RefProd< C >::product_

private

Definition at line 165 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< C >::operator*(), edm::RefProd< C >::operator->(), edm::RefProd< Phase2TrackerCluster1Ds >::productGetter(), edm::RefProd< Phase2TrackerCluster1Ds >::refCore(), and edm::RefProd< C >::swap().