edm::RefCoreWithIndex Class Reference

#include <RefCoreWithIndex.h>

Public Member Functions
WrapperBase const *	getProductPtr (std::type_info const &type, EDProductGetter const *prodGetter) const
ProductID	id () const
unsigned int	index () const
bool	isAvailable () const
bool	isNonnull () const
bool	isNull () const
bool	isTransient () const
int	isTransientInt () const
void	nullPointerForTransientException (std::type_info const &type) const
bool	operator! () const
RefCoreWithIndex &	operator= (RefCoreWithIndex const &)
RefCoreWithIndex &	operator= (RefCoreWithIndex &&iOther) noexcept
EDProductGetter const *	productGetter () const
void	productNotFoundException (std::type_info const &type) const
void const *	productPtr () const
void	pushBackItem (RefCoreWithIndex const &productToBeInserted, bool checkPointer)
	RefCoreWithIndex ()
	RefCoreWithIndex (ProductID const &theId, void const *prodPtr, EDProductGetter const *prodGetter, bool transient, unsigned int elementIndex)
	RefCoreWithIndex (RefCore const &iCore, unsigned int)
	RefCoreWithIndex (RefCoreWithIndex const &)
	RefCoreWithIndex (RefCoreWithIndex &&iOther) noexcept
void	setProductGetter (EDProductGetter const *prodGetter) const
void	setProductPtr (void const *prodPtr) const
void	swap (RefCoreWithIndex &)
RefCore const &	toRefCore () const
bool	tryToSetProductPtrForFirstTime (void const *prodPtr) const
void	wrongTypeException (std::type_info const &expectedType, std::type_info const &actualType) const
	~RefCoreWithIndex () noexcept

Private Member Functions
void	setCacheIsProductGetter (EDProductGetter const *iGetter) const
void	setCacheIsProductPtr (void const *iItem) const
void	setId (ProductID const &iId)
void	setTransient ()
RefCore &	toUnConstRefCore ()

Private Attributes
std::atomic< void const * >	cachePtr_
unsigned int	elementIndex_
ProcessIndex	processIndex_
ProductIndex	productIndex_

Detailed Description

Definition at line 25 of file RefCoreWithIndex.h.

Constructor & Destructor Documentation

edm::RefCoreWithIndex::RefCoreWithIndex ( )

inline

Definition at line 27 of file RefCoreWithIndex.h.

References operator=().

:  cachePtr_(nullptr),processIndex_(0),productIndex_(0),elementIndex_(edm::key_traits<unsigned int>::value) {}

edm::RefCoreWithIndex::RefCoreWithIndex	(	ProductID const &	theId,
		void const *	prodPtr,
		EDProductGetter const *	prodGetter,
		bool	transient,
		unsigned int	elementIndex
	)

Definition at line 6 of file RefCoreWithIndex.cc.

References setCacheIsProductGetter(), and setTransient().

                                                                                                                                                        :
      cachePtr_(prodPtr),
      processIndex_(theId.processIndex()),
      productIndex_(theId.productIndex()),
      elementIndex_(iIndex)
      {
        if(transient) {
          setTransient();
        }
        if(prodPtr==nullptr && prodGetter!=nullptr) {
          setCacheIsProductGetter(prodGetter);
        }
      }

edm::RefCoreWithIndex::RefCoreWithIndex	(	RefCore const &	iCore,
		unsigned int	iIndex
	)

Definition at line 20 of file RefCoreWithIndex.cc.

References edm::RefCore::cachePtr_, and cachePtr_.

                                                                             :
  processIndex_(iCore.processIndex_),
  productIndex_(iCore.productIndex_),
  elementIndex_(iIndex){
     cachePtr_.store(iCore.cachePtr_.load(std::memory_order_relaxed), std::memory_order_relaxed);
  }

edm::RefCoreWithIndex::RefCoreWithIndex

(

RefCoreWithIndex const &

iOther

)

Definition at line 27 of file RefCoreWithIndex.cc.

