EnumIterator< EnumType > Class Template Reference

#include <EnumIterator.h>

Inheritance diagram for EnumIterator< EnumType >:
Collaboration diagram for EnumIterator< EnumType >:

Public Types

using iterator_category = std::bidirectional_iterator_tag
 
using value_type = EnumType
 
using difference_type = std::ptrdiff_t
 
using pointer = EnumType *
 
using reference = EnumType &
 

Public Member Functions

 EnumIterator (EnumType e)
 
EnumIteratoroperator++ ()
 
EnumIteratoroperator++ (int)
 
EnumIteratoroperator-- ()
 
EnumIteratoroperator-- (int)
 
bool operator== (const EnumIteratorBase &i) const
 
bool operator!= (const EnumIteratorBase &i) const
 
EnumType operator* () const
 

Protected Types

typedef int iterator_type
 

Protected Attributes

iterator_type current
 

Detailed Description

template<typename EnumType>
class EnumIterator< EnumType >

bidirectional iterator over an enum type

It can be instantiated using any enum (or C++11 strongly-typed enum) value; the most common expected use scenario has iterators emitted by EnumRange and WholeEnum via standard begin() and end() calls.

In order for the iterator to work, it is mandatory that the underlying enum type's representation values be sequential.

The iterator does not check for bounds when incrementing or decrementing, that responsibility is left to the caller.

See also
EnumRange, WholeEnum, ReverseEnumIterator

Definition at line 71 of file EnumIterator.h.

Member Typedef Documentation

◆ difference_type

template<typename EnumType >
using EnumIteratorBase< EnumType >::difference_type = std::ptrdiff_t
inherited

Definition at line 35 of file EnumIterator.h.

◆ iterator_category

template<typename EnumType >
using EnumIteratorBase< EnumType >::iterator_category = std::bidirectional_iterator_tag
inherited

Definition at line 33 of file EnumIterator.h.

◆ iterator_type

template<typename EnumType >
typedef int EnumIteratorBase< EnumType >::iterator_type
protectedinherited

Definition at line 29 of file EnumIterator.h.

◆ pointer

template<typename EnumType >
using EnumIteratorBase< EnumType >::pointer = EnumType *
inherited

Definition at line 36 of file EnumIterator.h.

◆ reference

template<typename EnumType >
using EnumIteratorBase< EnumType >::reference = EnumType &
inherited

Definition at line 37 of file EnumIterator.h.

◆ value_type

template<typename EnumType >
using EnumIteratorBase< EnumType >::value_type = EnumType
inherited

Definition at line 34 of file EnumIterator.h.

Constructor & Destructor Documentation

◆ EnumIterator()

template<typename EnumType >
EnumIterator< EnumType >::EnumIterator ( EnumType  e)
inlineexplicit

Definition at line 74 of file EnumIterator.h.

Member Function Documentation

◆ operator!=()

template<typename EnumType >
bool EnumIteratorBase< EnumType >::operator!= ( const EnumIteratorBase< EnumType > &  i) const
inlineinherited

Definition at line 45 of file EnumIterator.h.

References EnumIteratorBase< EnumType >::current.

◆ operator*()

template<typename EnumType >
EnumType EnumIteratorBase< EnumType >::operator* ( ) const
inlineinherited

Definition at line 49 of file EnumIterator.h.

References EnumIteratorBase< EnumType >::current.

◆ operator++() [1/2]

template<typename EnumType >
EnumIterator& EnumIterator< EnumType >::operator++ ( )
inline

Definition at line 76 of file EnumIterator.h.

◆ operator++() [2/2]

template<typename EnumType >
EnumIterator& EnumIterator< EnumType >::operator++ ( int  )
inline

Definition at line 81 of file EnumIterator.h.

◆ operator--() [1/2]

template<typename EnumType >
EnumIterator& EnumIterator< EnumType >::operator-- ( )
inline

Definition at line 87 of file EnumIterator.h.

◆ operator--() [2/2]

template<typename EnumType >
EnumIterator& EnumIterator< EnumType >::operator-- ( int  )
inline

Definition at line 92 of file EnumIterator.h.

◆ operator==()

template<typename EnumType >
bool EnumIteratorBase< EnumType >::operator== ( const EnumIteratorBase< EnumType > &  i) const
inlineinherited

Definition at line 41 of file EnumIterator.h.

References EnumIteratorBase< EnumType >::current.

Member Data Documentation

◆ current

template<typename EnumType >
iterator_type EnumIteratorBase< EnumType >::current
protectedinherited

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors