MapBase.hpp

Go to the documentation of this file.

// ======================================================================
// \title  MapBase
// \author bocchino
// \brief  An abstract base class template for a map
// ======================================================================

#ifndef Fw_MapBase_HPP
#define Fw_MapBase_HPP

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

namespace Fw {

template <typename K, typename V>
class MapBase : public SizedContainer {
  private:
    // ----------------------------------------------------------------------
    // Deleted elements
    // ----------------------------------------------------------------------

    MapBase(const MapBase<K, V>&) = delete;

    MapBase<K, V>& operator=(const MapBase<K, V>&) = delete;

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

    using ConstIterator = MapConstIterator<K, V>;

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

    MapBase() : SizedContainer() {}

    virtual ~MapBase() = default;

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

    virtual ConstIterator begin() const = 0;

    void copyDataFrom(const MapBase<K, V>& map) {
        if (&map != this) {
            this->clear();
            const FwSizeType size = FW_MIN(map.getSize(), this->getCapacity());
            auto it = map.begin();
            for (FwSizeType i = 0; i < size; i++) {
                const auto status = this->insert(it->getKey(), it->getValue());
                FW_ASSERT(status == Success::SUCCESS, static_cast<FwAssertArgType>(status));
                it++;
            }
        }
    }

    virtual ConstIterator end() const = 0;

    virtual Success find(const K& key,  
                         V& value       
    ) const = 0;

    virtual Success insert(const K& key,   
                           const V& value  
                           ) = 0;
    virtual Success remove(const K& key,  
                           V& value       
                           ) = 0;
};

}  // namespace Fw

#endif