References cachePtr_.

                                                                    :
    processIndex_(iOther.processIndex_),
    productIndex_(iOther.productIndex_),
    elementIndex_(iOther.elementIndex_){
    cachePtr_.store(iOther.cachePtr_.load(std::memory_order_relaxed), std::memory_order_relaxed);
  }

edm::RefCoreWithIndex::RefCoreWithIndex ( RefCoreWithIndex &&  iOther )

inlinenoexcept

Definition at line 37 of file RefCoreWithIndex.h.

References cachePtr_.

                                                          : 
    processIndex_(iOther.processIndex_),
    productIndex_(iOther.productIndex_),elementIndex_(iOther.elementIndex_) {
      cachePtr_.store(iOther.cachePtr_.load(std::memory_order_relaxed), std::memory_order_relaxed);
    }

edm::RefCoreWithIndex::~RefCoreWithIndex ( )

inlinenoexcept

Definition at line 51 of file RefCoreWithIndex.h.

{}

Member Function Documentation

WrapperBase const* edm::RefCoreWithIndex::getProductPtr ( std::type_info const &  type, EDProductGetter const *  prodGetter  ) const

inline

Definition at line 105 of file RefCoreWithIndex.h.

References edm::RefCore::getProductPtr(), and toRefCore().

                                                                                                        {
      return toRefCore().getProductPtr(type,prodGetter);
    }

ProductID edm::RefCoreWithIndex::id ( ) const

inline

Definition at line 53 of file RefCoreWithIndex.h.

References ID_IMPL.

Referenced by OmniClusterRef::id(), edm::RefCoreWithIndexStreamer::operator()(), and reco::LeafRefCandidateT::overlap().

{ID_IMPL;}

unsigned int edm::RefCoreWithIndex::index ( ) const

inline

Definition at line 74 of file RefCoreWithIndex.h.

References elementIndex_.

Referenced by reco::LeafRefCandidateT::getRef(), BeautifulSoup.PageElement::insert(), edm::RefCoreWithIndexStreamer::operator()(), reco::LeafRefCandidateT::overlap(), and OmniClusterRef::rawIndex().

{ return elementIndex_;}

bool edm::RefCoreWithIndex::isAvailable ( ) const

inline

Definition at line 88 of file RefCoreWithIndex.h.

References edm::RefCore::isAvailable(), and toRefCore().

                             {
      return toRefCore().isAvailable();
    }

bool edm::RefCoreWithIndex::isNonnull ( ) const

inline

Definition at line 80 of file RefCoreWithIndex.h.

References ISNONNULL_IMPL.

Referenced by isNull().

{ISNONNULL_IMPL;}

bool edm::RefCoreWithIndex::isNull ( ) const

inline

Definition at line 77 of file RefCoreWithIndex.h.

References isNonnull().

Referenced by operator!().

{return !isNonnull(); }

bool edm::RefCoreWithIndex::isTransient ( ) const

inline

Definition at line 123 of file RefCoreWithIndex.h.

References ISTRANSIENT_IMPL.

Referenced by isTransientInt(), and edm::RefCoreWithIndexStreamer::operator()().

{ISTRANSIENT_IMPL;}

int edm::RefCoreWithIndex::isTransientInt ( ) const

inline

Definition at line 125 of file RefCoreWithIndex.h.

References isTransient().

{return isTransient() ? 1 : 0;}

void edm::RefCoreWithIndex::nullPointerForTransientException ( std::type_info const &  type ) const

inline

Definition at line 117 of file RefCoreWithIndex.h.

References edm::RefCore::nullPointerForTransientException(), swap(), and toRefCore().

                                                                          {
      toRefCore().nullPointerForTransientException(type);
    }

bool edm::RefCoreWithIndex::operator! ( ) const

inline

Definition at line 83 of file RefCoreWithIndex.h.

References isNull().

{return isNull();}

RefCoreWithIndex & edm::RefCoreWithIndex::operator=

