CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
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 (C const *iProduct)
 Constructor for ref to object that is not in an event. 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 (ProductID const &productID, EDProductGetter const *prodGetter)
 
 RefProd (TestHandle< C > const &handle)
 General purpose constructor from test handle. More...
 
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.

61 : 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.

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

◆ 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.

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

◆ 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.

78 : 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.

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

◆ 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.

93  : 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.

96 {}

Member Function Documentation

◆ checkTypeAtCompileTime()

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

Definition at line 150 of file RefProd.h.

150 {}

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

◆ Class_Version()

template<typename C>
static short edm::RefProd< C >::Class_Version ( )
inlinestatic

Definition at line 145 of file RefProd.h.

147 :
148  // 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

◆ 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.

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

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

◆ 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.

133 { return hasCache(); }

◆ id()

template<typename C>
ProductID edm::RefProd< C >::id ( ) const
inline

◆ 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.

Definition at line 137 of file RefProd.h.

137 { return product_.isAvailable(); }

◆ isNonnull()

template<typename C>
bool edm::RefProd< C >::isNonnull ( ) const
inline

◆ isNull()

template<typename C>
bool edm::RefProd< C >::isNull ( ) const
inline

◆ isTransient()

template<typename C>
bool edm::RefProd< C >::isTransient ( ) const
inline

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

Definition at line 140 of file RefProd.h.

140 { 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.

121 { return isNull(); }

◆ operator*()

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

Dereference operator.

Definition at line 162 of file RefProd.h.

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

◆ operator->()

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

Member dereference operator.

Definition at line 168 of file RefProd.h.

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

Referenced by edm::RefProd< Phase2TrackerCluster1Ds >::get(), and edm::RefProd< Phase2TrackerCluster1Ds >::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.

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

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

◆ productGetter()

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

Accessor for product getter.

Definition at line 127 of file RefProd.h.

127 { return product_.productGetter(); }

◆ refCore()

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

Definition at line 112 of file RefProd.h.

112 { return product_; }

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

◆ swap()

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

Definition at line 173 of file RefProd.h.

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

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

Member Data Documentation

◆ product_

template<typename C>
RefCore edm::RefProd< C >::product_
private
patZpeak.handle
handle
Definition: patZpeak.py:23
edm::swap
void swap(Association< C > &lhs, Association< C > &rhs)
Definition: Association.h:117
edm::mustBeNonZero
EDProductGetter const * mustBeNonZero(EDProductGetter const *prodGetter, std::string refType, ProductID const &productID)
Definition: EDProductGetter.cc:65
edm::RefCore::productGetter
EDProductGetter const * productGetter() const
Definition: RefCore.h:81
edm::RefProd::isNull
bool isNull() const
Checks for null.
Definition: RefProd.h:115
trackingPlots.other
other
Definition: trackingPlots.py:1465
edm::RefCore::isTransient
bool isTransient() const
Definition: RefCore.h:103
edm::RefProd::product_
RefCore product_
Definition: RefProd.h:152
edm::RefCore::id
ProductID id() const
Definition: RefCore.h:48
svgfig.template
def template(fileName, svg, replaceme="REPLACEME")
Definition: svgfig.py:521
edm::RefProd::checkTypeAtCompileTime
void checkTypeAtCompileTime(C const *)
Definition: RefProd.h:150
edm::RefCore::productPtr
void const * productPtr() const
Definition: RefCore.h:51
edm::RefProd::hasCache
bool hasCache() const
Checks if product is in memory.
Definition: RefProd.h:130
edm::RefProd::operator->
product_type const * operator->() const
Member dereference operator.
Definition: RefProd.h:168
edm::RefProd::isNonnull
bool isNonnull() const
Checks for non-null.
Definition: RefProd.h:118
edm::RefCore::isAvailable
bool isAvailable() const
Definition: RefCore.cc:145
edm::RefCore::isNonnull
bool isNonnull() const
Definition: RefCore.h:71