art::Ptr< T > Class Template Reference

#include "fwd.h"

Public Types
typedef std::size_t	key_type
typedef T	value_type
typedef T const *	const_pointer
typedef T const &	const_reference

Public Member Functions
	Ptr ()=default
template<typename H >
	Ptr (H const &handle, key_type idx)
	Ptr (ProductID const id)
	Ptr (ProductID const productID, key_type itemKey, EDProductGetter const *prodGetter)
template<typename U >
	Ptr (Ptr< U > const &iOther, std::enable_if_t< std::is_base_of< T, U >::value > *dummy=nullptr)
template<typename U >
	Ptr (Ptr< U > const &iOther, std::enable_if_t< std::is_base_of< U, T >::value > *dummy=nullptr)
	Ptr (ProductID const productID, T const *item, key_type itemKey)
T const &	operator* () const
T const *	operator-> () const
T const *	get () const
bool	isNull () const
bool	isNonnull () const
bool	isAvailable () const
ProductID	id () const
key_type	key () const
bool	hasCache () const
RefCore const &	refCore () const
	operator bool () const
EDProductGetter const *	productGetter () const
template<typename H >
	Ptr (H const &handle, typename Ptr< T >::key_type const idx)

Static Public Member Functions
static short	Class_Version ()

Private Member Functions
template<typename C >
T const *	getItem_ (C const *product, key_type iKey)
void	getData_ () const

Private Attributes
RefCore	core_ {}
key_type	key_ {key_traits<key_type>::value}

Detailed Description

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

Definition at line 25 of file fwd.h.

Member Typedef Documentation

template<typename T>

typedef T const* art::Ptr< T >::const_pointer

Definition at line 104 of file Ptr.h.

template<typename T>

typedef T const& art::Ptr< T >::const_reference

Definition at line 105 of file Ptr.h.

template<typename T>

typedef std::size_t art::Ptr< T >::key_type

Definition at line 102 of file Ptr.h.

template<typename T>

typedef T art::Ptr< T >::value_type

Definition at line 103 of file Ptr.h.

Constructor & Destructor Documentation

template<typename T>

art::Ptr< T >::Ptr ( )

default

template<typename T>

template<typename H >

art::Ptr< T >::Ptr	(	H const &	handle,
		key_type	idx
	)

template<typename T >

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

inlineexplicit

Definition at line 269 of file Ptr.h.

References art::Ptr< T >::key_.

  : core_{productID, 0, nullptr}, key_{key_traits<key_type>::value}
{}

template<typename T >

art::Ptr< T >::Ptr ( ProductID const  productID, key_type  itemKey, EDProductGetter const *  prodGetter  )

inline

Definition at line 274 of file Ptr.h.

References art::Ptr< T >::key_.

  : core_{productID, 0, prodGetter}, key_{itemKey}
{}

template<typename T>

template<typename U >

art::Ptr< T >::Ptr ( Ptr< U > const &  iOther, std::enable_if_t< std::is_base_of< T, U >::value > *  dummy = nullptr  )

inline

Definition at line 282 of file Ptr.h.

References art::Ptr< T >::key().

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

template<typename T>

template<typename U >

art::Ptr< T >::Ptr ( Ptr< U > const &  iOther, std::enable_if_t< std::is_base_of< U, T >::value > *  dummy = nullptr  )

inline

Definition at line 293 of file Ptr.h.

References art::Ptr< T >::get(), art::Ptr< T >::id(), and art::Ptr< T >::key_.

  : core_{iOther.id(), dynamic_cast<T const*>(iOther.get()), nullptr}
  , key_{iOther.key()}
{}

template<typename T>

art::Ptr< T >::Ptr ( ProductID const  productID, T const *  item, key_type  itemKey  )

inline

Definition at line 300 of file Ptr.h.

References art::Ptr< T >::key_.

  : core_{productID, item, nullptr}, key_{itemKey}
{}

template<typename T>

template<typename H >

art::Ptr< T >::Ptr ( H const &  handle, typename Ptr< T >::key_type const  idx  )

inline

Definition at line 258 of file Ptr.h.

References art::Ptr< T >::core_, art::Ptr< T >::getItem_(), art::errors::InvalidReference, art::RefCore::isNull(), and art::Ptr< T >::key_.

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

Member Function Documentation

template<typename T>

static short art::Ptr< T >::Class_Version ( )

inlinestatic

Definition at line 155 of file Ptr.h.

  {
    return 10;
  }

template<typename T >

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

inline

