FifoQueue.hpp

Go to the documentation of this file.

// ======================================================================
// \file   FifoQueue.hpp
// \author bocchino
// \brief  A FIFO queue with internal storage
// ======================================================================

#ifndef Fw_FifoQueue_HPP
#define Fw_FifoQueue_HPP

#include "Fw/DataStructures/Array.hpp"
#include "Fw/DataStructures/ExternalFifoQueue.hpp"

namespace Fw {

template <typename T, FwSizeType C>
class FifoQueue final : public FifoQueueBase<T> {
    // ----------------------------------------------------------------------
    // Static assertions
    // ----------------------------------------------------------------------

    static_assert(std::is_default_constructible<T>::value, "T must be default constructible");
    static_assert(C > 0, "capacity must be greater than zero");

    // ----------------------------------------------------------------------
    // Friend class for testing
    // ----------------------------------------------------------------------

    template <typename TT, FwSizeType CC>
    friend class FifoQueueTester;

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

    FifoQueue() : FifoQueueBase<T>(), m_extQueue(m_items, C) {}

    FifoQueue(const FifoQueue<T, C>& queue) : FifoQueueBase<T>(), m_extQueue(m_items, C) { *this = queue; }

    ~FifoQueue() override = default;

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

    FifoQueue<T, C>& operator=(const FifoQueue<T, C>& queue) {
        this->m_extQueue.copyDataFrom(queue);
        return *this;
    }

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

    Success enqueue(const T& e  
                    ) override {
        return this->m_extQueue.enqueue(e);
    }

    Success dequeue(T& e  
                    ) override {
        return this->m_extQueue.dequeue(e);
    }

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

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

    const T& at(FwSizeType index  
    ) const override {
        return this->m_extQueue.at(index);
    }

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

    ExternalFifoQueue<T> m_extQueue = {};

    T m_items[C] = {};
};

}  // namespace Fw

#endif