AviateTypes.h

Go to the documentation of this file.

/**************************************************************************/
#ifndef AVIATE_AVIATETYPES_H_
#define AVIATE_AVIATETYPES_H_
 
#include "Aviate/Aviate.h"
 
namespace Aviate {
 
/**************************************************************************/
template <class T>
class AVIATE_API RingBuffer {
public:
    RingBuffer() = delete;
 
    RingBuffer(const size_t maxSize) : m_maxSize(maxSize) {
        m_buffer = new T[maxSize]();
    }
    virtual ~RingBuffer(){
        if (m_buffer) delete [] m_buffer;
    }
 
    int push_back(T element) {
 
        if ( (m_head == m_tail) && (m_size > 0) ) {
            // overflow
            return -1;
        }
 
        m_buffer[m_head] = element;
        if (m_head < (m_maxSize-1) ) {
            m_head++;
        } else {
            m_head = 0;
        }
        m_size++;
 
        return 0;
    }
 
    int pop_front() {
 
        if (m_size == 0) {
            // buffer is empty
            return -1;
        }
        if (m_tail < m_maxSize-1) {
            m_tail++;
        } else {
            m_tail = 0;
        }
        m_size--;
        return 0;
    }
 
    T front() const {
        return m_buffer[m_tail];
    }
 
    T back() const {
        return m_buffer[m_head-1];
    }
 
    size_t get_index_from_back(size_t offset = 0) const {
        // the target at m_head - 1 - offset or m_maxSize + m_head -1 - offset;
        size_t idx = (m_maxSize + m_head -1 - offset);
 
        if ( idx >= m_maxSize) {
            idx -= m_maxSize;
        }
 
        return idx;
    }
 
    size_t size() const {
        return m_size;
    }
 
    size_t max_size() const {
        return m_maxSize;
    }
 
    T& operator[] (size_t index) {
        return m_buffer[index];
    }
 
    T at(size_t index) const {
        return m_buffer[index];
    }
 
private:
    size_t m_head=0;        
    size_t m_tail=0;        
    size_t m_size=0;        
    T *m_buffer = nullptr;  
    const size_t m_maxSize; 
};
 
} // namespace Aviate
 
 
#endif /* AVIATE_AVIATETYPES_H_ */