CircularIndex.hpp

Go to the documentation of this file.

// ======================================================================
// \file   CircularIndex.hpp
// \author bocchino
// \brief  An index value that wraps around modulo an integer
// ======================================================================

#ifndef Fw_CircularIndex_HPP
#define Fw_CircularIndex_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/Assert.hpp"

namespace Fw {

class CircularIndex final {
  public:
    // ----------------------------------------------------------------------
    // Public constructors and destructors
    // ----------------------------------------------------------------------

    CircularIndex() : m_value(0), m_modulus(1) {}

    explicit CircularIndex(FwSizeType modulus,   
                           FwSizeType value = 0  
                           )
        : m_modulus(modulus) {
        FW_ASSERT(modulus > 0);
        this->setValue(value);
    }

    CircularIndex(const CircularIndex& ci) { *this = ci; }

    ~CircularIndex() = default;

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

    CircularIndex& operator=(const CircularIndex& ci) {
        if (this != &ci) {
            this->m_value = ci.m_value;
            this->m_modulus = ci.m_modulus;
        }
        return *this;
    }

    FwSizeType getValue() const {
        FW_ASSERT(this->m_value < this->m_modulus);
        return this->m_value;
    }

    void setValue(FwSizeType value  
    ) {
        FW_ASSERT(this->m_modulus > 0);
        this->m_value = value % this->m_modulus;
    }

    FwSizeType getModulus() const {
        FW_ASSERT(this->m_value < this->m_modulus);
        return this->m_modulus;
    }

    void setModulus(FwSizeType modulus  
    ) {
        this->m_modulus = modulus;
        this->setValue(this->m_value);
    }

    FwSizeType increment(FwSizeType amount = 1  
    ) {
        FW_ASSERT(this->m_modulus > 0);
        const FwSizeType offset = amount % m_modulus;
        this->setValue(this->m_value + offset);
        return this->m_value;
    }

    FwSizeType decrement(FwSizeType amount = 1  
    ) {
        FW_ASSERT(this->m_modulus > 0);
        const FwSizeType offset = amount % this->m_modulus;
        this->setValue(this->m_value + this->m_modulus - offset);
        return this->m_value;
    }

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

    FwSizeType m_value;

    FwSizeType m_modulus;
};

}  // namespace Fw

#endif