Class daisy::RingBuffer< T, 0 >¶
template <typename T>
ClassList > daisy > RingBuffer< T, 0 >
#include <ringbuffer.h>
Public Functions¶
| Type | Name |
|---|---|
| void | Advance (size_t num_elements) |
| void | Flush () |
| T * | GetMutableBuffer () |
| T | ImmediateRead () |
| void | ImmediateRead (T * destination, size_t num_elements) |
| void | Init () |
| void | Overwrite (T v) |
| void | Overwrite (const T * source, size_t num_elements) |
| T | Read () |
| RingBuffer () |
|
| void | Swallow (size_t n) |
| void | Write (T v) |
| size_t | capacity () const |
| bool | isEmpty () const |
| size_t | readable () const |
| size_t | writable () const |
Detailed Description¶
Utility Ring Buffer imported from pichenettes/stmlib
Public Functions Documentation¶
function Advance¶
Advances the write pointer, for when a peripheral is writing to the buffer.
function Flush¶
Flush the buffer
function GetMutableBuffer¶
Returns a pointer to the actual Ring Buffer Useful for when a peripheral needs direct access to the buffer.
function ImmediateRead [½]¶
Returns:
Read value
function ImmediateRead [2/2]¶
Parameters:
destination&num_elements&
function Init¶
Initialize ringbuffer
function Overwrite [½]¶
Parameters:
vValue to overwrite
function Overwrite [2/2]¶
Parameters:
source3num_elements&
function Read¶
Returns:
Read value
function RingBuffer¶
function Swallow¶
Read enough samples to make it possible to read 1 sample.
Parameters:
nSize of T ?
function Write¶
Parameters:
vValue to write
function capacity¶
Returns:
0
function isEmpty¶
Returns:
True, if the buffer is empty.
function readable¶
Returns:
0
function writable¶
Returns:
0
The documentation for this class was generated from the following file external-docs/libDaisy/src/util/ringbuffer.h