art::ProductPtr< T > Class Template Reference

#include "fwd.h"

Public Types
using	value_type = T
using	const_pointer = T const *
using	const_reference = T const &

Public Member Functions
	ProductPtr ()=default
template<typename H >
	ProductPtr (H const &handle)
	ProductPtr (ProductID const &productID, EDProductGetter const *prodGetter)
template<typename U >
	ProductPtr (ProductPtr< U > const &pu, std::enable_if_t< std::is_base_of_v< T, U >> *=nullptr)
template<typename U >
	ProductPtr (ProductPtr< U > const &pu, std::enable_if_t< std::is_base_of_v< U, T >> *=nullptr)
T const &	operator* () const
T const *	get () const
T const *	operator-> () const
	operator bool () const
RefCore const &	refCore () const noexcept
ProductID	id () const noexcept
EDProductGetter const *	productGetter () const noexcept
bool	isAvailable () const
bool	hasCache () const noexcept

Static Public Member Functions
static constexpr short	Class_Version () noexcept

Private Member Functions
T const *	product_ () const

Private Attributes
RefCore	core_ {}

Detailed Description

template<typename T>
class art::ProductPtr< T >

Definition at line 24 of file fwd.h.

Member Typedef Documentation

template<typename T>

using art::ProductPtr< T >::const_pointer = T const*

Definition at line 50 of file ProductPtr.h.

template<typename T>

using art::ProductPtr< T >::const_reference = T const&

Definition at line 51 of file ProductPtr.h.

template<typename T>

using art::ProductPtr< T >::value_type = T

Definition at line 49 of file ProductPtr.h.

Constructor & Destructor Documentation

template<typename T>

art::ProductPtr< T >::ProductPtr ( )

default

template<typename T>

template<typename H >

art::ProductPtr< T >::ProductPtr ( H const &  handle )

inlineexplicit

Definition at line 57 of file ProductPtr.h.

References art::ProductPtr< T >::core_, art::RefCore::id(), art::errors::InvalidReference, and art::RefCore::isNull().

      : core_{handle.id(), handle.product(), nullptr}
    {
      if (core_.isNull()) {
        throw Exception(errors::InvalidReference)
          << "Attempt to construct a ProductPtr from a Handle with invalid "
             "ProductID. "
             "Perhaps a\n"
             "default-constructed ProductPtr is what you want?";
      }
    }

template<typename T>

art::ProductPtr< T >::ProductPtr ( ProductID const &  productID, EDProductGetter const *  prodGetter  )

inline

Definition at line 70 of file ProductPtr.h.

      : core_{productID, nullptr, prodGetter}
    {}

template<typename T>

template<typename U >

art::ProductPtr< T >::ProductPtr ( ProductPtr< U > const &  pu, std::enable_if_t< std::is_base_of_v< T, U >> *  = nullptr  )

inline

Definition at line 76 of file ProductPtr.h.

      : core_{pu.id(),
              (pu.hasCache() ? static_cast<T const*>(pu.get()) : nullptr),
              pu.productGetter()}
    {}

template<typename T>

template<typename U >

art::ProductPtr< T >::ProductPtr ( ProductPtr< U > const &  pu, std::enable_if_t< std::is_base_of_v< U, T >> *  = nullptr  )

inline

Definition at line 84 of file ProductPtr.h.

      : core_{pu.id(), static_cast<T const*>(pu.get()), nullptr}
    {}

Member Function Documentation

template<typename T>

static constexpr short art::ProductPtr< T >::Class_Version ( )

inlinestaticnoexcept

Definition at line 151 of file ProductPtr.h.

    {
      return 10;
    }

template<typename T>

T const* art::ProductPtr< T >::get ( ) const

inline

Definition at line 101 of file ProductPtr.h.

References art::ProductPtr< T >::core_, art::RefCore::isNull(), and art::ProductPtr< T >::operator->().

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

template<typename T>

bool art::ProductPtr< T >::hasCache ( ) const

inlinenoexcept

Definition at line 144 of file ProductPtr.h.

References art::ProductPtr< T >::core_, and art::RefCore::productPtr().

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

template<typename T>

ProductID art::ProductPtr< T >::id ( ) const

inlinenoexcept

Definition at line 124 of file ProductPtr.h.

References art::ProductPtr< T >::core_, and art::RefCore::id().