(

RefCoreWithIndex const &

iOther

)

Definition at line 34 of file RefCoreWithIndex.cc.

References cachePtr_, elementIndex_, processIndex_, and productIndex_.

Referenced by RefCoreWithIndex().

                                                                               {
    cachePtr_.store(iOther.cachePtr_.load(std::memory_order_relaxed), std::memory_order_relaxed);
    processIndex_ = iOther.processIndex_;
    productIndex_ = iOther.productIndex_;
    elementIndex_ = iOther.elementIndex_;
    return *this;
  }

RefCoreWithIndex& edm::RefCoreWithIndex::operator= ( RefCoreWithIndex &&  iOther )

inlinenoexcept

Definition at line 43 of file RefCoreWithIndex.h.

References cachePtr_, elementIndex_, processIndex_, and productIndex_.

                                                                    {
       cachePtr_.store(iOther.cachePtr_.load(std::memory_order_relaxed), std::memory_order_relaxed);
       processIndex_ = iOther.processIndex_;
       productIndex_ = iOther.productIndex_;
       elementIndex_ = iOther.elementIndex_;
       return *this;
    }

EDProductGetter const* edm::RefCoreWithIndex::productGetter ( ) const

inline

Definition at line 97 of file RefCoreWithIndex.h.

References PRODUCTGETTER_IMPL.

                                                 {
      PRODUCTGETTER_IMPL;
    }

void edm::RefCoreWithIndex::productNotFoundException ( std::type_info const &  type ) const

inline

Definition at line 109 of file RefCoreWithIndex.h.

References edm::RefCore::productNotFoundException(), and toRefCore().

                                                                  {
      toRefCore().productNotFoundException(type);
    }

void const* edm::RefCoreWithIndex::productPtr ( ) const

inline

If productPtr is not 0 then productGetter will be 0 since only one is available at a time

Definition at line 56 of file RefCoreWithIndex.h.

References PRODUCTPTR_IMPL.

{PRODUCTPTR_IMPL;}

void edm::RefCoreWithIndex::pushBackItem ( RefCoreWithIndex const &  productToBeInserted, bool  checkPointer  )

inline

Definition at line 127 of file RefCoreWithIndex.h.

References edm::RefCore::pushBackItem(), toRefCore(), and toUnConstRefCore().

                                                                                      {
      toUnConstRefCore().pushBackItem(productToBeInserted.toRefCore(),checkPointer);
    }

void edm::RefCoreWithIndex::setCacheIsProductGetter ( EDProductGetter const *  iGetter ) const

inlineprivate

Definition at line 141 of file RefCoreWithIndex.h.

References SETCACHEISPRODUCTGETTER_IMPL.

Referenced by RefCoreWithIndex().

{SETCACHEISPRODUCTGETTER_IMPL(iGetter);}

void edm::RefCoreWithIndex::setCacheIsProductPtr ( void const *  iItem ) const

inlineprivate

Definition at line 140 of file RefCoreWithIndex.h.

References SETCACHEISPRODUCTPTR_IMPL.

Referenced by setProductPtr().

{SETCACHEISPRODUCTPTR_IMPL(iItem);}

void edm::RefCoreWithIndex::setId ( ProductID const &  iId )

inlineprivate

Definition at line 136 of file RefCoreWithIndex.h.

References edm::RefCore::setId(), and toUnConstRefCore().

                                     {
      toUnConstRefCore().setId(iId);
    }

void edm::RefCoreWithIndex::setProductGetter ( EDProductGetter const *  prodGetter ) const

inline

Definition at line 101 of file RefCoreWithIndex.h.

References edm::RefCore::setProductGetter(), and toRefCore().

                                                                   {
      toRefCore().setProductGetter(prodGetter);
    }

void edm::RefCoreWithIndex::setProductPtr ( void const *  prodPtr ) const

inline

This function is 'const' even though it changes an internal value becuase it is meant to be used as a way to store in a thread-safe way a cache of a value. This allows classes which use the RefCore to not have to declare it 'mutable'