Definition at line 321 of file Ptr.h.

References art::Ptr< T >::isNull(), and art::Ptr< T >::operator->().

Referenced by g4b::ConvertMCTruthToG4::Append(), lar_cluster3d::StandardHit3DBuilder::CollectArtHits(), CRHitRemoval::collectPFParticleHits(), evd::RecoBaseDrawer::DrawTrackVertexAssns2D(), art::detail::BcollHelper< ProdB >::fill(), util::FindUNotAssociatedToT(), evgb::util::FindUNotAssociatedToT(), g4b::G4Helper::G4Run(), lar_pandora::PFParticleValidation::GetMCPrimaryMatchingMap(), lar_pandora::PFParticleValidation::GetSimpleMCPrimaryList(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), evgb::MCTruthAndFriendsItr::Next(), CRHitRemovalByPCA::produce(), larg4::LArG4::produce(), art::Ptr< T >::Ptr(), and CRHitRemovalByPCA::removeTaggedHits().

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

template<typename T >

void art::Ptr< T >::getData_ ( ) const

private

Definition at line 398 of file Ptr.h.

References art::Ptr< T >::core_, e, art::EDProductGetter::getIt(), art::Ptr< T >::hasCache(), art::RefCore::id(), art::Ptr< T >::key(), art::Ptr< T >::key_, art::operator!=(), art::operator==(), art::Ptr< T >::productGetter(), art::errors::ProductNotFound, art::Ptr< T >::refCore(), art::RefCore::setProductPtr(), art::EDProduct::setPtr(), and fhicl::detail::atom::value().

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

{
  if (!hasCache()) {
    EDProduct const* prod =
      productGetter() ? productGetter()->getIt() : nullptr;
    if (prod == nullptr) {
      art::Exception e(errors::ProductNotFound);
      e << "A request to resolve an art::Ptr to a product containing items 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 "
             "Ptr during mixing?\n";
      } else {
        e << "Probably the branch containing the product is not stored in the "
             "input file.\n";
      }
      throw e;
    }
    void const* ad = nullptr;
    prod->setPtr(typeid(T), key_, ad);
    core_.setProductPtr(ad);
  }
}

template<typename T >

template<typename C >

T const * art::Ptr< T >::getItem_ ( C const *  product, key_type  iKey  )

inlineprivate

Definition at line 391 of file Ptr.h.

Referenced by art::Ptr< T >::Ptr().

{
  return detail::ItemGetter<T, C>()(product, iKey);
}

template<typename T >

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

inline

Definition at line 363 of file Ptr.h.

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

Referenced by art::Ptr< T >::getData_().

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

template<typename T >

auto art::Ptr< T >::id ( ) const

inline

Definition at line 349 of file Ptr.h.

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

Referenced by art::Assns< L, R, void >::fill_transients(), lar::util::details::FindAllP< Source, Dest >::hasProduct(), lar::util::details::FindAllP< Source, Dest >::Merge(), art::PtrRemapper::operator()(), std::hash< art::Ptr< T > >::operator()(), lar::util::details::UniqueAssociationCache< Source_t, Dest_t >::operator[](), and art::Ptr< T >::Ptr().

{
  return core_.id();
}

template<typename T >

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

inline

Definition at line 342 of file Ptr.h.

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

Referenced by art::Ptr< T >::operator bool().

{
  return core_.isAvailable();
}

template<typename T >

bool art::Ptr< T >::isNonnull ( ) const

inline

Definition at line 335 of file Ptr.h.

References art::Ptr< T >::key_.

Referenced by recob::HitCollectionCreator::CreateAssociationsToLastHit(), art::Ptr< T >::isNull(), lar::util::details::FindAllP< Source, Dest >::Merge(), art::Ptr< T >::operator bool(), art::PtrRemapper::operator()(), and hit::HitCheater::produce().

{
  return key_traits<key_type>::value != key_;
}

template<typename T >

bool art::Ptr< T >::isNull ( ) const

inline

Definition at line 328 of file Ptr.h.

References art::Ptr< T >::isNonnull().

Referenced by cluster::BlurredClusteringAlg::ConvertBinsToRecobHits(), trkf::KGTrack::fillHits(), art::Ptr< T >::get(), lar::util::details::FindAllP< Source, Dest >::Merge(), shower::EMShowerAlg::OrderShowerHits(), recob::HitCollectionAssociator::prepare_associations(), recob::HitRefinerAssociator::prepare_associations(), trkf::PMAlgTrajFitter::produce(), and trkf::PMAlgTrackMaker::produce().

