geo::details::plane_id_iterator_base< GEOID > Class Template Reference

Base forward iterator browsing all plane IDs in the detector. More...

#include <GeometryCore.h>

Inheritance diagram for geo::details::plane_id_iterator_base< GEOID >:

Public Types
using	ElementPtr_t = geo::PlaneGeo const *
using	GeoID_t = typename upper_iterator::GeoID_t
using	LocalID_t = geo::PlaneID
	type of the ID we change More...
using	iterator = plane_id_iterator_base< GeoID_t >
	type of this iterator More...
Iterator traits
using	difference_type = std::ptrdiff_t
using	value_type = LocalID_t
using	reference = value_type const &
using	pointer = value_type const *
using	iterator_category = std::input_iterator_tag

Public Member Functions
	plane_id_iterator_base ()
	Default constructor; effect not defined: assign to it before using! More...
	plane_id_iterator_base (geo::GeometryCore const *geom)
	Constructor: points to begin. More...
	plane_id_iterator_base (geo::GeometryCore const *geom, GeoID_t const &start_from)
	Constructor: points to the specified plane. More...
	plane_id_iterator_base (geo::GeometryCore const *geom, BeginPos_t const)
	Constructor: points to begin. More...
	plane_id_iterator_base (geo::GeometryCore const *geom, EndPos_t)
	Constructor: points to end. More...
template<typename OTHERID >
bool	operator== (plane_id_iterator_base< OTHERID > const &as) const
	Returns true if the two iterators point to the same plane. More...
template<typename OTHERID >
bool	operator!= (plane_id_iterator_base< OTHERID > const &as) const
	Returns true if the two iterators point to different planes. More...
reference	operator* () const
	Returns the PlaneID the iterator points to. More...
pointer	operator-> () const
	Returns the PlaneID the iterator points to. More...
iterator &	operator++ ()
	Prefix increment: returns this iterator pointing to the next plane. More...
iterator	operator++ (int)
	Postfix increment: returns the current iterator, then increments it. More...
	operator bool () const
	Returns whether the iterator is pointing to a valid plane. More...
ElementPtr_t	get () const
	Returns a pointer to plane, or nullptr if invalid. More...

Protected Types
using	ID_t = typename LocalID_t::PlaneID_t
	specific type for plane ID More...
Protected Types inherited from geo::details::TPC_id_iterator_base< GEOID >
using	ID_t = typename LocalID_t::TPCID_t
	specific type for TPC ID More...
using	ElementPtr_t = geo::TPCGeo const *
using	GeoID_t = typename upper_iterator::GeoID_t
using	LocalID_t = geo::TPCID
	type of the ID we change More...
using	iterator = TPC_id_iterator_base< GeoID_t >
	type of this iterator More...
using	difference_type = std::ptrdiff_t
using	value_type = LocalID_t
using	reference = value_type const &
using	pointer = value_type const *
using	iterator_category = std::input_iterator_tag
Protected Types inherited from geo::details::cryostat_id_iterator_base< GEOID >
using	ID_t = typename LocalID_t::CryostatID_t
using	ElementPtr_t = geo::CryostatGeo const *
using	GeoID_t = GEOID
	type of the actual ID stored in the iterator More...
using	iterator = cryostat_id_iterator_base< GeoID_t >
	this iterator More...
using	LocalID_t = geo::CryostatID
	type of the ID we change More...
using	difference_type = std::ptrdiff_t
using	value_type = LocalID_t
using	reference = value_type const &
using	pointer = value_type const *
using	iterator_category = std::input_iterator_tag

Protected Member Functions
	plane_id_iterator_base (geo::GeometryCore const *geom, UndefinedPos_t)
	Constructor: position undefined (meaning undefined local limits too) More...
LocalID_t const &	localID () const
	Returns the type of ID we act on. More...
void	next ()
	Skips to the next plane. More...
ID_t const &	local_index () const
	Returns the index (part if the ID) this iterator runs on. More...
Protected Member Functions inherited from geo::details::TPC_id_iterator_base< GEOID >
	TPC_id_iterator_base (geo::GeometryCore const *geom, UndefinedPos_t)
	Constructor: position undefined (meaning undefined local limits too) More...
LocalID_t const &	localID () const
	Returns the type of ID we act on. More...
void	next ()
	Skips to the next TPC. More...
ID_t const &	local_index () const
	Returns the index (part if the ID) this iterator runs on. More...
	TPC_id_iterator_base ()
	Default constructor; effect not defined: assign to it before using! More...
	TPC_id_iterator_base (geo::GeometryCore const *geom)
	Constructor: points to begin. More...
	TPC_id_iterator_base (geo::GeometryCore const *geom, GeoID_t const &start_from)
	Constructor: points to the specified TPC. More...
	TPC_id_iterator_base (geo::GeometryCore const *geom, BeginPos_t const)
	Constructor: points to begin. More...
	TPC_id_iterator_base (geo::GeometryCore const *geom, EndPos_t)
	Constructor: points to end. More...
template<typename OTHERID >
bool	operator== (TPC_id_iterator_base< OTHERID > const &as) const
	Returns true if the two iterators point to the same TPC. More...
template<typename OTHERID >
bool	operator!= (TPC_id_iterator_base< OTHERID > const &as) const
	Returns true if the two iterators point to different TPCs. More...
reference	operator* () const
	Returns the TPCID the iterator points to. More...
pointer	operator-> () const
	Returns the TPCID the iterator points to. More...
iterator &	operator++ ()
	Prefix increment: returns this iterator pointing to the next TPC. More...
iterator	operator++ (int)
	Postfix increment: returns the current iterator, then increments it. More...
	operator bool () const
	Returns whether the iterator is pointing to a valid TPC. More...
ElementPtr_t	get () const
	Returns a pointer to TPC, or nullptr if invalid. More...
Protected Member Functions inherited from geo::details::cryostat_id_iterator_base< GEOID >
	cryostat_id_iterator_base (geo::GeometryCore const *geom, UndefinedPos_t)
	Constructor: does not set the current ID. More...
void	next ()
	Skips to the next cryostat. More...
bool	at_end () const
	Returns whether this iterator has reached the end. More...
GeoID_t const &	ID () const
	Returns the actual type of ID we store. More...
GeoID_t &	ID ()
	cryostat_id_iterator_base ()
	Default constructor; effect not defined: assign to it before using! More...
	cryostat_id_iterator_base (geo::GeometryCore const *geom)
	Constructor: points to begin. More...
	cryostat_id_iterator_base (geo::GeometryCore const *geom, GeoID_t const &start_from)
	Constructor: points to the specified cryostat. More...
	cryostat_id_iterator_base (geo::GeometryCore const *geom, BeginPos_t const)
	Constructor: points to begin. More...
	cryostat_id_iterator_base (geo::GeometryCore const *geom, EndPos_t)
	Constructor: points to end. More...
template<typename OTHERID >
bool	operator== (cryostat_id_iterator_base< OTHERID > const &as) const
	Returns true if the two iterators point to the same cryostat. More...
template<typename OTHERID >
bool	operator!= (cryostat_id_iterator_base< OTHERID > const &as) const
	Returns true if the two iterators point to different cryostats. More...
reference	operator* () const
	Returns the ID the iterator points to. More...
pointer	operator-> () const
	Returns a pointer to the ID the iterator points to. More...
iterator &	operator++ ()
	Prefix increment: returns this iterator pointing to the next cryostat. More...
iterator	operator++ (int)
	Postfix increment: returns the current iterator, then increments it. More...
	operator bool () const
	Returns whether the iterator is pointing to a valid cryostat. More...
ElementPtr_t	get () const
	Returns a pointer to cryostat, or nullptr if invalid. More...
Protected Member Functions inherited from geo::details::geometry_iterator_base
geo::GeometryCore const *	geometry () const
	Returns a pointer to the geometry. More...
	geometry_iterator_base ()
	Default constructor; do not use a default-constructed iterator as-is! More...
	geometry_iterator_base (geo::GeometryCore const *geom)
	Constructor: associates with the specified geometry. More...

Private Types
using	upper_iterator = TPC_id_iterator_base< GEOID >

Private Member Functions
void	set_local_limits ()
	Sets limit to the past-the-end plane number of current TPC. More...
LocalID_t &	localID ()
	Returns the type of ID we act on (non-const version) More...
ID_t &	local_index ()
	Returns the index (part if the ID) this iterator runs on (non-const) More...

Private Attributes
ID_t	limit = LocalID_t::InvalidID
	maximum number of planes in the current TPC More...

Detailed Description

template<typename GEOID>
class geo::details::plane_id_iterator_base< GEOID >

Base forward iterator browsing all plane IDs in the detector.

Template Parameters

GEOID

ID type to be used