Referenced by art::PtrRemapper::operator()(), and art::PtrRemapper::samePtrAs().

    {
      return core_.id();
    }

template<typename T>

bool art::ProductPtr< T >::isAvailable ( ) const

inline

Definition at line 138 of file ProductPtr.h.

References art::ProductPtr< T >::core_, and art::RefCore::isAvailable().

    {
      return core_.isAvailable();
    }

template<typename T>

art::ProductPtr< T >::operator bool ( ) const

inlineexplicit

Definition at line 115 of file ProductPtr.h.

References art::ProductPtr< T >::core_, and art::RefCore::isAvailable().

{ return core_.isAvailable(); }

template<typename T>

T const& art::ProductPtr< T >::operator* ( ) const

inline

Definition at line 94 of file ProductPtr.h.

    {
      // Warning: This causes a nullptr dereference if isNull!
      return *get();
    }

template<typename T>

T const* art::ProductPtr< T >::operator-> ( ) const

inline

Definition at line 107 of file ProductPtr.h.

References art::ProductPtr< T >::core_, art::ProductPtr< T >::product_(), art::RefCore::productPtr(), and art::RefCore::setProductPtr().

Referenced by art::ProductPtr< T >::get().

    {
      if (core_.productPtr() == nullptr) {
        core_.setProductPtr(product_());
      }
      return reinterpret_cast<T const*>(core_.productPtr());
    }

template<typename T>

T const* art::ProductPtr< T >::product_ ( ) const

inlineprivate

Definition at line 158 of file ProductPtr.h.

References art::ProductPtr< T >::core_, e, art::EDProductGetter::getIt(), art::RefCore::id(), art::ProductPtr< T >::productGetter(), and art::errors::ProductNotFound.

Referenced by art::ProductPtr< T >::operator->().

    {
      EDProduct const* product{nullptr};
      if (productGetter()) {
        product = productGetter()->getIt();
      }
      if (product == nullptr) {
        Exception e(errors::ProductNotFound);
        e << "A request to resolve a ProductPtr to a product of type: "
          << cet::demangle_symbol(typeid(T).name()) << " with ProductID "
          << core_.id()
          << "\ncannot be satisfied because the product cannot be found.\n";
        if (productGetter() == nullptr) {
          e << "The productGetter was not set -- are you trying to "
               "dereference a ProductPtr during mixing?\n";
        } else {
          e << "Probably the branch containing the product is not stored in "
               "the input file.\n";
        }
        throw e;
      }
      auto wrapped_product = dynamic_cast<Wrapper<T> const*>(product);
      if (wrapped_product == nullptr) {
        throw Exception{errors::ProductNotFound}
          << "A request to resolve a Product Ptr to a product of type: "
          << cet::demangle_symbol(typeid(T).name()) << " with ProductID"
          << core_.id() << "\ncannot be satisfied due to a type mismatch.\n";
      }
      return wrapped_product->product();
    }

template<typename T>

EDProductGetter const* art::ProductPtr< T >::productGetter ( ) const

inlinenoexcept

Definition at line 130 of file ProductPtr.h.

References art::ProductPtr< T >::core_, and art::RefCore::productGetter().

Referenced by art::ProductPtr< T >::product_().

    {
      return core_.productGetter();
    }

template<typename T>

RefCore const& art::ProductPtr< T >::refCore ( ) const

inlinenoexcept

Definition at line 118 of file ProductPtr.h.

References art::ProductPtr< T >::core_.

Referenced by art::operator<().

    {
      return core_;
    }

Member Data Documentation

template<typename T>

RefCore art::ProductPtr< T >::core_ {}

private

Definition at line 190 of file ProductPtr.h.

Referenced by art::ProductPtr< T >::get(), art::ProductPtr< T >::hasCache(), art::ProductPtr< T >::id(), art::ProductPtr< T >::isAvailable(), art::ProductPtr< T >::operator bool(), art::ProductPtr< T >::operator->(), art::ProductPtr< T >::product_(), art::ProductPtr< T >::productGetter(), art::ProductPtr< T >::ProductPtr(), and art::ProductPtr< T >::refCore().

---

The documentation for this class was generated from the following files:

• canvas/Persistency/Common/fwd.h
• canvas/Persistency/Common/ProductPtr.h