LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
geo::details::wire_id_iterator_base< GEOID > Class Template Reference

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

#include "GeometryCore.h"

Inheritance diagram for geo::details::wire_id_iterator_base< GEOID >:
geo::details::plane_id_iterator_base< GEOID > geo::details::TPC_id_iterator_base< GEOID > geo::details::cryostat_id_iterator_base< GEOID > geo::details::geometry_iterator_base geo::details::geometry_iterator_types

Public Types

using ElementPtr_t = geo::WireGeo const *
 
using GeoID_t = typename upper_iterator::GeoID_t
 
using LocalID_t = geo::WireID
 type of the ID we change More...
 
using iterator = wire_id_iterator_base< GeoID_t >
 type of this iterator More...
 

Public Member Functions

 wire_id_iterator_base ()
 Default constructor; effect not defined: assign to it before using! More...
 
 wire_id_iterator_base (geo::GeometryCore const *geom)
 Constructor: points to begin. More...
 
 wire_id_iterator_base (geo::GeometryCore const *geom, GeoID_t const &start_from)
 Constructor: points to the specified wire. More...
 
 wire_id_iterator_base (geo::GeometryCore const *geom, BeginPos_t const)
 Constructor: points to begin. More...
 
 wire_id_iterator_base (geo::GeometryCore const *geom, EndPos_t)
 Constructor: points to end. More...
 
template<typename OTHERID >
bool operator== (wire_id_iterator_base< OTHERID > const &as) const
 Returns true if the two iterators point to the same wire. More...
 
template<typename OTHERID >
bool operator!= (wire_id_iterator_base< OTHERID > const &as) const
 Returns true if the two iterators point to different wires. More...
 
LocalID_t const & operator* () const
 Returns the WireID the iterator points to. More...
 
LocalID_t const * operator-> () const
 Returns the WireID the iterator points to. More...
 
iteratoroperator++ ()
 Prefix increment: returns this iterator pointing to the next wire. 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 wire. More...
 
ElementPtr_t get () const
 Returns a pointer to wire, or nullptr if invalid. More...
 

Protected Types

using ID_t = typename LocalID_t::WireID_t
 specific type for wire ID More...
 

Protected Member Functions

 wire_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 wire. More...
 
ID_t const & local_index () const
 Returns the index (part if the ID) this iterator runs on. 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== (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== (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!= (plane_id_iterator_base< OTHERID > const &as) const
 Returns true if the two iterators point to different planes. 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...
 
template<typename OTHERID >
bool operator!= (cryostat_id_iterator_base< OTHERID > const &as) const
 Returns true if the two iterators point to different cryostats. More...
 
bool at_end () const
 Returns whether this iterator has reached the end. More...
 
geo::GeometryCore const * geometry () const
 Returns a pointer to the geometry. More...
 
GeoID_t const & ID () const
 Returns the actual type of ID we store. More...
 
GeoID_tID ()
 Returns the actual type of ID we store. More...
 

Static Protected Attributes

static constexpr BeginPos_t begin_pos = {}
 
static constexpr EndPos_t end_pos = {}
 
static constexpr UndefinedPos_t undefined_pos = {}
 

Private Types

using upper_iterator = plane_id_iterator_base< GEOID >
 

Private Member Functions

void set_local_limits ()
 Sets limit to the past-the-end wire number of current plane. More...
 
LocalID_tlocalID ()
 Returns the type of ID we act on (non-const version) More...
 
ID_tlocal_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 wires in the current plane More...
 

Detailed Description

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

Base forward iterator browsing all wire IDs in the detector.

Template Parameters
GEOIDID type to be used

This iterator requires that GEOID is derived from geo::WireID. 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 WireID 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 567 of file GeometryCore.h.

Member Typedef Documentation

template<typename GEOID>
using geo::details::wire_id_iterator_base< GEOID >::ElementPtr_t = geo::WireGeo const*

Definition at line 574 of file GeometryCore.h.

template<typename GEOID>
using geo::details::wire_id_iterator_base< GEOID >::GeoID_t = typename upper_iterator::GeoID_t

Definition at line 575 of file GeometryCore.h.

template<typename GEOID>
using geo::details::wire_id_iterator_base< GEOID >::ID_t = typename LocalID_t::WireID_t
protected

specific type for wire ID

Definition at line 648 of file GeometryCore.h.

template<typename GEOID>
using geo::details::wire_id_iterator_base< GEOID >::iterator = wire_id_iterator_base<GeoID_t>

type of this iterator

Definition at line 582 of file GeometryCore.h.

template<typename GEOID>
using geo::details::wire_id_iterator_base< GEOID >::LocalID_t = geo::WireID

type of the ID we change

Definition at line 577 of file GeometryCore.h.

template<typename GEOID>
using geo::details::wire_id_iterator_base< GEOID >::upper_iterator = plane_id_iterator_base<GEOID>
private

Definition at line 571 of file GeometryCore.h.

Constructor & Destructor Documentation

template<typename GEOID>
geo::details::wire_id_iterator_base< GEOID >::wire_id_iterator_base ( )
inline

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

Definition at line 595 of file GeometryCore.h.

595 {}
template<typename GEOID>
geo::details::wire_id_iterator_base< GEOID >::wire_id_iterator_base ( geo::GeometryCore const *  geom)
inline

Constructor: points to begin.

Definition at line 598 of file GeometryCore.h.

598  :
static constexpr BeginPos_t begin_pos
Definition: GeometryCore.h:119
wire_id_iterator_base()
Default constructor; effect not defined: assign to it before using!
Definition: GeometryCore.h:595
template<typename GEOID>
geo::details::wire_id_iterator_base< GEOID >::wire_id_iterator_base ( geo::GeometryCore const *  geom,
GeoID_t const &  start_from 
)
inline

Constructor: points to the specified wire.

Definition at line 603 of file GeometryCore.h.

603  :
604  upper_iterator(geom, start_from)
605  { set_local_limits(); }
plane_id_iterator_base< GEOID > upper_iterator
Definition: GeometryCore.h:571
void set_local_limits()
Sets limit to the past-the-end wire number of current plane.
template<typename GEOID>
geo::details::wire_id_iterator_base< GEOID >::wire_id_iterator_base ( geo::GeometryCore const *  geom,
BeginPos_t  const 
)
inline

Constructor: points to begin.

Definition at line 608 of file GeometryCore.h.

608  :
610  { set_local_limits(); }
static constexpr BeginPos_t begin_pos
Definition: GeometryCore.h:119
plane_id_iterator_base< GEOID > upper_iterator
Definition: GeometryCore.h:571
void set_local_limits()
Sets limit to the past-the-end wire number of current plane.
template<typename GEOID>
geo::details::wire_id_iterator_base< GEOID >::wire_id_iterator_base ( geo::GeometryCore const *  geom,
EndPos_t   
)
inline

Constructor: points to end.

Definition at line 613 of file GeometryCore.h.

613  :
614  upper_iterator(geom, end_pos)
615  {} // the local limit is ill-defined and left invalid
static constexpr EndPos_t end_pos
Definition: GeometryCore.h:120
plane_id_iterator_base< GEOID > upper_iterator
Definition: GeometryCore.h:571
template<typename GEOID>
geo::details::wire_id_iterator_base< GEOID >::wire_id_iterator_base ( geo::GeometryCore const *  geom,
UndefinedPos_t   
)
inlineprotected

Constructor: position undefined (meaning undefined local limits too)

Definition at line 651 of file GeometryCore.h.

651  :
653  {}
static constexpr UndefinedPos_t undefined_pos
Definition: GeometryCore.h:121
plane_id_iterator_base< GEOID > upper_iterator
Definition: GeometryCore.h:571

Member Function Documentation

template<typename GEOID>
bool geo::details::cryostat_id_iterator_base< GEOID >::at_end ( ) const
inlineprotectedinherited

Returns whether this iterator has reached the end.

Definition at line 245 of file GeometryCore.h.

245 { return local_index() == limit; }
ID_t const & local_index() const
Returns the index (part if the ID) this iterator runs on.
Definition: GeometryCore.h:269
ID_t limit
maximum number of cryostats
Definition: GeometryCore.h:249
geo::GeometryCore const* geo::details::geometry_iterator_base::geometry ( ) const
inlineprotectedinherited

Returns a pointer to the geometry.

Definition at line 135 of file GeometryCore.h.

135 { return pGeo; }
GeometryCore const * pGeo
pointer to the geometry
Definition: GeometryCore.h:141
template<typename GEOID >
auto geo::details::wire_id_iterator_base< GEOID >::get ( ) const
inline

Returns a pointer to wire, or nullptr if invalid.

Definition at line 5761 of file GeometryCore.h.

CryostatGeo const * GetElementPtr(geo::CryostatID const &cryoid) const
Returns the specified cryostat.
geo::GeometryCore const * geometry() const
Returns a pointer to the geometry.
Definition: GeometryCore.h:135
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:658
template<typename GEOID>
GeoID_t const& geo::details::cryostat_id_iterator_base< GEOID >::ID ( ) const
inlineprotectedinherited

Returns the actual type of ID we store.

Definition at line 237 of file GeometryCore.h.

237 { return id; }
GeoID_t id
ID of the current cryostat.
Definition: GeometryCore.h:248
template<typename GEOID>
GeoID_t& geo::details::cryostat_id_iterator_base< GEOID >::ID ( )
inlineprotectedinherited

Returns the actual type of ID we store.

Definition at line 238 of file GeometryCore.h.

238 { return id; }
GeoID_t id
ID of the current cryostat.
Definition: GeometryCore.h:248
template<typename GEOID>
ID_t const& geo::details::wire_id_iterator_base< GEOID >::local_index ( ) const
inlineprotected

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

Definition at line 667 of file GeometryCore.h.

667 { return localID().Wire; }
WireID_t Wire
Index of the wire within its plane.
Definition: geo_types.h:313
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:658
template<typename GEOID>
ID_t& geo::details::wire_id_iterator_base< GEOID >::local_index ( )
inlineprivate

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

Definition at line 681 of file GeometryCore.h.

681 { return localID().Wire; }
WireID_t Wire
Index of the wire within its plane.
Definition: geo_types.h:313
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:658
template<typename GEOID>
LocalID_t const& geo::details::wire_id_iterator_base< GEOID >::localID ( ) const
inlineprotected

Returns the type of ID we act on.

Definition at line 658 of file GeometryCore.h.

Referenced by geo::details::wire_id_iterator_base< GEOID >::operator!=(), and geo::details::wire_id_iterator_base< GEOID >::operator==().

659  { return static_cast<LocalID_t const&>(upper_iterator::ID()); }
GeoID_t const & ID() const
Returns the actual type of ID we store.
Definition: GeometryCore.h:237
geo::WireID LocalID_t
type of the ID we change
Definition: GeometryCore.h:577
template<typename GEOID>
LocalID_t& geo::details::wire_id_iterator_base< GEOID >::localID ( )
inlineprivate

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

Definition at line 678 of file GeometryCore.h.

678 { return static_cast<LocalID_t&>(ID()); }
GeoID_t const & ID() const
Returns the actual type of ID we store.
Definition: GeometryCore.h:237
geo::WireID LocalID_t
type of the ID we change
Definition: GeometryCore.h:577
template<typename GEOID >
void geo::details::wire_id_iterator_base< GEOID >::next ( )
inlineprotected

Skips to the next wire.

Definition at line 5772 of file GeometryCore.h.

5772  {
5773  // if at end (checked in the inherited context), do nothing
5774  if (upper_iterator::at_end()) return;
5775 
5776  // if after incrementing we haven't reached the limit, we are done
5777  if (++local_index() < limit) return;
5778 
5779  // we reached the end of the current elements list, we need to escalate:
5780  // - go to the next parent; if that becomes invalid, too bad, but we go on
5782  // - set the index to the first element of the new parent
5783  local_index() = 0;
5784  // - update how many elements there are
5785  // (expect 0 if it is now at_end() -- and it does not even matter)
5786  set_local_limits();
5787 } // geo::details::wire_id_iterator_base<>::next()
void next()
Skips to the next plane.
ID_t limit
maximum number of wires in the current plane
Definition: GeometryCore.h:672
void set_local_limits()
Sets limit to the past-the-end wire number of current plane.
bool at_end() const
Returns whether this iterator has reached the end.
Definition: GeometryCore.h:245
ID_t const & local_index() const
Returns the index (part if the ID) this iterator runs on.
Definition: GeometryCore.h:667
template<typename GEOID >
geo::details::wire_id_iterator_base< GEOID >::operator bool ( ) const
inline

Returns whether the iterator is pointing to a valid wire.

Definition at line 5755 of file GeometryCore.h.

5755  {
5756  return upper_iterator::geometry()
5758 } // geo::details::wire_id_iterator_base<>::operator bool()
geo::GeometryCore const * geometry() const
Returns a pointer to the geometry.
Definition: GeometryCore.h:135
bool HasElement(geo::CryostatID const &cryoid) const
Returns whether we have the specified cryostat.
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:658
template<typename GEOID>
template<typename OTHERID >
bool geo::details::cryostat_id_iterator_base< GEOID >::operator!= ( cryostat_id_iterator_base< OTHERID > const &  as) const
inlineinherited

Returns true if the two iterators point to different cryostats.

Definition at line 206 of file GeometryCore.h.

References geo::details::cryostat_id_iterator_base< GEOID >::localID().

207  { return localID() != as.localID(); }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:262
template<typename GEOID>
template<typename OTHERID >
bool geo::details::TPC_id_iterator_base< GEOID >::operator!= ( TPC_id_iterator_base< OTHERID > const &  as) const
inlineinherited

Returns true if the two iterators point to different TPCs.

Definition at line 351 of file GeometryCore.h.

References geo::details::TPC_id_iterator_base< GEOID >::localID().

352  { return localID() != as.localID(); }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:384
template<typename GEOID>
template<typename OTHERID >
bool geo::details::plane_id_iterator_base< GEOID >::operator!= ( plane_id_iterator_base< OTHERID > const &  as) const
inlineinherited

Returns true if the two iterators point to different planes.

Definition at line 488 of file GeometryCore.h.

References geo::details::plane_id_iterator_base< GEOID >::localID().

489  { return localID() != as.localID(); }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:521
template<typename GEOID>
template<typename OTHERID >
bool geo::details::wire_id_iterator_base< GEOID >::operator!= ( wire_id_iterator_base< OTHERID > const &  as) const
inline

Returns true if the two iterators point to different wires.

Definition at line 625 of file GeometryCore.h.

References geo::details::wire_id_iterator_base< GEOID >::localID().

626  { return localID() != as.localID(); }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:658
template<typename GEOID>
LocalID_t const& geo::details::wire_id_iterator_base< GEOID >::operator* ( ) const
inline

Returns the WireID the iterator points to.

Definition at line 629 of file GeometryCore.h.

629 { return localID(); }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:658
template<typename GEOID>
iterator& geo::details::wire_id_iterator_base< GEOID >::operator++ ( )
inline

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

Definition at line 635 of file GeometryCore.h.

635 { next(); return *this; }
void next()
Skips to the next wire.
template<typename GEOID>
iterator geo::details::wire_id_iterator_base< GEOID >::operator++ ( int  )
inline

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

Definition at line 638 of file GeometryCore.h.

638 { iterator old(*this); next(); return old; }
void next()
Skips to the next wire.
template<typename GEOID>
LocalID_t const* geo::details::wire_id_iterator_base< GEOID >::operator-> ( ) const
inline

Returns the WireID the iterator points to.

Definition at line 632 of file GeometryCore.h.

632 { return &(localID()); }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:658
template<typename GEOID>
template<typename OTHERID >
bool geo::details::cryostat_id_iterator_base< GEOID >::operator== ( cryostat_id_iterator_base< OTHERID > const &  as) const
inlineinherited

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

Definition at line 201 of file GeometryCore.h.

References geo::details::cryostat_id_iterator_base< GEOID >::localID().

202  { return localID() == as.localID(); }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:262
template<typename GEOID>
template<typename OTHERID >
bool geo::details::TPC_id_iterator_base< GEOID >::operator== ( TPC_id_iterator_base< OTHERID > const &  as) const
inlineinherited

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

Definition at line 346 of file GeometryCore.h.

References geo::details::TPC_id_iterator_base< GEOID >::localID().

347  { return localID() == as.localID(); }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:384
template<typename GEOID>
template<typename OTHERID >
bool geo::details::plane_id_iterator_base< GEOID >::operator== ( plane_id_iterator_base< OTHERID > const &  as) const
inlineinherited

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

Definition at line 483 of file GeometryCore.h.

References geo::details::plane_id_iterator_base< GEOID >::localID().

484  { return localID() == as.localID(); }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:521
template<typename GEOID>
template<typename OTHERID >
bool geo::details::wire_id_iterator_base< GEOID >::operator== ( wire_id_iterator_base< OTHERID > const &  as) const
inline

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

Definition at line 620 of file GeometryCore.h.

References geo::details::wire_id_iterator_base< GEOID >::localID().

621  { return localID() == as.localID(); }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:658
template<typename GEOID >
void geo::details::wire_id_iterator_base< GEOID >::set_local_limits ( )
inlineprivate

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

Definition at line 5766 of file GeometryCore.h.

5766  {
5767  // limit is how many sibling wires there are
5769 } // geo::details::wire_id_iterator_base<>::set_local_limits()
geo::GeometryCore const * geometry() const
Returns a pointer to the geometry.
Definition: GeometryCore.h:135
unsigned int NSiblingElements(geo::CryostatID const &) const
Returns the number of cryostats in the detector.
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:658
ID_t limit
maximum number of wires in the current plane
Definition: GeometryCore.h:672

Member Data Documentation

template<typename GEOID>
ID_t geo::details::wire_id_iterator_base< GEOID >::limit = LocalID_t::InvalidID
private

maximum number of wires in the current plane

Definition at line 672 of file GeometryCore.h.

constexpr details::geometry_iterator_types::UndefinedPos_t geo::details::geometry_iterator_types::undefined_pos = {}
staticinherited

Definition at line 121 of file GeometryCore.h.

Referenced by geo::GeometryCore::PointWithinSegments().


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