proxy::details::assns_node_iterator< ArtAssnsIter > Class Template Reference

#include "AssociatedData.h"

Inheritance diagram for proxy::details::assns_node_iterator< ArtAssnsIter >:

Public Types
using	iterator = assns_node_iterator< ArtAssnsIter >
Iterator traits
!< The type of base iterator wrapper.
using	value_type = AssnsIterTraits< ArtAssnsIter >::node_t
using	pointer = std::add_pointer_t< value_type >
using	reference = std::add_lvalue_reference_t< value_type >
using	iterator_category = std::forward_iterator_tag

Public Member Functions
	assns_node_iterator (base_iterator_t const &from)
	Constructor from a base iterator (explicitly allowed). More...
AssnsNode_t const &	info () const
	Returns the full information the iterator points to. More...
AssnsNode_t const &	operator() () const
	Returns the full information the iterator points to. More...
iterator &	operator++ ()
	Prefix increment operator. More...
bool	operator!= (data_iterator_t const &other) const
	Comparison with a data iterator (makes unnecessary to wrap end iterators). More...
bool	operator!= (iterator const &other) const
	Comparison with another iterator. More...
auto	operator[] (std::size_t index) const -> decltype(auto)
auto	operator* () const -> decltype(auto)
	Dereference operator; need to be redefined by derived classes. More...
auto	operator-> () const -> decltype(auto)
	Dereference operator; need to be redefined by derived classes. More...

Static Public Member Functions
static AssnsNode_t const &	transform (art_assns_iter_t const &v)

Protected Types
using	data_iterator_t = ArtAssnsIter

Protected Member Functions
data_iterator_t const &	asDataIterator () const

Private Types
using	base_iterator_t = IteratorWrapperBase< assns_node_iterator< ArtAssnsIter >, ArtAssnsIter, typename AssnsIterTraits< ArtAssnsIter >::node_t >
using	art_assns_iter_t = ArtAssnsIter
using	traits_t = AssnsIterTraits< art_assns_iter_t >
using	AssnsNode_t = typename traits_t::node_t
	Type of node for this association iterator. More...
using	ArtAssnsNode_t = typename traits_t::art_node_t

Access to the full association information
This interface is a replica of the one of AssnsNode_t.
using	main_t = typename AssnsNode_t::main_t
	Returns the art pointer to the associated value. More...
using	value_t = typename AssnsNode_t::value_t
	Returns the art pointer to the associated value. More...
using	data_t = typename AssnsNode_t::data_t
	Returns the art pointer to the associated value. More...
using	mainptr_t = typename AssnsNode_t::mainptr_t
	Returns the art pointer to the associated value. More...
using	valueptr_t = typename AssnsNode_t::valueptr_t
	Returns the art pointer to the associated value. More...
using	dataptr_t = typename AssnsNode_t::dataptr_t
	Returns the art pointer to the associated value. More...
valueptr_t	valuePtr () const
	Returns the art pointer to the associated value. More...
value_t const &	value () const
	Returns the art pointer to the associated value. More...
mainptr_t	mainPtr () const
	Returns the art pointer to the main value, key of the association. More...
main_t const &	main () const
	Returns the main value, key of the association. More...
template<typename ArtNode = ArtAssnsNode_t>
std::enable_if_t< hasMetadata< ArtNode >), dataptr_t >	dataPtr () const
	Returns the pointer to the metadata on this association node. More...
template<typename ArtNode = ArtAssnsNode_t>
std::enable_if_t< hasMetadata< ArtNode >), typename lar::util::assns_traits< ArtNode >::data_t const & >	data () const
	Returns a reference to the metadata on this association node. More...
template<typename Node = AssnsNode_t>
static constexpr bool	hasMetadata ()
	Returns whether this node type supports metadata. More...

Detailed Description

template<typename ArtAssnsIter>
class proxy::details::assns_node_iterator< ArtAssnsIter >

Modified iterator returning a association node interface. The basic iterator interface is to the associated (right) art pointer.

Definition at line 397 of file AssociatedData.h.

Member Typedef Documentation

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::art_assns_iter_t = ArtAssnsIter

private

Definition at line 410 of file AssociatedData.h.

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::ArtAssnsNode_t = typename traits_t::art_node_t

private

