main_ubi_sdk v 0.1.3
This is UBI4 documentation
RingBuffer< SIZE, DATA_T > Class Template Reference

#include <FIFO.h>

Public Types

typedef uint16_t INDEX_T
 

Public Member Functions

bool Write (DATA_T value)
 
bool Read (DATA_T &value)
 
DATA_T First () const
 
DATA_T Last () const
 
DATA_T & operator[] (INDEX_T i)
 
const DATA_T operator[] (INDEX_T i) const
 
bool IsEmpty () const
 
bool IsFull () const
 
INDEX_T Count () const
 
void Clear ()
 
unsigned Size ()
 

Member Typedef Documentation

◆ INDEX_T

template<int SIZE, class DATA_T = unsigned char>
typedef uint16_t INDEX_T

Member Function Documentation

◆ Clear()

template<int SIZE, class DATA_T = unsigned char>
void Clear ( )
inline

◆ Count()

template<int SIZE, class DATA_T = unsigned char>
INDEX_T Count ( ) const
inline
Here is the caller graph for this function:

◆ First()

template<int SIZE, class DATA_T = unsigned char>
DATA_T First ( ) const
inline
Here is the call graph for this function:

◆ IsEmpty()

template<int SIZE, class DATA_T = unsigned char>
bool IsEmpty ( ) const
inline
Here is the caller graph for this function:

◆ IsFull()

template<int SIZE, class DATA_T = unsigned char>
bool IsFull ( ) const
inline
Here is the caller graph for this function:

◆ Last()

template<int SIZE, class DATA_T = unsigned char>
DATA_T Last ( ) const
inline
Here is the call graph for this function:

◆ operator[]() [1/2]

template<int SIZE, class DATA_T = unsigned char>
DATA_T & operator[] ( INDEX_T i)
inline
Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator[]() [2/2]

template<int SIZE, class DATA_T = unsigned char>
const DATA_T operator[] ( INDEX_T i) const
inline
Here is the call graph for this function:

◆ Read()

template<int SIZE, class DATA_T = unsigned char>
bool Read ( DATA_T & value)
inline
Here is the call graph for this function:

◆ Size()

template<int SIZE, class DATA_T = unsigned char>
unsigned Size ( )
inline

◆ Write()

template<int SIZE, class DATA_T = unsigned char>
bool Write ( DATA_T value)
inline
Here is the call graph for this function:

The documentation for this class was generated from the following file: