#include "Handle.h"

Inheritance diagram for art::Wrapper< T >:

Public Member Functions
	Wrapper ()=default

	Wrapper (std::unique_ptr< T > ptr)

virtual	~Wrapper ()=default

T const *	product () const

T const *	operator-> () const

bool	isPresent () const

virtual std::type_info const *	typeInfo () const

void const *	getElementAddress (std::type_info const &toType, unsigned long index) const

std::vector< void const * >	getElementAddresses (std::type_info const &toType, std::vector< unsigned long > const &indices) const

product_typeids_t	getTypeIDs () const

std::unique_ptr< EDProduct >	makePartner (std::type_info const &wanted_type) const

unsigned	getRangeSetID () const

void	setRangeSetID (unsigned const id)

void	combine (EDProduct *p)

std::unique_ptr< EDProduct >	createEmptySampledProduct (InputTag const &tag) const

void	insertIfSampledProduct (std::string const &dataset, SubRunID const &id, std::unique_ptr< EDProduct > product)

Static Public Member Functions
static short	Class_Version ()

Private Member Functions
std::vector< void const * >	getView () const override

std::string	productSize () const override

product_typeids_t	do_getTypeIDs () const override

std::unique_ptr< EDProduct >	do_makePartner (std::type_info const &wanted_type) const override

unsigned	do_getRangeSetID () const override

void	do_setRangeSetID (unsigned) override

void	do_combine (EDProduct const *product) override

std::unique_ptr< EDProduct >	do_createEmptySampledProduct (InputTag const &tag) const override

void	do_insertIfSampledProduct (std::string const &dataset, SubRunID const &id, std::unique_ptr< EDProduct > product) override

bool	isPresent_ () const override

std::type_info const *	typeInfo_ () const override

void const *	do_getElementAddress (std::type_info const &toType, unsigned long index) const override

std::vector< void const * >	do_getElementAddresses (std::type_info const &toType, std::vector< unsigned long > const &indices) const override

T &&	refOrThrow (T *ptr)

Private Attributes
bool	present {false}

unsigned	rangeSetID {-1u}

T	obj {}

Friends
template<typename >
struct	prevent_recursion

Detailed Description

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

Definition at line 66 of file Handle.h.

Constructor & Destructor Documentation

template<typename T>

art::Wrapper< T >::Wrapper ( )

default

template<typename T >

art::Wrapper< T >::Wrapper ( std::unique_ptr< T > ptr )

explicit

Definition at line 161 of file Wrapper.h.

References art::Wrapper< T >::obj, art::Wrapper< T >::rangeSetID, and art::Wrapper< T >::refOrThrow().

162 : present{ptr.get() != nullptr}, rangeSetID{-1u}, obj(refOrThrow(ptr.get()))

163 {}

art::Wrapper::obj

T obj

Definition: Wrapper.h:136

art::Wrapper::rangeSetID

unsigned rangeSetID

Definition: Wrapper.h:135

art::Wrapper::present

bool present

Definition: Wrapper.h:134

art::Wrapper::refOrThrow

T && refOrThrow(T *ptr)

Definition: Wrapper.h:366

template<typename T>

virtual art::Wrapper< T >::~Wrapper ( )

virtualdefault

Member Function Documentation

template<typename T>

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

inlinestatic

Definition at line 91 of file Wrapper.h.

   {
     return 11;
   }

void art::EDProduct::combine ( EDProduct * p )

inlineinherited

Definition at line 79 of file EDProduct.h.

References art::EDProduct::do_combine().

   {
     do_combine(p);
   }

std::unique_ptr<EDProduct> art::EDProduct::createEmptySampledProduct ( InputTag const & tag ) const

inlineinherited

Definition at line 85 of file EDProduct.h.

References art::EDProduct::do_createEmptySampledProduct().

   {
     return do_createEmptySampledProduct(tag);
   }

template<typename T >

void art::Wrapper< T >::do_combine ( art::EDProduct const * p )

overrideprivatevirtual

Implements art::EDProduct.

Definition at line 207 of file Wrapper.h.

References art::detail::CanBeAggregated< T, Enable >::aggregate(), art::EDProduct::isPresent(), art::Wrapper< T >::obj, and art::Wrapper< T >::present.

 {
   if (!p->isPresent())
     return;
 
   auto wp = static_cast<Wrapper<T> const*>(p);
   detail::CanBeAggregated<T>::aggregate(obj, *wp->product());
 
   // The presence for the combined product is 'true', if we get this
   // far.
   present = true;
 }

template<typename T >

std::unique_ptr< art::EDProduct > art::Wrapper< T >::do_createEmptySampledProduct ( InputTag const & tag ) const

overrideprivatevirtual

Implements art::EDProduct.

Definition at line 307 of file Wrapper.h.

References art::prevent_recursion< T >::create_empty_sampled_product().

 {
   return prevent_recursion<T>::create_empty_sampled_product(tag);
 }

template<typename T>

void const * art::Wrapper< T >::do_getElementAddress	(	std::type_info const &	toType,
		unsigned long	index
	)		const

inlineoverrideprivatevirtual

Implements art::EDProduct.

Definition at line 324 of file Wrapper.h.

References art::Wrapper< T >::obj, art::errors::ProductDoesNotSupportPtr, and art::setPtr().

 {
   if constexpr (has_setPtr<T>::value) {
     // Allow setPtr customizations by introducing the art::setPtr
     // overload set, and not requiring art::setPtr(...).
     using art::setPtr;
     void const* result{nullptr};
     setPtr(obj, toType, index, result);
     return result;
   } else {
     throw Exception{errors::ProductDoesNotSupportPtr}
       << "The product type " << cet::demangle_symbol(typeid(T).name())
       << " does not support art::Ptr\n";
   }
 }

template<typename T >

std::vector< void const * > art::Wrapper< T >::do_getElementAddresses	(	std::type_info const &	toType,
		std::vector< unsigned long > const &	indices
	)		const

inlineoverrideprivatevirtual

Implements art::EDProduct.

Definition at line 344 of file Wrapper.h.

References art::getElementAddresses(), art::EDProduct::getElementAddresses(), art::Wrapper< T >::obj, and art::errors::ProductDoesNotSupportPtr.

 {
   if constexpr (has_setPtr<T>::value) {
     // getElementAddresses is the name of an overload set; each
     // concrete collection T should supply a getElementAddresses
     // function, in the same namespace at that in which T is
     // defined, or in the 'art' namespace.
     using art::getElementAddresses;
     std::vector<void const*> result;
     getElementAddresses(obj, toType, indices, result);
     return result;
   } else {
     throw Exception{errors::ProductDoesNotSupportPtr}
       << "The product type " << cet::demangle_symbol(typeid(T).name())
       << " does not support art::PtrVector\n";
   }
 }

template<typename T >

unsigned art::Wrapper< T >::do_getRangeSetID ( ) const

overrideprivatevirtual

Implements art::EDProduct.

Definition at line 229 of file Wrapper.h.

References art::Wrapper< T >::rangeSetID.

 {
   return rangeSetID;
 }

template<typename T >

art::product_typeids_t art::Wrapper< T >::do_getTypeIDs ( ) const

overrideprivatevirtual

Implements art::EDProduct.

Definition at line 236 of file Wrapper.h.

References art::detail::ProductTypeIDs< T >::get().

 {
   return detail::ProductTypeIDs<T>::get();
 }

template<typename T >

void art::Wrapper< T >::do_insertIfSampledProduct	(	std::string const &	dataset,
		SubRunID const &	id,
		std::unique_ptr< EDProduct >	product
	)

overrideprivatevirtual

Implements art::EDProduct.

Definition at line 314 of file Wrapper.h.

References art::prevent_recursion< T >::insert_if_sampled_product(), and art::Wrapper< T >::obj.

 {
   prevent_recursion<T>::insert_if_sampled_product(
     obj, dataset, id, std::move(product));
 }

