CircularBuffer.hpp

Go to the documentation of this file.

/*
 * CircularBuffer.hpp:
 *
 * Buffer used to efficiently store data in ring data structure. Uses an externally supplied
 * data store as the backing for this buffer. Thus it is dependent on receiving sole ownership
 * of the supplied buffer.
 *
 * Note: this given implementation loses one byte of the data store in order to ensure that a
 * separate wrap-around tracking variable is not needed.
 *
 *  Created on: Apr 4, 2019
 *      Author: lestarch
 *  Revised March 2022
 *      Author: bocchino
 */

#ifndef TYPES_CIRCULAR_BUFFER_HPP
#define TYPES_CIRCULAR_BUFFER_HPP

#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/Serializable.hpp>

namespace Types {

class CircularBuffer {
    friend class CircularBufferTester;

  public:
    CircularBuffer();

    CircularBuffer(U8* const buffer, const FwSizeType size);

    void setup(U8* const buffer, const FwSizeType size);

    Fw::SerializeStatus serialize(const U8* const buffer, const FwSizeType size);

    Fw::SerializeStatus peek(char& value, FwSizeType offset = 0) const;
    Fw::SerializeStatus peek(U8& value, FwSizeType offset = 0) const;
    Fw::SerializeStatus peek(U32& value, FwSizeType offset = 0) const;

    Fw::SerializeStatus peek(U8* buffer, FwSizeType size, FwSizeType offset = 0) const;

    Fw::SerializeStatus rotate(FwSizeType amount);

    FwSizeType get_allocated_size() const;

    FwSizeType get_free_size() const;

    FwSizeType get_capacity() const;

    FwSizeType get_high_water_mark() const;

    void clear_high_water_mark();

  private:
    FwSizeType advance_idx(FwSizeType idx, FwSizeType amount = 1) const;
    U8* m_store;
    FwSizeType m_store_size;
    FwSizeType m_head_idx;
    FwSizeType m_allocated_size;
    FwSizeType m_high_water_mark;
};
}  // End Namespace Types
#endif