Stefan Scholz / ETL
Embed: (wiki syntax)

« Back to documentation index

fixed_iterator< TIterator > Class Template Reference

fixed_iterator< TIterator > Class Template Reference
[Iterator types]

A fixed iterator class. More...

#include <fixed_iterator.h>

Public Member Functions

 fixed_iterator ()
 Default constructor.
 fixed_iterator (TIterator it_)
 Construct from iterator.
fixed_iteratoroperator++ ()
 Increment (Does nothing).
fixed_iterator operator++ (int)
 Increment (Does nothing).
fixed_iteratoroperator-- ()
 Decrement (Does nothing).
fixed_iterator operator-- (int)
 Decrement (Does nothing).
std::iterator_traits
< TIterator >::value_type 
operator* ()
 Dereference operator.
const std::iterator_traits
< TIterator >::value_type 
operator* () const
 Dereference operator.
TIterator operator-> ()
 -> operator.
const TIterator operator-> () const
 -> operator.
 operator TIterator () const
 Conversion operator.
fixed_iteratoroperator+= (typename std::iterator_traits< TIterator >::difference_type)
 += operator.
fixed_iteratoroperator-= (typename std::iterator_traits< TIterator >::difference_type)
 -= operator.
fixed_iteratoroperator= (TIterator new_it)
 Assignment from iterator.
fixed_iteratoroperator= (fixed_iterator other)
 Assignment from fixed_iterator.

Detailed Description

template<typename TIterator>
class etl::fixed_iterator< TIterator >

A fixed iterator class.

This iterator can be given an iterator value, which will not be allowed to be incremented or decremented. This can be useful when using STL algorithms to interact with fixed memory locations such as registers.

Definition at line 47 of file fixed_iterator.h.


Constructor & Destructor Documentation

Default constructor.

Definition at line 54 of file fixed_iterator.h.

fixed_iterator ( TIterator  it_ )

Construct from iterator.

Definition at line 62 of file fixed_iterator.h.


Member Function Documentation

operator TIterator (  ) const

Conversion operator.

Definition at line 134 of file fixed_iterator.h.

std::iterator_traits<TIterator>::value_type operator* (  )

Dereference operator.

Definition at line 102 of file fixed_iterator.h.

const std::iterator_traits<TIterator>::value_type operator* (  ) const

Dereference operator.

Definition at line 110 of file fixed_iterator.h.

fixed_iterator& operator++ (  )

Increment (Does nothing).

Definition at line 70 of file fixed_iterator.h.

fixed_iterator operator++ ( int   )

Increment (Does nothing).

Definition at line 78 of file fixed_iterator.h.

fixed_iterator& operator+= ( typename std::iterator_traits< TIterator >::difference_type   )

+= operator.

Definition at line 142 of file fixed_iterator.h.

fixed_iterator operator-- ( int   )

Decrement (Does nothing).

Definition at line 94 of file fixed_iterator.h.

fixed_iterator& operator-- (  )

Decrement (Does nothing).

Definition at line 86 of file fixed_iterator.h.

fixed_iterator& operator-= ( typename std::iterator_traits< TIterator >::difference_type   )

-= operator.

Definition at line 150 of file fixed_iterator.h.

const TIterator operator-> (  ) const

-> operator.

Definition at line 126 of file fixed_iterator.h.

TIterator operator-> (  )

-> operator.

Definition at line 118 of file fixed_iterator.h.

fixed_iterator& operator= ( TIterator  new_it )

Assignment from iterator.

Definition at line 158 of file fixed_iterator.h.

fixed_iterator& operator= ( fixed_iterator< TIterator >  other )

Assignment from fixed_iterator.

Definition at line 167 of file fixed_iterator.h.