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
 */
#include <FpConfig.hpp>
#include <Fw/Types/BasicTypes.hpp>
#include <Fw/Types/Serializable.hpp>
 
#ifndef TYPES_CIRCULAR_BUFFER_HPP
#define TYPES_CIRCULAR_BUFFER_HPP
 
//#define CIRCULAR_DEBUG
 
// An assertion to guarantee the self-consistency of a head/tail pointer w.r.t. the store and size
#define ASSERT_CONSISTENT(store, size, X) \
    FW_ASSERT(X >= store && X < (store + size), \
              reinterpret_cast<POINTER_CAST>(X), \
              reinterpret_cast<POINTER_CAST>(store))
 
namespace Types {
 
class CircularBuffer {
    public:
        CircularBuffer(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);
        Fw::SerializeStatus peek(U8& value, NATIVE_UINT_TYPE offset = 0);
        Fw::SerializeStatus peek(U32& value, NATIVE_UINT_TYPE offset = 0);
 
        Fw::SerializeStatus peek(U8* buffer, NATIVE_UINT_TYPE size, NATIVE_UINT_TYPE offset = 0);
 
        Fw::SerializeStatus rotate(NATIVE_UINT_TYPE amount);
 
        NATIVE_UINT_TYPE get_remaining_size(bool serialization = false);
 
        NATIVE_UINT_TYPE get_capacity();
 
#ifdef CIRCULAR_DEBUG
        void print();
#endif
    private:
        U8* increment(U8* const pointer, NATIVE_UINT_TYPE amount = 1);
        U8* const m_store;
        const NATIVE_UINT_TYPE m_size;
        U8* m_head;
        U8* m_tail;
};
} //End Namespace Types
#endif