This iterator requires that GEOID is derived from geo::PlaneID. Note that no polymorphic behaviour is required, or expected, from GEOID.

This iterator is designed to carry on, untouched, anything else that the GEOID type defines beyond the required PlaneID data.

Note

A number of "local" methods are overloaded: since there is no polymorphism here and they are not virtual functions, these are designed not to replace the inherited methods except within the non-inherited and explicitly redefined methods.

Currently, backward iterations are not supported.

Definition at line 439 of file GeometryCore.h.

Member Typedef Documentation

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::difference_type = std::ptrdiff_t

Definition at line 469 of file GeometryCore.h.

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::ElementPtr_t = geo::PlaneGeo const*

Definition at line 446 of file GeometryCore.h.

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::GeoID_t = typename upper_iterator::GeoID_t

Definition at line 447 of file GeometryCore.h.

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::ID_t = typename LocalID_t::PlaneID_t

protected

specific type for plane ID

Definition at line 531 of file GeometryCore.h.

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::iterator = plane_id_iterator_base<GeoID_t>

type of this iterator

Definition at line 454 of file GeometryCore.h.

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::iterator_category = std::input_iterator_tag

Definition at line 473 of file GeometryCore.h.

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::LocalID_t = geo::PlaneID

type of the ID we change

Definition at line 449 of file GeometryCore.h.

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::pointer = value_type const*

Definition at line 472 of file GeometryCore.h.

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::reference = value_type const&

Definition at line 471 of file GeometryCore.h.

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::upper_iterator = TPC_id_iterator_base<GEOID>

private

Definition at line 443 of file GeometryCore.h.

template<typename GEOID>

using geo::details::plane_id_iterator_base< GEOID >::value_type = LocalID_t

Definition at line 470 of file GeometryCore.h.

Constructor & Destructor Documentation

template<typename GEOID>

geo::details::plane_id_iterator_base< GEOID >::plane_id_iterator_base ( )

inline

Default constructor; effect not defined: assign to it before using!

Definition at line 478 of file GeometryCore.h.

{}

template<typename GEOID>

geo::details::plane_id_iterator_base< GEOID >::plane_id_iterator_base ( geo::GeometryCore const *  geom )

inline

Constructor: points to begin.

Definition at line 481 of file GeometryCore.h.

                                                         :
        plane_id_iterator_base(geom, begin_pos) {}

template<typename GEOID>

geo::details::plane_id_iterator_base< GEOID >::plane_id_iterator_base ( geo::GeometryCore const *  geom, GeoID_t const &  start_from  )

inline

Constructor: points to the specified plane.

Definition at line 486 of file GeometryCore.h.

                                                                :
        upper_iterator(geom, start_from)
        { set_local_limits(); }

template<typename GEOID>

geo::details::plane_id_iterator_base< GEOID >::plane_id_iterator_base ( geo::GeometryCore const *  geom, BeginPos_t  const  )

inline

Constructor: points to begin.

Definition at line 491 of file GeometryCore.h.

                                                                           :
        upper_iterator(geom, begin_pos)
        { set_local_limits(); }

template<typename GEOID>

geo::details::plane_id_iterator_base< GEOID >::plane_id_iterator_base ( geo::GeometryCore const *  geom, EndPos_t    )

inline

Constructor: points to end.

Definition at line 496 of file GeometryCore.h.

                                                                   :
        upper_iterator(geom, end_pos)
        {} // the local limit is ill-defined and left invalid

template<typename GEOID>

geo::details::plane_id_iterator_base< GEOID >::plane_id_iterator_base ( geo::GeometryCore const *  geom, UndefinedPos_t    )

inlineprotected

Constructor: position undefined (meaning undefined local limits too)

Definition at line 534 of file GeometryCore.h.

                                                                         :
        upper_iterator(geom, undefined_pos)
        {}

Member Function Documentation

template<typename GEOID >

auto geo::details::plane_id_iterator_base< GEOID >::get ( ) const

inline

Returns a pointer to plane, or nullptr if invalid.

Definition at line 5913 of file GeometryCore.h.

  { return upper_iterator::geometry()->GetElementPtr(localID()); }

template<typename GEOID>

ID_t const& geo::details::plane_id_iterator_base< GEOID >::local_index ( ) const

inlineprotected

Returns the index (part if the ID) this iterator runs on.

Definition at line 550 of file GeometryCore.h.

{ return localID().Plane; }

template<typename GEOID>

ID_t& geo::details::plane_id_iterator_base< GEOID >::local_index ( )

inlineprivate

Returns the index (part if the ID) this iterator runs on (non-const)

Definition at line 564 of file GeometryCore.h.

{ return localID().Plane; }

template<typename GEOID>

LocalID_t const& geo::details::plane_id_iterator_base< GEOID >::localID ( ) const

inlineprotected

Returns the type of ID we act on.

Definition at line 541 of file GeometryCore.h.

        { return static_cast<LocalID_t const&>(upper_iterator::ID()); }

template<typename GEOID>

LocalID_t& geo::details::plane_id_iterator_base< GEOID >::localID ( )

inlineprivate

Returns the type of ID we act on (non-const version)

Definition at line 561 of file GeometryCore.h.

{ return static_cast<LocalID_t&>(ID()); }

template<typename GEOID >

void geo::details::plane_id_iterator_base< GEOID >::next ( )

inlineprotected

Skips to the next plane.

Definition at line 5924 of file GeometryCore.h.

                                                          {
  // if at end (checked in the inherited context), do nothing
  if (upper_iterator::at_end()) return;

  // if after incrementing we haven't reached the limit, we are done
  if (++local_index() < limit) return;

  // we reached the end of the current elements list, we need to escalate:
  // - go to the next parent; if that becomes invalid, too bad, but we go on
  upper_iterator::next();
  // - set the index to the first element of the new parent
  local_index() = 0;
  // - update how many elements there are
  //   (expect 0 if it is now at_end() -- and it does not even matter)
  set_local_limits();
} // geo::details::plane_id_iterator_base<GEOID>::next()

template<typename GEOID >

geo::details::plane_id_iterator_base< GEOID >::operator bool ( ) const

inline

Returns whether the iterator is pointing to a valid plane.

Definition at line 5906 of file GeometryCore.h.

                                                                    {
  return upper_iterator::geometry()
    && upper_iterator::geometry()->HasElement(localID());
} // geo::details::plane_id_iterator_base<>::operator bool()

template<typename GEOID>

template<typename OTHERID >

bool geo::details::plane_id_iterator_base< GEOID >::operator!= ( plane_id_iterator_base< OTHERID > const &  as ) const

inline

Returns true if the two iterators point to different planes.

Definition at line 508 of file GeometryCore.h.

        { return localID() != as.localID(); }

template<typename GEOID>

reference geo::details::plane_id_iterator_base< GEOID >::operator* ( ) const

inline

Returns the PlaneID the iterator points to.

Definition at line 512 of file GeometryCore.h.

{ return localID(); }

template<typename GEOID>

iterator& geo::details::plane_id_iterator_base< GEOID >::operator++ ( )

inline

Prefix increment: returns this iterator pointing to the next plane.

Definition at line 518 of file GeometryCore.h.

{ next(); return *this; }

template<typename GEOID>

iterator geo::details::plane_id_iterator_base< GEOID >::operator++ ( int  )

inline

Postfix increment: returns the current iterator, then increments it.

Definition at line 521 of file GeometryCore.h.

{ iterator old(*this); next(); return old; }

template<typename GEOID>

pointer geo::details::plane_id_iterator_base< GEOID >::operator-> ( ) const

inline

Returns the PlaneID the iterator points to.

Definition at line 515 of file GeometryCore.h.

{ return &(localID()); }

template<typename GEOID>

template<typename OTHERID >

bool geo::details::plane_id_iterator_base< GEOID >::operator== ( plane_id_iterator_base< OTHERID > const &  as ) const

inline

Returns true if the two iterators point to the same plane.

Definition at line 503 of file GeometryCore.h.

        { return localID() == as.localID(); }

template<typename GEOID >

void geo::details::plane_id_iterator_base< GEOID >::set_local_limits ( )

inlineprivate

Sets limit to the past-the-end plane number of current TPC.

Definition at line 5918 of file GeometryCore.h.

                                                                      {
  // limit is how many sibling planes there are
  limit = upper_iterator::geometry()->NSiblingElements(localID());
} // geo::details::plane_id_iterator_base<GEOID>::set_local_limits()

Member Data Documentation

template<typename GEOID>

ID_t geo::details::plane_id_iterator_base< GEOID >::limit = LocalID_t::InvalidID

private

maximum number of planes in the current TPC

Definition at line 555 of file GeometryCore.h.

---

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

• larcorealg/larcorealg/Geometry/GeometryCore.h