SetBase.hpp

Go to the documentation of this file.

// ======================================================================
// \title  SetBase
// \author bocchino
// \brief  An abstract base class template for a set
// ======================================================================

#ifndef Fw_SetBase_HPP
#define Fw_SetBase_HPP

#include "Fw/DataStructures/SetConstIterator.hpp"
#include "Fw/DataStructures/SizedContainer.hpp"
#include "Fw/Types/Assert.hpp"
#include "Fw/Types/SuccessEnumAc.hpp"

namespace Fw {

template <typename T>
class SetBase : public SizedContainer {
  private:
    // ----------------------------------------------------------------------
    // Deleted elements
    // ----------------------------------------------------------------------

    SetBase(const SetBase<T>&) = delete;

    SetBase<T>& operator=(const SetBase<T>&) = delete;

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

    using ConstIterator = SetConstIterator<T>;

  protected:
    // ----------------------------------------------------------------------
    // Protected constructors and destructors
    // ----------------------------------------------------------------------

    SetBase() : SizedContainer() {}

    virtual ~SetBase() = default;

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

    virtual ConstIterator begin() const = 0;

    virtual ConstIterator end() const = 0;

    void copyDataFrom(const SetBase<T>& set) {
        if (&set != this) {
            this->clear();
            const FwSizeType size = FW_MIN(set.getSize(), this->getCapacity());
            auto it = set.begin();
            for (FwSizeType i = 0; i < size; i++) {
                const auto status = this->insert(*it);
                FW_ASSERT(status == Success::SUCCESS, static_cast<FwAssertArgType>(status));
                it++;
            }
        }
    }

    virtual Success find(const T& element  
    ) const = 0;

    virtual Success insert(const T& element  
                           ) = 0;

    virtual Success remove(const T& element  
                           ) = 0;
};

}  // namespace Fw

#endif