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

#include <Fw/DataStructures/SetOrMapImplConstIterator.hpp>

Inheritance diagram for Fw::SetOrMapImplConstIterator< KE, VN >:
Fw::ArraySetOrMapImpl< KE, VN >::ConstIterator Fw::RedBlackTreeSetOrMapImpl< KE, VN >::ConstIterator

Public Types

enum  ImplKind { ImplKind::ARRAY, ImplKind::RED_BLACK_TREE }
 The kind of a const iterator implementation. More...
 

Public Member Functions

 SetOrMapImplConstIterator ()=default
 Zero-argument constructor. More...
 
virtual ~SetOrMapImplConstIterator ()=default
 Destructor. More...
 
virtual ImplKind implKind () const =0
 
virtual void increment ()=0
 Increment the iterator. More...
 
virtual bool isInRange () const =0
 
virtual const SetOrMapImplEntry< KE, VN > & getEntry () const =0
 

Detailed Description

template<typename KE, typename VN>
class Fw::SetOrMapImplConstIterator< KE, VN >

Definition at line 16 of file SetOrMapImplConstIterator.hpp.

Member Enumeration Documentation

◆ ImplKind

template<typename KE, typename VN>
enum Fw::SetOrMapImplConstIterator::ImplKind
strong

The kind of a const iterator implementation.

Enumerator
ARRAY 
RED_BLACK_TREE 

Definition at line 34 of file SetOrMapImplConstIterator.hpp.

Constructor & Destructor Documentation

◆ SetOrMapImplConstIterator()

template<typename KE, typename VN>
Fw::SetOrMapImplConstIterator< KE, VN >::SetOrMapImplConstIterator ( )
default

Zero-argument constructor.

◆ ~SetOrMapImplConstIterator()

template<typename KE, typename VN>
virtual Fw::SetOrMapImplConstIterator< KE, VN >::~SetOrMapImplConstIterator ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getEntry()

template<typename KE, typename VN>
virtual const SetOrMapImplEntry<KE, VN>& Fw::SetOrMapImplConstIterator< KE, VN >::getEntry ( ) const
pure virtual

Get the set or map impl entry pointed to by this iterator

Returns
The set or map impl entry

Implemented in Fw::RedBlackTreeSetOrMapImpl< KE, VN >::ConstIterator, and Fw::ArraySetOrMapImpl< KE, VN >::ConstIterator.

◆ implKind()

template<typename KE, typename VN>
virtual ImplKind Fw::SetOrMapImplConstIterator< KE, VN >::implKind ( ) const
pure virtual

Return the impl kind

Returns
The impl kind

Implemented in Fw::RedBlackTreeSetOrMapImpl< KE, VN >::ConstIterator, and Fw::ArraySetOrMapImpl< KE, VN >::ConstIterator.

◆ increment()

template<typename KE, typename VN>
virtual void Fw::SetOrMapImplConstIterator< KE, VN >::increment ( )
pure virtual

Increment the iterator.

Implemented in Fw::RedBlackTreeSetOrMapImpl< KE, VN >::ConstIterator, and Fw::ArraySetOrMapImpl< KE, VN >::ConstIterator.

◆ isInRange()

template<typename KE, typename VN>
virtual bool Fw::SetOrMapImplConstIterator< KE, VN >::isInRange ( ) const
pure virtual

Check whether the iterator is in range

Returns
True if the iterator is in range

Implemented in Fw::RedBlackTreeSetOrMapImpl< KE, VN >::ConstIterator, and Fw::ArraySetOrMapImpl< KE, VN >::ConstIterator.

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