#include "PtrVectorBase.h"

Inheritance diagram for art::PtrVectorBase:

Public Types
using	key_type = unsigned long

using	indices_t = std::vector< key_type >

using	size_type = indices_t::size_type

Public Member Functions
virtual	~PtrVectorBase ()=default

bool	isNonnull () const noexcept

bool	isNull () const noexcept

bool	isAvailable () const

ProductID	id () const noexcept

EDProductGetter const *	productGetter () const noexcept

void	setProductGetter (EDProductGetter const *) noexcept

template<typename T >
art::Ptr< T >::key_type	key (Ptr< T > const &ptr) const noexcept

Protected Member Functions
	PtrVectorBase ()=default

void	clear ()

void	swap (PtrVectorBase &)

void	updateCore (RefCore const &core)

bool	operator== (PtrVectorBase const &) const noexcept

Private Member Functions
void	reserve (size_type n)

void	fillPtrs () const

template<typename T >
Ptr< T >::key_type	key (Ptr< T > const &ptr) const noexcept

virtual void	fill_offsets (indices_t &indices)=0

virtual void	fill_from_offsets (indices_t const &indices) const =0

virtual void	zeroTransients ()=0

Private Attributes
RefCore	core_

indices_t	indicies_

Friends
class	art::detail::PtrVectorBaseStreamer

Detailed Description

Definition at line 19 of file PtrVectorBase.h.

Member Typedef Documentation

using art::PtrVectorBase::indices_t = std::vector<key_type>

Definition at line 22 of file PtrVectorBase.h.

using art::PtrVectorBase::key_type = unsigned long

Definition at line 21 of file PtrVectorBase.h.

using art::PtrVectorBase::size_type = indices_t::size_type

Definition at line 23 of file PtrVectorBase.h.

Constructor & Destructor Documentation

virtual art::PtrVectorBase::~PtrVectorBase ( )

virtualdefault

art::PtrVectorBase::PtrVectorBase ( )

protecteddefault

Member Function Documentation

void art::PtrVectorBase::clear ( )

inlineprotected

Definition at line 98 of file PtrVectorBase.h.

References tmp.

Referenced by art::PtrVector< T >::assign(), and art::PtrVector< T >::clear().

 {
   core_ = RefCore{};
   indices_t tmp;
   indicies_.swap(tmp); // Free up memory
 }

virtual void art::PtrVectorBase::fill_from_offsets ( indices_t const & indices ) const

privatepure virtual

Implemented in art::PtrVector< T >, art::PtrVector< recob::Hit >, art::PtrVector< GenParticle >, art::PtrVector< recob::Vertex >, art::PtrVector< recob::Seed >, art::PtrVector< recob::Track >, and art::PtrVector< recob::EndPoint2D >.

Referenced by fillPtrs().

virtual void art::PtrVectorBase::fill_offsets ( indices_t & indices )

privatepure virtual

Implemented in art::PtrVector< T >, art::PtrVector< recob::Hit >, art::PtrVector< GenParticle >, art::PtrVector< recob::Vertex >, art::PtrVector< recob::Seed >, art::PtrVector< recob::Track >, and art::PtrVector< recob::EndPoint2D >.

void art::PtrVectorBase::fillPtrs ( ) const

private

Definition at line 5 of file PtrVectorBase.cc.

References fill_from_offsets(), indicies_, swap(), and tmp.

 {
   if (indicies_.size() == 0)
     return; // Empty or already done.
   fill_from_offsets(indicies_);
 
   using std::swap;
   indices_t tmp;
   swap(indicies_, tmp); // Zero -- finished with these.
 }

art::ProductID art::PtrVectorBase::id ( ) const

inlinenoexcept

Definition at line 80 of file PtrVectorBase.h.

Referenced by updateCore().

 {
   return core_.id();
 }

bool art::PtrVectorBase::isAvailable ( ) const

inline

Definition at line 74 of file PtrVectorBase.h.

 {
   return core_.isAvailable();
 }

bool art::PtrVectorBase::isNonnull ( ) const

inlinenoexcept

Definition at line 62 of file PtrVectorBase.h.

References art::RefCore::isNonnull().

 {
   return core_.isNonnull();
 }

bool art::PtrVectorBase::isNull ( ) const

