SizedContainer.hpp

Go to the documentation of this file.

// ======================================================================
// \title  SizedContainer
// \author bocchino
// \brief  An abstract base class representing a sized container
// ======================================================================

#ifndef Fw_SizedContainer_HPP
#define Fw_SizedContainer_HPP

#include "Fw/FPrimeBasicTypes.hpp"

namespace Fw {

class SizedContainer {
  private:
    // ----------------------------------------------------------------------
    // Private constructors
    // ----------------------------------------------------------------------

    SizedContainer(const SizedContainer&) = delete;

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

    SizedContainer() {}

    virtual ~SizedContainer() = default;

  private:
    // ----------------------------------------------------------------------
    // Private member functions
    // ----------------------------------------------------------------------

    SizedContainer& operator=(const SizedContainer&) = delete;

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

    virtual void clear() = 0;

    virtual FwSizeType getSize() const = 0;

    virtual FwSizeType getCapacity() const = 0;

    bool isEmpty() const { return this->getSize() == 0; }

    bool isFull() const { return this->getSize() >= this->getCapacity(); }
};

}  // namespace Fw

#endif