Definition at line 62 of file RefCoreWithIndex.h.

References setCacheIsProductPtr().

                                                  {
      setCacheIsProductPtr(prodPtr);
    }

void edm::RefCoreWithIndex::setTransient ( )

inlineprivate

Definition at line 139 of file RefCoreWithIndex.h.

References SETTRANSIENT_IMPL.

Referenced by RefCoreWithIndex().

{SETTRANSIENT_IMPL;}

void edm::RefCoreWithIndex::swap ( RefCoreWithIndex &  other )

inline

Definition at line 162 of file RefCoreWithIndex.h.

References cachePtr_, elementIndex_, processIndex_, productIndex_, and std::swap().

Referenced by nullPointerForTransientException(), and edm::swap().

                                                 {
    std::swap(processIndex_, other.processIndex_);
    std::swap(productIndex_, other.productIndex_);
    other.cachePtr_.store(cachePtr_.exchange(other.cachePtr_.load()));
    std::swap(elementIndex_,other.elementIndex_);
  }

RefCore const& edm::RefCoreWithIndex::toRefCore ( ) const

inline

Definition at line 93 of file RefCoreWithIndex.h.

Referenced by OmniClusterRef::cluster_mtd(), OmniClusterRef::cluster_phase2OT(), OmniClusterRef::cluster_pixel(), OmniClusterRef::cluster_strip(), getProductPtr(), reco::LeafRefCandidateT::getRef(), isAvailable(), OmniClusterRef::mtdCluster(), nullPointerForTransientException(), OmniClusterRef::phase2OTCluster(), OmniClusterRef::pixelCluster(), productNotFoundException(), pushBackItem(), setProductGetter(), OmniClusterRef::stripCluster(), and wrongTypeException().

                                     {
      return *reinterpret_cast<const RefCore*>(this);
    }

RefCore& edm::RefCoreWithIndex::toUnConstRefCore ( )

inlineprivate

Definition at line 132 of file RefCoreWithIndex.h.

Referenced by pushBackItem(), and setId().

                               {
      return *reinterpret_cast<RefCore*>(this);
    }

bool edm::RefCoreWithIndex::tryToSetProductPtrForFirstTime ( void const *  prodPtr ) const

inline

This function is 'const' even though it changes an internal value becuase it is meant to be used as a way to store in a thread-safe way a cache of a value. This allows classes which use the RefCore to not have to declare it 'mutable'

Definition at line 70 of file RefCoreWithIndex.h.

References cachePtr_, and edm::refcoreimpl::tryToSetCacheItemForFirstTime().

                                                                   {
      return refcoreimpl::tryToSetCacheItemForFirstTime(cachePtr_, prodPtr);
    }

void edm::RefCoreWithIndex::wrongTypeException ( std::type_info const &  expectedType, std::type_info const &  actualType  ) const

inline

Definition at line 113 of file RefCoreWithIndex.h.

References toRefCore(), and edm::RefCore::wrongTypeException().

                                                                                                    {
      toRefCore().wrongTypeException(expectedType,actualType);
    }

Member Data Documentation

std::atomic<void const*> edm::RefCoreWithIndex::cachePtr_

mutableprivate

Definition at line 150 of file RefCoreWithIndex.h.

Referenced by operator=(), RefCoreWithIndex(), swap(), and tryToSetProductPtrForFirstTime().

unsigned int edm::RefCoreWithIndex::elementIndex_

private

Definition at line 156 of file RefCoreWithIndex.h.

Referenced by index(), operator=(), and swap().

ProcessIndex edm::RefCoreWithIndex::processIndex_

private

Definition at line 154 of file RefCoreWithIndex.h.

Referenced by operator=(), and swap().

ProductIndex edm::RefCoreWithIndex::productIndex_

private

Definition at line 155 of file RefCoreWithIndex.h.

Referenced by operator=(), and swap().