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 <FpConfig.hpp>
#include <Fw/Types/Serializable.hpp>

namespace Types {

class CircularBuffer {
    public:
        CircularBuffer();

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

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

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

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

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

        Fw::SerializeStatus rotate(NATIVE_UINT_TYPE amount);

        NATIVE_UINT_TYPE get_allocated_size() const;

        NATIVE_UINT_TYPE get_free_size() const;

        NATIVE_UINT_TYPE get_capacity() const;

        NATIVE_UINT_TYPE get_high_water_mark() const;

        void clear_high_water_mark();

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