Fw::MapConstIterator< K, V > Class Template Reference

#include <Fw/DataStructures/MapConstIterator.hpp>

Public Types
using	ArrayIterator = typename ArraySetOrMapImpl< K, V >::ConstIterator
	The type of an array iterator. More...
using	EntryBase = MapEntryBase< K, V >
	The type of a map entry base. More...
using	RedBlackTreeIterator = typename RedBlackTreeSetOrMapImpl< K, V >::ConstIterator
	The type of a red-black tree iterator. More...

Public Member Functions
	MapConstIterator (const ArrayIterator &it)
	Constructor providing an array implementation. More...
	MapConstIterator (const RedBlackTreeIterator &it)
	Constructor providing a red-black tree implementation. More...
	MapConstIterator (const MapConstIterator &it)
	Copy constructor. More...
	~MapConstIterator ()
	Destructor. More...
MapConstIterator &	operator= (const MapConstIterator &)=default
	Copy assignment operator. More...
bool	operator== (const MapConstIterator &it)
	Equality comparison operator. More...
bool	operator!= (const MapConstIterator &it)
	Inequality comparison operator. More...
MapConstIterator &	operator++ ()
	Prefix increment. More...
MapConstIterator	operator++ (int)
	Postfix increment. More...
bool	isInRange () const
	Check whether the iterator is in range. More...
const EntryBase &	operator* () const
	Dereference. More...
const EntryBase *	operator-> () const
	Pointer. More...

Detailed Description

template<typename K, typename V>
class Fw::MapConstIterator< K, V >

Definition at line 20 of file MapConstIterator.hpp.

Member Typedef Documentation

ArrayIterator

template<typename K , typename V >

using Fw::MapConstIterator< K, V >::ArrayIterator = typename ArraySetOrMapImpl<K, V>::ConstIterator

The type of an array iterator.

Definition at line 27 of file MapConstIterator.hpp.

EntryBase

template<typename K , typename V >

using Fw::MapConstIterator< K, V >::EntryBase = MapEntryBase<K, V>

The type of a map entry base.

Definition at line 29 of file MapConstIterator.hpp.

RedBlackTreeIterator

template<typename K , typename V >

using Fw::MapConstIterator< K, V >::RedBlackTreeIterator = typename RedBlackTreeSetOrMapImpl<K, V>::ConstIterator

The type of a red-black tree iterator.

Definition at line 31 of file MapConstIterator.hpp.

Constructor & Destructor Documentation

MapConstIterator() [1/3]

template<typename K , typename V >

Fw::MapConstIterator< K, V >::MapConstIterator ( const ArrayIterator &  it )

inline

Constructor providing an array implementation.

Definition at line 63 of file MapConstIterator.hpp.

MapConstIterator() [2/3]

template<typename K , typename V >

Fw::MapConstIterator< K, V >::MapConstIterator ( const RedBlackTreeIterator &  it )

inline

Constructor providing a red-black tree implementation.

Definition at line 66 of file MapConstIterator.hpp.

MapConstIterator() [3/3]

template<typename K , typename V >

Fw::MapConstIterator< K, V >::MapConstIterator ( const MapConstIterator< K, V > &  it )

inline

Copy constructor.

Definition at line 69 of file MapConstIterator.hpp.

~MapConstIterator()

template<typename K , typename V >

Fw::MapConstIterator< K, V >::~MapConstIterator ( )

inline

Destructor.

Definition at line 85 of file MapConstIterator.hpp.

Member Function Documentation

isInRange()

template<typename K , typename V >

bool Fw::MapConstIterator< K, V >::isInRange ( ) const

inline

Check whether the iterator is in range.

Definition at line 133 of file MapConstIterator.hpp.

operator!=()

template<typename K , typename V >

bool Fw::MapConstIterator< K, V >::operator!= ( const MapConstIterator< K, V > &  it )

inline

Inequality comparison operator.

Definition at line 117 of file MapConstIterator.hpp.

operator*()

template<typename K , typename V >

const EntryBase& Fw::MapConstIterator< K, V >::operator* ( ) const

inline

Dereference.

Definition at line 136 of file MapConstIterator.hpp.

operator++() [1/2]

template<typename K , typename V >

MapConstIterator& Fw::MapConstIterator< K, V >::operator++ ( )

inline

Prefix increment.

Definition at line 120 of file MapConstIterator.hpp.

operator++() [2/2]

template<typename K , typename V >

MapConstIterator Fw::MapConstIterator< K, V >::operator++ ( int  )

inline

Postfix increment.

Definition at line 126 of file MapConstIterator.hpp.

operator->()

template<typename K , typename V >

const EntryBase* Fw::MapConstIterator< K, V >::operator-> ( ) const

inline

Pointer.

Definition at line 139 of file MapConstIterator.hpp.

operator=()

template<typename K , typename V >

MapConstIterator& Fw::MapConstIterator< K, V >::operator= ( const MapConstIterator< K, V > &  )

default

Copy assignment operator.

operator==()

template<typename K , typename V >

bool Fw::MapConstIterator< K, V >::operator== ( const MapConstIterator< K, V > &  it )

inline

Equality comparison operator.

Definition at line 96 of file MapConstIterator.hpp.

---

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

• Fw/DataStructures/MapConstIterator.hpp