art::ValidHandle< T > Class Template Reference

#include "Handle.h"

Classes
class	HandleTag

Public Types
using	element_type = T

Public Member Functions
	~ValidHandle ()=default
	ValidHandle ()=delete
	ValidHandle (T const *prod, EDProductGetter const *productGetter, Provenance prov)
	ValidHandle (ValidHandle const &)=default
	ValidHandle (ValidHandle &&)=default
ValidHandle &	operator= (ValidHandle const &)&=default
ValidHandle &	operator= (ValidHandle &&)&=default
	operator T const * () const
T const &	operator* () const
T const *	operator-> () const
T const *	product () const
bool	isValid () const
bool	failedToGet () const
Provenance const *	provenance () const
ProductID	id () const
std::shared_ptr< art::Exception const >	whyFailed () const
EDProductGetter const *	productGetter () const noexcept
void	swap (ValidHandle< T > &other)

Private Attributes
T const *	prod_
EDProductGetter const *	productGetter_
Provenance	prov_

Detailed Description

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

Definition at line 53 of file Handle.h.

Member Typedef Documentation

template<typename T>

using art::ValidHandle< T >::element_type = T

Definition at line 290 of file Handle.h.

Constructor & Destructor Documentation

template<typename T>

art::ValidHandle< T >::~ValidHandle ( )

default

template<typename T>

art::ValidHandle< T >::ValidHandle ( )

delete

template<class T >

art::ValidHandle< T >::ValidHandle ( T const *  prod, EDProductGetter const *  productGetter, Provenance  prov  )

explicit

Definition at line 330 of file Handle.h.

References art::errors::NullPointerError, art::ValidHandle< T >::prod_, art::ValidHandle< T >::productGetter(), art::ValidHandle< T >::productGetter_, and art::ValidHandle< T >::prov_.

  : prod_{prod}, productGetter_{productGetter}, prov_{prov}
{
  if (prod_ == nullptr) {
    throw Exception(art::errors::NullPointerError)
      << "Attempt to create ValidHandle with null pointer";
  }
}

template<typename T>

art::ValidHandle< T >::ValidHandle ( ValidHandle< T > const &  )

default

template<typename T>

art::ValidHandle< T >::ValidHandle ( ValidHandle< T > &&  )

default

Member Function Documentation

template<class T >

bool art::ValidHandle< T >::failedToGet ( ) const

inline

Definition at line 377 of file Handle.h.

{
  return false;
}

template<class T >

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

inline

Definition at line 391 of file Handle.h.

References art::Provenance::productID(), and art::ValidHandle< T >::prov_.

{
  return prov_.productID();
}

template<class T >

bool art::ValidHandle< T >::isValid ( ) const

inline

Definition at line 370 of file Handle.h.

{
  return true;
}

template<class T >

art::ValidHandle< T >::operator T const * ( ) const

inline

Definition at line 342 of file Handle.h.

References art::ValidHandle< T >::prod_.

{
  return prod_;
}

template<class T >

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

inline

Definition at line 349 of file Handle.h.

References art::ValidHandle< T >::prod_.

{
  return *prod_;
}

template<class T >

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

inline

Definition at line 356 of file Handle.h.

References art::ValidHandle< T >::prod_.

{
  return prod_;
}

template<typename T>

ValidHandle& art::ValidHandle< T >::operator= ( ValidHandle< T > const &  )

default

template<typename T>

ValidHandle& art::ValidHandle< T >::operator= ( ValidHandle< T > &&  )

default

template<class T >

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

inline

Definition at line 363 of file Handle.h.

References art::ValidHandle< T >::prod_.

Referenced by sim::DumpMCTruth::analyze(), sim::DumpGTruth::analyze(), and art::ProductRetriever::getValidHandle().

{
  return prod_;
}

template<typename T >

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

inlinenoexcept

Definition at line 412 of file Handle.h.

References art::disjoint_ranges(), art::overlapping_ranges(), art::ValidHandle< T >::productGetter_, art::range_of_validity(), art::same_ranges(), and art::detail::throw_if_invalid().

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

{
  return productGetter_;
}

template<class T >

art::Provenance const * art::ValidHandle< T >::provenance ( ) const

inline

Definition at line 384 of file Handle.h.

References art::ValidHandle< T >::prov_.

{
  return &prov_;
}

template<class T >

void art::ValidHandle< T >::swap ( art::ValidHandle< T > &  other )

inline

Definition at line 405 of file Handle.h.

References art::swap().

{
  std::swap(*this, other);
}

template<class T >

std::shared_ptr< art::Exception const > art::ValidHandle< T >::whyFailed ( ) const

inline

Definition at line 398 of file Handle.h.

{
  return std::shared_ptr<art::Exception const>();
}

Member Data Documentation

template<typename T>

T const* art::ValidHandle< T >::prod_

private

Definition at line 324 of file Handle.h.

Referenced by art::ValidHandle< T >::operator T const *(), art::ValidHandle< T >::operator*(), art::ValidHandle< T >::operator->(), art::ValidHandle< T >::product(), and art::ValidHandle< T >::ValidHandle().

template<typename T>

EDProductGetter const* art::ValidHandle< T >::productGetter_

private

Definition at line 325 of file Handle.h.

Referenced by art::ValidHandle< T >::productGetter(), and art::ValidHandle< T >::ValidHandle().

template<typename T>

Provenance art::ValidHandle< T >::prov_

private

Definition at line 326 of file Handle.h.

Referenced by art::ValidHandle< T >::id(), art::ValidHandle< T >::provenance(), and art::ValidHandle< T >::ValidHandle().

---

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

• art/Framework/Principal/Handle.h