template<typename T >

std::unique_ptr< art::EDProduct > art::Wrapper< T >::do_makePartner ( std::type_info const & wanted_type ) const

overrideprivatevirtual

Implements art::EDProduct.

Definition at line 243 of file Wrapper.h.

References art::errors::LogicError, and art::Wrapper< T >::obj.

 {
   std::unique_ptr<art::EDProduct> retval;
   if constexpr (detail::has_makePartner_member<T>::value) {
     retval = obj.makePartner(wanted_wrapper);
   } else {
     throw Exception{errors::LogicError, "makePartner"}
       << "Attempted to make partner of a product ("
       << cet::demangle_symbol(typeid(T).name()) << ") that does not know how!\n"
       << "Please report to the art framework developers.\n";
   }
   return retval;
 }

template<typename T >

void art::Wrapper< T >::do_setRangeSetID ( unsigned id )

overrideprivatevirtual

Implements art::EDProduct.

Definition at line 222 of file Wrapper.h.

References art::Wrapper< T >::rangeSetID.

 {
   rangeSetID = id;
 }

void const * EDProduct::getElementAddress	(	std::type_info const &	toType,
		unsigned long	index
	)		const

inherited

Definition at line 27 of file EDProduct.cc.

References art::EDProduct::do_getElementAddress().

Referenced by art::EDProduct::isPresent(), and art::Ptr< L >::operator->().

 {
   return do_getElementAddress(toType, index);
 }

std::vector< void const * > EDProduct::getElementAddresses	(	std::type_info const &	toType,
		std::vector< unsigned long > const &	indices
	)		const

inherited

Definition at line 34 of file EDProduct.cc.

References art::EDProduct::do_getElementAddresses().

Referenced by art::Wrapper< T >::do_getElementAddresses(), and art::EDProduct::isPresent().

 {
   return do_getElementAddresses(toType, indices);
 }

unsigned art::EDProduct::getRangeSetID ( ) const

inlineinherited

Definition at line 67 of file EDProduct.h.

References art::EDProduct::do_getRangeSetID().

   {
     return do_getRangeSetID();
   }

product_typeids_t art::EDProduct::getTypeIDs ( ) const

inlineinherited

Definition at line 55 of file EDProduct.h.

References art::EDProduct::do_getTypeIDs().

   {
     return do_getTypeIDs();
   }

template<typename T >

std::vector< void const * > art::Wrapper< T >::getView ( ) const

overrideprivatevirtual

Reimplemented from art::EDProduct.

Definition at line 188 of file Wrapper.h.

References art::CannotGetView< T >::get(), and art::Wrapper< T >::obj.

 {
   return MaybeGetView<T>::get(obj);
 }

void art::EDProduct::insertIfSampledProduct	(	std::string const &	dataset,
		SubRunID const &	id,
		std::unique_ptr< EDProduct >	product
	)

inlineinherited

Definition at line 91 of file EDProduct.h.

References art::EDProduct::do_combine(), art::EDProduct::do_createEmptySampledProduct(), art::EDProduct::do_getElementAddress(), art::EDProduct::do_getElementAddresses(), art::EDProduct::do_getRangeSetID(), art::EDProduct::do_getTypeIDs(), art::EDProduct::do_insertIfSampledProduct(), art::EDProduct::do_makePartner(), art::EDProduct::do_setRangeSetID(), art::EDProduct::isPresent_(), and art::EDProduct::typeInfo_().

   {
     return do_insertIfSampledProduct(dataset, id, std::move(product));
   }

bool art::EDProduct::isPresent ( ) const

inlineinherited

Definition at line 31 of file EDProduct.h.

References art::EDProduct::getElementAddress(), art::EDProduct::getElementAddresses(), art::EDProduct::getView(), geo::vect::indices(), art::EDProduct::isPresent_(), and art::EDProduct::typeInfo().

Referenced by art::Wrapper< T >::do_combine(), and art::FileDumperOutput::printPrincipal().

   {
     return isPresent_();
   }

