ExternalArraySet.hpp

Go to the documentation of this file.

// ======================================================================
// \file   ExternalArraySet.hpp
// \author bocchino
// \brief  An array-based set with external storage
// ======================================================================

#ifndef Fw_ExternalArraySet_HPP
#define Fw_ExternalArraySet_HPP

#include "Fw/DataStructures/ArraySetOrMapImpl.hpp"
#include "Fw/DataStructures/Nil.hpp"
#include "Fw/DataStructures/SetBase.hpp"
#include "Fw/Types/Assert.hpp"

namespace Fw {

template <typename T>
class ExternalArraySet final : public SetBase<T> {
    // ----------------------------------------------------------------------
    // Friend class for testing
    // ----------------------------------------------------------------------

    template <typename TT>
    friend class ExternalArraySetTester;

  public:
    // ----------------------------------------------------------------------
    // Public types
    // ----------------------------------------------------------------------

    using ConstIterator = SetConstIterator<T>;

    using Entry = SetOrMapImplEntry<T, Nil>;

  public:
    // ----------------------------------------------------------------------
    // Public constructors and destructors
    // ----------------------------------------------------------------------

    ExternalArraySet() = default;

    ExternalArraySet(Entry* entries,      
                     FwSizeType capacity  
                     )
        : SetBase<T>() {
        this->setStorage(entries, capacity);
    }

    ExternalArraySet(ByteArray data,      
                     FwSizeType capacity  
                     )
        : SetBase<T>() {
        this->setStorage(data, capacity);
    }

    ExternalArraySet(const ExternalArraySet<T>& set) : SetBase<T>() { *this = set; }

    ~ExternalArraySet() override = default;

  public:
    // ----------------------------------------------------------------------
    // Public member functions
    // ----------------------------------------------------------------------

    ExternalArraySet<T>& operator=(const ExternalArraySet<T>& set) {
        if (&set != this) {
            this->m_impl = set.m_impl;
        }
        return *this;
    }

    ConstIterator begin() const override { return ConstIterator(this->m_impl.begin()); }

    void clear() override { this->m_impl.clear(); }

    ConstIterator end() const override { return ConstIterator(this->m_impl.end()); }

    Success find(const T& element  
    ) const override {
        Nil nil = {};
        return this->m_impl.find(element, nil);
    }

    FwSizeType getCapacity() const override { return this->m_impl.getCapacity(); }

    FwSizeType getSize() const override { return this->m_impl.getSize(); }

    Success insert(const T& element  
                   ) override {
        return this->m_impl.insert(element, Nil());
    }

    Success remove(const T& element  
                   ) override {
        Nil nil = {};
        return this->m_impl.remove(element, nil);
    }

    void setStorage(Entry* entries,      
                    FwSizeType capacity  
    ) {
        this->m_impl.setStorage(entries, capacity);
    }

    void setStorage(ByteArray data,      
                    FwSizeType capacity  
    ) {
        this->m_impl.setStorage(data, capacity);
    }

  public:
    // ----------------------------------------------------------------------
    // Public static functions
    // ----------------------------------------------------------------------

    static constexpr U8 getByteArrayAlignment() { return ArraySetOrMapImpl<T, Nil>::getByteArrayAlignment(); }

    static constexpr FwSizeType getByteArraySize(FwSizeType capacity  
    ) {
        return ArraySetOrMapImpl<T, Nil>::getByteArraySize(capacity);
    }

  private:
    // ----------------------------------------------------------------------
    // Private member variables
    // ----------------------------------------------------------------------

    ArraySetOrMapImpl<T, Nil> m_impl = {};
};

}  // namespace Fw

#endif