inlinenoexcept

Definition at line 68 of file PtrVectorBase.h.

Referenced by updateCore().

 {
   return !isNonnull();
 }

template<typename T >

Ptr<T>::key_type art::PtrVectorBase::key ( Ptr< T > const & ptr ) const

privatenoexcept

template<typename T >

art::Ptr<T>::key_type art::PtrVectorBase::key ( Ptr< T > const & ptr ) const

inlinenoexcept

Definition at line 119 of file PtrVectorBase.h.

 {
   return ptr.key();
 }

bool art::PtrVectorBase::operator== ( PtrVectorBase const & other ) const

inlineprotectednoexcept

Definition at line 125 of file PtrVectorBase.h.

References fhicl::other.

Referenced by art::PtrVector< T >::operator==().

 {
   return core_ == other.core_;
 }

art::EDProductGetter const * art::PtrVectorBase::productGetter ( ) const

inlinenoexcept

Definition at line 86 of file PtrVectorBase.h.

Referenced by art::PtrVector< T >::fill_from_offsets().

 {
   return core_.productGetter();
 }

void art::PtrVectorBase::reserve ( size_type n )

inlineprivate

Definition at line 106 of file PtrVectorBase.h.

 {
   indicies_.reserve(n);
 }

void art::PtrVectorBase::setProductGetter ( EDProductGetter const * g )

inlinenoexcept

Definition at line 92 of file PtrVectorBase.h.

 {
   core_.setProductGetter(g);
 }

void art::PtrVectorBase::swap ( PtrVectorBase & other )

inlineprotected

Definition at line 112 of file PtrVectorBase.h.

References core_.

Referenced by fillPtrs(), and art::PtrVector< T >::swap().

 {
   core_.swap(other.core_);
 }

void art::PtrVectorBase::updateCore ( RefCore const & core )

protected

Definition at line 17 of file PtrVectorBase.cc.

References core_, id(), art::RefCore::id(), art::errors::InvalidReference, isNull(), art::RefCore::isNull(), art::RefCore::productGetter(), art::RefCore::productPtr(), art::RefCore::setProductGetter(), and art::RefCore::setProductPtr().

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

 {
   if (productToBeInserted.isNull()) {
     throw art::Exception(errors::InvalidReference, "Inconsistency")
       << "art::PtrVectorBase::updateCore: Ptr has invalid (zero) product ID,\n"
          "so it cannot be added to a PtrVector. id should be ("
       << id() << ")\n";
   }
   if (isNull()) {
     core_ = productToBeInserted;
     return;
   }
   if (core_.id() != productToBeInserted.id()) {
     throw art::Exception(errors::InvalidReference, "Inconsistency")
       << "art::PtrVectorBase::updateCore: Ptr is inconsistent with\n"
          "PtrVector. id = ("
       << productToBeInserted.id() << "), should be (" << core_.id() << ")\n";
   }
   if (core_.productGetter() == nullptr &&
       productToBeInserted.productGetter() != nullptr) {
     core_.setProductGetter(productToBeInserted.productGetter());
   }
   if (core_.productPtr() == nullptr &&
       productToBeInserted.productPtr() != nullptr) {
     core_.setProductPtr(productToBeInserted.productPtr());
   }
 }

virtual void art::PtrVectorBase::zeroTransients ( )

privatepure virtual

Implemented in art::PtrVector< T >, art::PtrVector< recob::Hit >, art::PtrVector< GenParticle >, art::PtrVector< recob::Vertex >, art::PtrVector< recob::Seed >, art::PtrVector< recob::Track >, and art::PtrVector< recob::EndPoint2D >.

Friends And Related Function Documentation

friend class art::detail::PtrVectorBaseStreamer

friend

Definition at line 58 of file PtrVectorBase.h.

Member Data Documentation

RefCore art::PtrVectorBase::core_

private

Definition at line 51 of file PtrVectorBase.h.

Referenced by swap(), and updateCore().

indices_t art::PtrVectorBase::indicies_

mutableprivate

Definition at line 52 of file PtrVectorBase.h.

Referenced by fillPtrs().

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

canvas/Persistency/Common/PtrVectorBase.h
canvas/Persistency/Common/PtrVectorBase.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation