Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
geo::details::TPC_id_iterator_base< GEOID > Class Template Reference

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

#include <GeometryCore.h>

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

Public Types

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...
 
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

 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...
 
iteratoroperator++ ()
 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 Types

using ID_t = typename LocalID_t::TPCID_t
 specific type for TPC ID More...
 
- 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

 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...
 
- 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_tID ()
 
 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...
 
iteratoroperator++ ()
 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 = cryostat_id_iterator_base< GEOID >
 

Private Member Functions

void set_local_limits ()
 Sets limit to the past-the-end TPC number of current croystat. 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 TPCs in the current cryostat More...
 

Detailed Description

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

Base forward iterator browsing all TPC IDs in the detector.

Template Parameters
GEOIDID type to be used

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

Member Typedef Documentation

template<typename GEOID>
using geo::details::TPC_id_iterator_base< GEOID >::difference_type = std::ptrdiff_t

Definition at line 321 of file GeometryCore.h.

template<typename GEOID>
using geo::details::TPC_id_iterator_base< GEOID >::ElementPtr_t = geo::TPCGeo const*

Definition at line 299 of file GeometryCore.h.

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

Definition at line 300 of file GeometryCore.h.

template<typename GEOID>
using geo::details::TPC_id_iterator_base< GEOID >::ID_t = typename LocalID_t::TPCID_t
protected

specific type for TPC ID

Definition at line 383 of file GeometryCore.h.

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

type of this iterator

Definition at line 306 of file GeometryCore.h.

template<typename GEOID>
using geo::details::TPC_id_iterator_base< GEOID >::iterator_category = std::input_iterator_tag

Definition at line 325 of file GeometryCore.h.

template<typename GEOID>
using geo::details::TPC_id_iterator_base< GEOID >::LocalID_t = geo::TPCID

type of the ID we change

Definition at line 302 of file GeometryCore.h.

template<typename GEOID>
using geo::details::TPC_id_iterator_base< GEOID >::pointer = value_type const*

Definition at line 324 of file GeometryCore.h.

template<typename GEOID>
using geo::details::TPC_id_iterator_base< GEOID >::reference = value_type const&

Definition at line 323 of file GeometryCore.h.

template<typename GEOID>
using geo::details::TPC_id_iterator_base< GEOID >::upper_iterator = cryostat_id_iterator_base<GEOID>
private

Definition at line 296 of file GeometryCore.h.

template<typename GEOID>
using geo::details::TPC_id_iterator_base< GEOID >::value_type = LocalID_t

Definition at line 322 of file GeometryCore.h.

Constructor & Destructor Documentation

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

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

Definition at line 330 of file GeometryCore.h.

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

Constructor: points to begin.

Definition at line 333 of file GeometryCore.h.

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

Constructor: points to the specified TPC.

Definition at line 338 of file GeometryCore.h.

338  :
339  upper_iterator(geom, start_from)
340  { set_local_limits(); }
cryostat_id_iterator_base< GEOID > upper_iterator
Definition: GeometryCore.h:296
void set_local_limits()
Sets limit to the past-the-end TPC number of current croystat.
template<typename GEOID>
geo::details::TPC_id_iterator_base< GEOID >::TPC_id_iterator_base ( geo::GeometryCore const *  geom,
BeginPos_t  const 
)
inline

Constructor: points to begin.

Definition at line 343 of file GeometryCore.h.

343  :
345  { set_local_limits(); }
static constexpr BeginPos_t begin_pos
Definition: GeometryCore.h:107
cryostat_id_iterator_base< GEOID > upper_iterator
Definition: GeometryCore.h:296
void set_local_limits()
Sets limit to the past-the-end TPC number of current croystat.
template<typename GEOID>
geo::details::TPC_id_iterator_base< GEOID >::TPC_id_iterator_base ( geo::GeometryCore const *  geom,
EndPos_t   
)
inline

Constructor: points to end.

Definition at line 348 of file GeometryCore.h.

348  :
349  upper_iterator(geom, end_pos)
350  {} // the local limit is ill-defined and left invalid
static constexpr EndPos_t end_pos
Definition: GeometryCore.h:108
cryostat_id_iterator_base< GEOID > upper_iterator
Definition: GeometryCore.h:296
template<typename GEOID>
geo::details::TPC_id_iterator_base< GEOID >::TPC_id_iterator_base ( geo::GeometryCore const *  geom,
UndefinedPos_t   
)
inlineprotected

Constructor: position undefined (meaning undefined local limits too)

Definition at line 386 of file GeometryCore.h.

386  :
388  {}
static constexpr UndefinedPos_t undefined_pos
Definition: GeometryCore.h:109
cryostat_id_iterator_base< GEOID > upper_iterator
Definition: GeometryCore.h:296

Member Function Documentation

template<typename GEOID >
auto geo::details::TPC_id_iterator_base< GEOID >::get ( ) const
inline

Returns a pointer to TPC, or nullptr if invalid.

Definition at line 5874 of file GeometryCore.h.

CryostatGeo const * GetElementPtr(geo::CryostatID const &cryoid) const
geo::GeometryCore const * geometry() const
Returns a pointer to the geometry.
Definition: GeometryCore.h:123
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:393
template<typename GEOID>
ID_t const& geo::details::TPC_id_iterator_base< GEOID >::local_index ( ) const
inlineprotected

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

