art::ValidHandle< T > Class Template Reference

#include "Handle.h"

Classes
class	HandleTag

Public Types
typedef T	element_type

Public Member Functions
	ValidHandle ()=delete
	ValidHandle (T const *prod, Provenance prov)
	ValidHandle (ValidHandle const &)=default
ValidHandle &	operator= (ValidHandle const &)&=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
void	swap (ValidHandle< T > &other)

Private Attributes
T const *	prod_
Provenance	prov_

Detailed Description

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

Definition at line 48 of file Handle.h.

Member Typedef Documentation

template<typename T>

typedef T art::ValidHandle< T >::element_type

Definition at line 259 of file Handle.h.

Constructor & Destructor Documentation

template<typename T>

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

delete

template<class T >

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

explicit

Definition at line 293 of file Handle.h.

References art::errors::NullPointerError, and art::ValidHandle< T >::prov_.

  : prod_{prod}, 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

Member Function Documentation

template<class T >

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

inline

Definition at line 335 of file Handle.h.

{
  return false;
}

template<class T >

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

inline

Definition at line 349 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 328 of file Handle.h.

{
  return true;
}

template<class T >

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

inline

Definition at line 302 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 308 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 314 of file Handle.h.

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

{
  return prod_;
}

template<typename T>

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

default

template<class T >

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

inline

Definition at line 321 of file Handle.h.

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

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

{
  return prod_;
}

template<class T >

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

inline

Definition at line 342 of file Handle.h.

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

Referenced by art::DataViewImpl::getValidHandle().

{
  return &prov_;
}

template<class T >

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

inline

Definition at line 363 of file Handle.h.

References art::disjoint_ranges(), art::overlapping_ranges(), art::range_of_validity(), art::same_ranges(), art::swap(), art::detail::throw_if_invalid(), and fhicl::detail::atom::value().

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

template<class T >

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

inline

Definition at line 356 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 288 of file Handle.h.

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

template<typename T>

Provenance art::ValidHandle< T >::prov_

private

Definition at line 289 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