F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Classes | Public Types | Public Member Functions | List of all members
Fw::SetConstIterator< T > Class Template Reference

#include <Fw/DataStructures/SetConstIterator.hpp>

Public Types

using ArrayIterator = typename ArraySetOrMapImpl< T, Nil >::ConstIterator
 The type of an array iterator. More...
 
using RedBlackTreeIterator = typename RedBlackTreeSetOrMapImpl< T, Nil >::ConstIterator
 The type of a red-black tree iterator. More...
 

Public Member Functions

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

Detailed Description

template<typename T>
class Fw::SetConstIterator< T >

Definition at line 20 of file SetConstIterator.hpp.

Member Typedef Documentation

◆ ArrayIterator

template<typename T >
using Fw::SetConstIterator< T >::ArrayIterator = typename ArraySetOrMapImpl<T, Nil>::ConstIterator

The type of an array iterator.

Definition at line 27 of file SetConstIterator.hpp.

◆ RedBlackTreeIterator

template<typename T >
using Fw::SetConstIterator< T >::RedBlackTreeIterator = typename RedBlackTreeSetOrMapImpl<T, Nil>::ConstIterator

The type of a red-black tree iterator.

Definition at line 30 of file SetConstIterator.hpp.

Constructor & Destructor Documentation

◆ SetConstIterator() [1/3]

template<typename T >
Fw::SetConstIterator< T >::SetConstIterator ( const ArrayIterator &  it)
inline

Constructor providing an array implementation.

Definition at line 62 of file SetConstIterator.hpp.

◆ SetConstIterator() [2/3]

template<typename T >
Fw::SetConstIterator< T >::SetConstIterator ( const RedBlackTreeIterator &  it)
inline

Constructor providing a red-black tree implementation.

Definition at line 65 of file SetConstIterator.hpp.

◆ SetConstIterator() [3/3]

template<typename T >
Fw::SetConstIterator< T >::SetConstIterator ( const SetConstIterator< T > &  it)
inline

Copy constructor.

Definition at line 68 of file SetConstIterator.hpp.

◆ ~SetConstIterator()

template<typename T >
Fw::SetConstIterator< T >::~SetConstIterator ( )
inline

Destructor.

Definition at line 84 of file SetConstIterator.hpp.

Member Function Documentation

◆ isInRange()

template<typename T >
bool Fw::SetConstIterator< T >::isInRange ( ) const
inline

Check whether the iterator is in range.

Definition at line 132 of file SetConstIterator.hpp.

◆ operator!=()

template<typename T >
bool Fw::SetConstIterator< T >::operator!= ( const SetConstIterator< T > &  it)
inline

Inequality comparison operator.

Definition at line 116 of file SetConstIterator.hpp.

◆ operator*()

template<typename T >
const T& Fw::SetConstIterator< T >::operator* ( ) const
inline

Dereference.

Definition at line 135 of file SetConstIterator.hpp.

◆ operator++() [1/2]

template<typename T >
SetConstIterator& Fw::SetConstIterator< T >::operator++ ( )
inline

Prefix increment.

Definition at line 119 of file SetConstIterator.hpp.

◆ operator++() [2/2]

template<typename T >
SetConstIterator Fw::SetConstIterator< T >::operator++ ( int  )
inline

Postfix increment.

Definition at line 125 of file SetConstIterator.hpp.

◆ operator->()

template<typename T >
const T* Fw::SetConstIterator< T >::operator-> ( ) const
inline

Pointer.

Definition at line 138 of file SetConstIterator.hpp.

◆ operator=()

template<typename T >
SetConstIterator& Fw::SetConstIterator< T >::operator= ( const SetConstIterator< T > &  )
default

Copy assignment operator.

◆ operator==()

template<typename T >
bool Fw::SetConstIterator< T >::operator== ( const SetConstIterator< T > &  it)
inline

Equality comparison operator.

Definition at line 95 of file SetConstIterator.hpp.

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