Definition at line 402 of file GeometryCore.h.

402 { return localID().TPC; }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:393
TPCID_t TPC
Index of the TPC within its cryostat.
Definition: geo_types.h:406
template<typename GEOID>
ID_t& geo::details::TPC_id_iterator_base< GEOID >::local_index ( )
inlineprivate

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

Definition at line 416 of file GeometryCore.h.

416 { return localID().TPC; }
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:393
TPCID_t TPC
Index of the TPC within its cryostat.
Definition: geo_types.h:406
template<typename GEOID>
LocalID_t const& geo::details::TPC_id_iterator_base< GEOID >::localID ( ) const
inlineprotected

Returns the type of ID we act on.

Definition at line 393 of file GeometryCore.h.

394  { return static_cast<LocalID_t const&>(upper_iterator::ID()); }
geo::TPCID LocalID_t
type of the ID we change
Definition: GeometryCore.h:302
GeoID_t const & ID() const
Returns the actual type of ID we store.
Definition: GeometryCore.h:235
template<typename GEOID>
LocalID_t& geo::details::TPC_id_iterator_base< GEOID >::localID ( )
inlineprivate

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

Definition at line 413 of file GeometryCore.h.

413 { return static_cast<LocalID_t&>(ID()); }
geo::TPCID LocalID_t
type of the ID we change
Definition: GeometryCore.h:302
GeoID_t const & ID() const
Returns the actual type of ID we store.
Definition: GeometryCore.h:235
template<typename GEOID >
void geo::details::TPC_id_iterator_base< GEOID >::next ( )
inlineprotected

Skips to the next TPC.

Definition at line 5884 of file GeometryCore.h.

5884  {
5885  // if at end (checked in the inherited context), do nothing
5886  if (upper_iterator::at_end()) return;
5887 
5888  // if after incrementing we haven't reached the limit, we are done
5889  if (++local_index() < limit) return;
5890 
5891  // we reached the end of the current elements list, we need to escalate:
5892  // - go to the next parent; if that becomes invalid, too bad, but we go on
5894  // - set the index to the first element of the new parent
5895  local_index() = 0;
5896  // - update how many elements there are
5897  // (expect 0 if it is now at_end() -- and it does not even matter)
5898  set_local_limits();
5899 } // geo::details::TPC_id_iterator_base<GEOID>::next()
ID_t limit
maximum number of TPCs in the current cryostat
Definition: GeometryCore.h:407
void next()
Skips to the next cryostat.
ID_t const & local_index() const
Returns the index (part if the ID) this iterator runs on.
Definition: GeometryCore.h:402
void set_local_limits()
Sets limit to the past-the-end TPC number of current croystat.
bool at_end() const
Returns whether this iterator has reached the end.
Definition: GeometryCore.h:243
template<typename GEOID >
geo::details::TPC_id_iterator_base< GEOID >::operator bool ( ) const
inline

Returns whether the iterator is pointing to a valid TPC.

Definition at line 5866 of file GeometryCore.h.

5866  {
5867  return upper_iterator::geometry()
5869 } // geo::details::TPC_id_iterator_base<>::operator bool()
geo::GeometryCore const * geometry() const
Returns a pointer to the geometry.
Definition: GeometryCore.h:123
bool HasElement(geo::CryostatID const &cryoid) const
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:393
template<typename GEOID>
template<typename OTHERID >
bool geo::details::TPC_id_iterator_base< GEOID >::operator!= ( TPC_id_iterator_base< OTHERID > const &  as) const
inline

Returns true if the two iterators point to different TPCs.

Definition at line 360 of file GeometryCore.h.

361  { return localID() != as.localID(); }
static constexpr double as
Definition: Units.h:101
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:393
template<typename GEOID>
reference geo::details::TPC_id_iterator_base< GEOID >::operator* ( ) const
inline

Returns the TPCID the iterator points to.

Definition at line 364 of file GeometryCore.h.

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

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

Definition at line 370 of file GeometryCore.h.

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

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

Definition at line 373 of file GeometryCore.h.

373 { iterator old(*this); next(); return old; }
void next()
Skips to the next TPC.
template<typename GEOID>
pointer geo::details::TPC_id_iterator_base< GEOID >::operator-> ( ) const
inline

Returns the TPCID the iterator points to.

Definition at line 367 of file GeometryCore.h.

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

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

Definition at line 355 of file GeometryCore.h.

356  { return localID() == as.localID(); }
static constexpr double as
Definition: Units.h:101
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:393
template<typename GEOID >
void geo::details::TPC_id_iterator_base< GEOID >::set_local_limits ( )
inlineprivate

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

Definition at line 5878 of file GeometryCore.h.

5878  {
5879  // limit is how many sibling TPCs there are
5881 } // geo::details::TPC_id_iterator_base<GEOID>::set_local_limits()
geo::GeometryCore const * geometry() const
Returns a pointer to the geometry.
Definition: GeometryCore.h:123
unsigned int NSiblingElements(geo::CryostatID const &) const
ID_t limit
maximum number of TPCs in the current cryostat
Definition: GeometryCore.h:407
LocalID_t const & localID() const
Returns the type of ID we act on.
Definition: GeometryCore.h:393

Member Data Documentation

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

maximum number of TPCs in the current cryostat

Definition at line 407 of file GeometryCore.h.


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