ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
alib::enumops::EnumIterator< TEnum > Struct Template Reference

Description:

template<typename TEnum>
requires alib::enumops::IsIterable<TEnum>
struct alib::enumops::EnumIterator< TEnum >

Implements a std::iterator_traits class for scoped and non-scoped enum types. The documentation is found with the type trait IterableTraits, which needs to be specialized for template type TEnum. For other types, this class is not constructible.

Template Parameters
TEnumThe enum type to iterate over.

Definition at line 157 of file iterable.inl.

Inner Type Index:

class  TRandomAccessIterator
 

Public Type Index:

using ConstIterator = TRandomAccessIterator<const TEnum*, const TEnum&>
 The constant iterator exposed by this class. A Mutable version is not available.
 

Public Method Index:

 EnumIterator ()=default
 Default constructor.
 
ConstIterator begin () const
 
ConstIterator end () const
 

Type Definition Details:

◆ ConstIterator

template<typename TEnum>
using alib::enumops::EnumIterator< TEnum >::ConstIterator = TRandomAccessIterator<const TEnum*, const TEnum&>

The constant iterator exposed by this class. A Mutable version is not available.

Definition at line 384 of file iterable.inl.

Method Details:

◆ begin()

template<typename TEnum>
ConstIterator alib::enumops::EnumIterator< TEnum >::begin ( ) const
inline

Returns an iterator referring to the start of enumeration TEnum.

Returns
The start of the enumeration.

Definition at line 389 of file iterable.inl.

Here is the call graph for this function:

◆ end()

template<typename TEnum>
ConstIterator alib::enumops::EnumIterator< TEnum >::end ( ) const
inline

Returns an iterator referring the first illegal value of enumeration TEnum.

Returns
The end of the enumeration.

Definition at line 399 of file iterable.inl.

Here is the call graph for this function:

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