{
  return !isNonnull();
}

template<typename T >

auto art::Ptr< T >::key ( ) const

inline

Definition at line 356 of file Ptr.h.

References art::Ptr< T >::key_.

Referenced by shower::TCShowerAlg::addShowerHit(), RecoProxyUsageExample::analyze(), NuShowerEff::analyze(), lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps(), shower::EMShowerAlg::CheckShowerPlanes(), lar_pandora::LArPandoraExternalEventBuilding::CollectPFParticles(), t0::IndirectHitParticleAssns::CreateHitParticleAssociations(), evd::RecoBaseDrawer::DrawPFParticle3D(), evd::RecoBaseDrawer::DrawTrackVertexAssns2D(), ems::EndPoint::FillBins(), lar_pandora::LArPandoraHelper::GetAssociatedHits(), lar_pandora::LArPandoraEvent::GetAssociationMap(), art::Ptr< T >::getData_(), anab::MVAReader< T, N >::getOutput(), shower::TCShower::getShowersWithSlices(), anab::FVectorReader< T, N >::getVector(), anab::FVectorWriter< 4 >::getVector(), art::PtrVectorBase::key(), trkmkr::TrackMaker::makeTrack(), lar::util::details::FindAllP< Source, Dest >::Merge(), art::PtrRemapper::operator()(), std::hash< art::Ptr< T > >::operator()(), lar::util::details::UniqueAssociationCache< Source_t, Dest_t >::operator[](), lar_pandora::LArPandoraEventDump::PrintCluster(), lar_pandora::LArPandoraEventDump::PrintHit(), lar_pandora::LArPandoraEventDump::PrintParticle(), lar_pandora::LArPandoraEventDump::PrintShower(), lar_pandora::LArPandoraEventDump::PrintSlice(), lar_pandora::LArPandoraEventDump::PrintSpacePoint(), lar_pandora::LArPandoraEventDump::PrintTrack(), lar_pandora::LArPandoraEventDump::PrintVertex(), apa::APAHitFinder::produce(), hit::HitCheater::produce(), caldata::CalWire::produce(), CRHitRemoval::produce(), caldata::CalWireT962::produce(), cosmic::TrackPFParticleMatch::produce(), cosmic::CosmicPFParticleTagger::produce(), shower::EMShower::produce(), cosmic::CosmicTrackTagger::produce(), cosmic::CosmicPCAxisTagger::produce(), vertex::PrimaryVertexFinder::produce(), shwf::ShowerReco::produce(), trkf::PMAlgTrajFitter::produce(), art::Ptr< T >::Ptr(), and trkf::KalmanFilterFinalTrackFitter::setMomValue().

{
  return key_;
}

template<typename T >

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

inlineexplicit

Definition at line 376 of file Ptr.h.

References art::Ptr< T >::isAvailable(), and art::Ptr< T >::isNonnull().

{
  return isNonnull() && isAvailable();
}

template<typename T >

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

inline

Definition at line 307 of file Ptr.h.

{
  return *get();
}

template<typename T >

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

inline

Definition at line 313 of file Ptr.h.

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

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

{
  getData_();
  return reinterpret_cast<T const*>(core_.productPtr());
}

template<typename T >

auto art::Ptr< T >::productGetter ( ) const

inline

Definition at line 383 of file Ptr.h.

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

Referenced by art::Ptr< T >::getData_().

{
  return core_.productGetter();
}

template<typename T >

auto art::Ptr< T >::refCore ( ) const

inline

Definition at line 370 of file Ptr.h.

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

Referenced by art::PtrVector< T >::assign(), art::Ptr< T >::getData_(), art::PtrVector< T >::insert(), and art::PtrVector< T >::push_back().

{
  return core_;
}

Member Data Documentation

template<typename T>

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

private

Definition at line 165 of file Ptr.h.

Referenced by art::Ptr< T >::getData_(), art::Ptr< T >::hasCache(), art::Ptr< T >::id(), art::Ptr< T >::isAvailable(), art::Ptr< T >::operator->(), art::Ptr< T >::productGetter(), art::Ptr< T >::Ptr(), and art::Ptr< T >::refCore().

template<typename T>

key_type art::Ptr< T >::key_ {key_traits<key_type>::value}

private

Definition at line 166 of file Ptr.h.

Referenced by art::Ptr< T >::getData_(), art::Ptr< T >::isNonnull(), art::Ptr< T >::key(), and art::Ptr< T >::Ptr().

---

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

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