F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Fw::SetBase< T > Class Template Referenceabstract

#include <Fw/DataStructures/SetBase.hpp>

Inheritance diagram for Fw::SetBase< T >:
Fw::SizedContainer Fw::ArraySet< T, C > Fw::ExternalArraySet< T > Fw::ExternalRedBlackTreeSet< T > Fw::RedBlackTreeSet< T, C >

Public Types

using ConstIterator = SetConstIterator< T >
 The type of a set const iterator. More...
 

Public Member Functions

virtual ConstIterator begin () const =0
 
virtual ConstIterator end () const =0
 
void copyDataFrom (const SetBase< T > &set)
 Copy data from another set. More...
 
virtual Success find (const T &element) const =0
 
virtual Success insert (const T &element)=0
 
virtual Success remove (const T &element)=0
 
- Public Member Functions inherited from Fw::SizedContainer
virtual void clear ()=0
 Clear the container. More...
 
virtual FwSizeType getSize () const =0
 
virtual FwSizeType getCapacity () const =0
 
bool isEmpty () const
 
bool isFull () const
 

Protected Member Functions

 SetBase ()
 Zero-argument constructor. More...
 
virtual ~SetBase ()=default
 Destructor. More...
 
- Protected Member Functions inherited from Fw::SizedContainer
 SizedContainer ()
 Zero-argument constructor. More...
 
virtual ~SizedContainer ()=default
 Destructor. More...
 

Detailed Description

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

Definition at line 18 of file SetBase.hpp.

Member Typedef Documentation

◆ ConstIterator

template<typename T >
using Fw::SetBase< T >::ConstIterator = SetConstIterator<T>

The type of a set const iterator.

Definition at line 39 of file SetBase.hpp.

Constructor & Destructor Documentation

◆ SetBase()

template<typename T >
Fw::SetBase< T >::SetBase ( )
inlineprotected

Zero-argument constructor.

Definition at line 47 of file SetBase.hpp.

◆ ~SetBase()

template<typename T >
virtual Fw::SetBase< T >::~SetBase ( )
protectedvirtualdefault

Destructor.

Member Function Documentation

◆ begin()

template<typename T >
virtual ConstIterator Fw::SetBase< T >::begin ( ) const
pure virtual

Get the begin iterator

Returns
The iterator

Implemented in Fw::ExternalRedBlackTreeSet< T >, Fw::ExternalArraySet< T >, Fw::RedBlackTreeSet< T, C >, and Fw::ArraySet< T, C >.

◆ copyDataFrom()

template<typename T >
void Fw::SetBase< T >::copyDataFrom ( const SetBase< T > &  set)
inline

Copy data from another set.

Definition at line 66 of file SetBase.hpp.

◆ end()

template<typename T >
virtual ConstIterator Fw::SetBase< T >::end ( ) const
pure virtual

◆ find()

template<typename T >
virtual Success Fw::SetBase< T >::find ( const T &  element) const
pure virtual

Find an element in a set SUCCESS if the item was found

Parameters
elementThe element

Implemented in Fw::ExternalRedBlackTreeSet< T >, Fw::ExternalArraySet< T >, Fw::RedBlackTreeSet< T, C >, and Fw::ArraySet< T, C >.

◆ insert()

template<typename T >
virtual Success Fw::SetBase< T >::insert ( const T &  element)
pure virtual

Insert an element in the set

Returns
SUCCESS if there is room in the set
Parameters
elementThe element

Implemented in Fw::ExternalRedBlackTreeSet< T >, Fw::ExternalArraySet< T >, Fw::RedBlackTreeSet< T, C >, and Fw::ArraySet< T, C >.

◆ remove()

template<typename T >
virtual Success Fw::SetBase< T >::remove ( const T &  element)
pure virtual

Remove an element from the set

Returns
SUCCESS if the element was there
Parameters
elementThe element

Implemented in Fw::ExternalRedBlackTreeSet< T >, Fw::ExternalArraySet< T >, Fw::RedBlackTreeSet< T, C >, and Fw::ArraySet< T, C >.


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