Definition at line 415 of file AssociatedData.h.

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::AssnsNode_t = typename traits_t::node_t

private

Type of node for this association iterator.

Definition at line 414 of file AssociatedData.h.

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::base_iterator_t = IteratorWrapperBase< assns_node_iterator<ArtAssnsIter>, ArtAssnsIter, typename AssnsIterTraits<ArtAssnsIter>::node_t >

private

Definition at line 408 of file AssociatedData.h.

using proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::data_iterator_t = ArtAssnsIter

protectedinherited

Definition at line 105 of file AssociatedData.h.

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::data_t = typename AssnsNode_t::data_t

Returns the art pointer to the associated value.

Definition at line 437 of file AssociatedData.h.

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::dataptr_t = typename AssnsNode_t::dataptr_t

Returns the art pointer to the associated value.

Definition at line 440 of file AssociatedData.h.

using proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::iterator = assns_node_iterator< ArtAssnsIter >

inherited

Definition at line 108 of file AssociatedData.h.

using proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::iterator_category = std::forward_iterator_tag

inherited

Definition at line 116 of file AssociatedData.h.

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::main_t = typename AssnsNode_t::main_t

Returns the art pointer to the associated value.

Definition at line 435 of file AssociatedData.h.

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::mainptr_t = typename AssnsNode_t::mainptr_t

Returns the art pointer to the associated value.

Definition at line 438 of file AssociatedData.h.

using proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::pointer = std::add_pointer_t<value_type>

inherited

Definition at line 114 of file AssociatedData.h.

using proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::reference = std::add_lvalue_reference_t<value_type>

inherited

Definition at line 115 of file AssociatedData.h.

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::traits_t = AssnsIterTraits<art_assns_iter_t>

private

Definition at line 411 of file AssociatedData.h.

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::value_t = typename AssnsNode_t::value_t

Returns the art pointer to the associated value.

Definition at line 436 of file AssociatedData.h.

using proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::value_type = AssnsIterTraits< ArtAssnsIter >::node_t

inherited

Definition at line 113 of file AssociatedData.h.

template<typename ArtAssnsIter >

using proxy::details::assns_node_iterator< ArtAssnsIter >::valueptr_t = typename AssnsNode_t::valueptr_t

Returns the art pointer to the associated value.

Definition at line 439 of file AssociatedData.h.

Constructor & Destructor Documentation

template<typename ArtAssnsIter >

proxy::details::assns_node_iterator< ArtAssnsIter >::assns_node_iterator ( base_iterator_t const &  from )

inline

Constructor from a base iterator (explicitly allowed).

Definition at line 421 of file AssociatedData.h.

        : base_iterator_t(from) {}

Member Function Documentation

data_iterator_t const& proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::asDataIterator ( ) const

inlineprotectedinherited

Definition at line 154 of file AssociatedData.h.

        { return static_cast<data_iterator_t const&>(*this); }

template<typename ArtAssnsIter >

template<typename ArtNode = ArtAssnsNode_t>

std::enable_if_t< hasMetadata<ArtNode>), typename lar::util::assns_traits<ArtNode>::data_t const& > proxy::details::assns_node_iterator< ArtAssnsIter >::data ( ) const

inline

Returns a reference to the metadata on this association node.

Definition at line 471 of file AssociatedData.h.

        { return info().data(); }

template<typename ArtAssnsIter >

template<typename ArtNode = ArtAssnsNode_t>

std::enable_if_t<hasMetadata<ArtNode>), dataptr_t> proxy::details::assns_node_iterator< ArtAssnsIter >::dataPtr ( ) const

inline

Returns the pointer to the metadata on this association node.

Definition at line 462 of file AssociatedData.h.

        { return info().dataPtr(); }

template<typename ArtAssnsIter >

template<typename Node = AssnsNode_t>

static constexpr bool proxy::details::assns_node_iterator< ArtAssnsIter >::hasMetadata ( )

inlinestatic

Returns whether this node type supports metadata.

Definition at line 457 of file AssociatedData.h.

        { return lar::util::assns_has_metadata_v<Node>; }

template<typename ArtAssnsIter >

AssnsNode_t const& proxy::details::assns_node_iterator< ArtAssnsIter >::info ( ) const

inline

Returns the full information the iterator points to.

Definition at line 425 of file AssociatedData.h.

References operator*().

{ return base_iterator_t::operator*(); }

template<typename ArtAssnsIter >

main_t const& proxy::details::assns_node_iterator< ArtAssnsIter >::main ( ) const

inline

Returns the main value, key of the association.

Definition at line 452 of file AssociatedData.h.

{ return info().main(); }

template<typename ArtAssnsIter >

mainptr_t proxy::details::assns_node_iterator< ArtAssnsIter >::mainPtr ( ) const

inline

Returns the art pointer to the main value, key of the association.

Definition at line 449 of file AssociatedData.h.

{ return info().mainPtr(); }

bool proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::operator!= ( data_iterator_t const &  other ) const

inlineinherited

Comparison with a data iterator (makes unnecessary to wrap end iterators).

Definition at line 130 of file AssociatedData.h.

References proxy::details::IteratorWrapperBase< Iter, DataIter, ValueType >::asDataIterator().

        { return other != asDataIterator(); }

bool proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::operator!= ( iterator const &  other ) const

inlineinherited

Comparison with another iterator.

Definition at line 134 of file AssociatedData.h.

References proxy::details::IteratorWrapperBase< Iter, DataIter, ValueType >::asDataIterator(), and proxy::details::IteratorWrapperBase< Iter, DataIter, ValueType >::operator!=().

        { return operator!=(other.asDataIterator()); }

template<typename ArtAssnsIter >

AssnsNode_t const& proxy::details::assns_node_iterator< ArtAssnsIter >::operator() ( ) const

inline

Returns the full information the iterator points to.

Definition at line 428 of file AssociatedData.h.

{ return info(); }

auto proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::operator* ( ) const-> decltype(auto)

inlineinherited

Dereference operator; need to be redefined by derived classes.

Definition at line 141 of file AssociatedData.h.

References proxy::details::IteratorWrapperBase< Iter, DataIter, ValueType >::asDataIterator(), and proxy::details::IteratorWrapperBase< Iter, DataIter, ValueType >::asIterator().

        { return asIterator().transform(asDataIterator()); }

iterator& proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::operator++ ( )

inlineinherited

Prefix increment operator.

Definition at line 126 of file AssociatedData.h.

References proxy::details::IteratorWrapperBase< Iter, DataIter, ValueType >::asIterator().

        { data_iterator_t::operator++(); return asIterator(); }

auto proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::operator-> ( ) const-> decltype(auto)

inlineinherited

Dereference operator; need to be redefined by derived classes.

Definition at line 145 of file AssociatedData.h.

References proxy::details::IteratorWrapperBase< Iter, DataIter, ValueType >::makeValuePointer().

        { return makeValuePointer(operator*()); }

auto proxy::details::IteratorWrapperBase< assns_node_iterator< ArtAssnsIter > , ArtAssnsIter , AssnsIterTraits< ArtAssnsIter >::node_t >::operator[] ( std::size_t  index ) const-> decltype(auto)

inlineinherited

Definition at line 137 of file AssociatedData.h.

References proxy::details::IteratorWrapperBase< Iter, DataIter, ValueType >::asDataIterator(), and proxy::details::IteratorWrapperBase< Iter, DataIter, ValueType >::asIterator().

        { return asIterator().transform(asDataIterator() + index); }

template<typename ArtAssnsIter >

static AssnsNode_t const& proxy::details::assns_node_iterator< ArtAssnsIter >::transform ( art_assns_iter_t const &  v )

inlinestatic

Definition at line 494 of file AssociatedData.h.

References proxy::details::makeAssnsNode().

        { return makeAssnsNode(*v); }

template<typename ArtAssnsIter >

value_t const& proxy::details::assns_node_iterator< ArtAssnsIter >::value ( ) const

inline

Returns the art pointer to the associated value.

Definition at line 446 of file AssociatedData.h.

{ return info().value(); }

template<typename ArtAssnsIter >

valueptr_t proxy::details::assns_node_iterator< ArtAssnsIter >::valuePtr ( ) const

inline

Returns the art pointer to the associated value.

Definition at line 443 of file AssociatedData.h.

{ return info().valuePtr(); }

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/RecoBaseProxy/ProxyBase/AssociatedData.h