template<typename T>

bool art::Wrapper< T >::isPresent_ ( ) const

inlineoverrideprivatevirtual

Implements art::EDProduct.

Definition at line 119 of file Wrapper.h.

References geo::vect::indices(), and art::productstatus::present().

   {
     return present;
   }

std::unique_ptr<EDProduct> art::EDProduct::makePartner ( std::type_info const & wanted_type ) const

inlineinherited

Definition at line 61 of file EDProduct.h.

References art::EDProduct::do_makePartner().

   {
     return do_makePartner(wanted_type);
   }

template<typename T >

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

Definition at line 174 of file Wrapper.h.

References art::Wrapper< T >::product().

 {
   return product();
 }

template<typename T >

T const * art::Wrapper< T >::product ( ) const

Definition at line 167 of file Wrapper.h.

References art::Wrapper< T >::obj, and art::Wrapper< T >::present.

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

 {
   return present ? &obj : nullptr;
 }

template<typename T >

std::string art::Wrapper< T >::productSize ( ) const

overrideprivatevirtual

Reimplemented from art::EDProduct.

Definition at line 195 of file Wrapper.h.

References art::Wrapper< T >::obj, art::to_string(), and util::to_string().

 {
   if constexpr (detail::has_size_member<T>::value) {
     using std::to_string;
     return to_string(obj.size());
   } else {
     return "-";
   }
 }

template<typename T >

T && art::Wrapper< T >::refOrThrow ( T * ptr )

inlineprivate

Definition at line 366 of file Wrapper.h.

References art::errors::NullPointerError.

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

 {
   if (ptr) {
     return std::move(*ptr);
   }
   throw Exception(errors::NullPointerError)
     << "Attempt to construct " << cet::demangle_symbol(typeid(*this).name())
     << " from nullptr.\n";
 }

void art::EDProduct::setRangeSetID ( unsigned const id )

inlineinherited

Definition at line 73 of file EDProduct.h.

References art::EDProduct::do_setRangeSetID().

   {
     do_setRangeSetID(id);
   }

std::type_info const * EDProduct::typeInfo ( ) const

virtualinherited

Definition at line 21 of file EDProduct.cc.

References art::EDProduct::typeInfo_().

Referenced by art::EDProduct::isPresent().

 {
   return typeInfo_();
 }

template<typename T >

std::type_info const * art::Wrapper< T >::typeInfo_ ( ) const

overrideprivatevirtual

Implements art::EDProduct.

Definition at line 181 of file Wrapper.h.

References art::SupportsView< T, typename >::type_id().

 {
   return SupportsView<T>::type_id();
 }

Friends And Related Function Documentation

template<typename T>

template<typename >

friend struct prevent_recursion

friend

Definition at line 112 of file Wrapper.h.

Member Data Documentation

template<typename T>

T art::Wrapper< T >::obj {}

private

Definition at line 136 of file Wrapper.h.

Referenced by art::Wrapper< T >::do_combine(), art::Wrapper< T >::do_getElementAddress(), art::Wrapper< T >::do_getElementAddresses(), art::Wrapper< T >::do_insertIfSampledProduct(), art::Wrapper< T >::do_makePartner(), art::Wrapper< T >::getView(), art::Wrapper< T >::product(), art::Wrapper< T >::productSize(), and art::Wrapper< T >::Wrapper().

template<typename T>

bool art::Wrapper< T >::present {false}

private

Definition at line 134 of file Wrapper.h.

Referenced by art::Wrapper< T >::do_combine(), and art::Wrapper< T >::product().

template<typename T>

unsigned art::Wrapper< T >::rangeSetID {-1u}

private

Definition at line 135 of file Wrapper.h.

Referenced by art::Wrapper< T >::do_getRangeSetID(), art::Wrapper< T >::do_setRangeSetID(), and art::Wrapper< T >::Wrapper().

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

art/Framework/Principal/Handle.h
canvas/Persistency/Common/Wrapper.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

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