 |
WarpTwin
Documentation for WarpTwin models and classes.
|
|
WarpTwin
Documentation for WarpTwin models and classes.
|
Simple Circular Buffer for data storage. More...
#include <CircularBuffer.hpp>
Public Member Functions | |
| CircularBuffer () | |
| int16 | write (const T &instance) |
| Write a single data item into the buffer. | |
| int16 | writeBuffer (const T *buffer, uint32 size) |
| Write a buffer of data items into the buffer. | |
| Public Member Functions inherited from clockwerk::Queue< T, L > | |
| Queue () | |
| int16 | write (const T &instance) |
| Write a single data item into the queue. | |
| int16 | writeBuffer (const T *buffer, uint32 size) |
| Write a buffer of data items into the queue. | |
| int16 | read (T &instance) |
| Read item from the queue and increment the read pointer. | |
| int16 | readBuffer (T *buffer, uint32 max_vals, uint32 &num_vals_read) |
| Read items from the queue into buffer and increment read pointer. | |
| int16 | pop () |
| Function to pop one value from the queue and discard it. | |
| int16 | popBuffer (uint32 max_vals, uint32 &num_vals_popped) |
| Function to pop a specified number of values from the queue. | |
| int16 | peek (T &instance) |
| Read item from the queue without incrementing the read pointer. | |
| int16 | peekIndex (uint32 index, T &instance) |
| Peek index relative to the read pointer without incrementing the read pointer. | |
| int16 | peekBuffer (T *buffer, uint32 max_vals, uint32 &num_vals_read) |
| Read items from the queue without incrementing the read pointer. | |
| void | clear () |
| Clear the queue entirely. | |
| uint32 | valsAvailable () |
| Get number of spaces in queue. | |
| uint32 | valsHeld () |
| Get the number of values held by the queue. | |
Additional Inherited Members | |
| Protected Attributes inherited from clockwerk::Queue< T, L > | |
| uint32 | _write_idx = 0 |
| Index to which new data should write. | |
| uint32 | _read_idx = 0 |
| Index from which data should be read. | |
| uint32 | _vals_available = L |
| Number of values available in the queue. | |
| T | _buffer [L] |
| Data buffer to hold everything stored in the Queue. | |
Simple Circular Buffer for data storage.
The Circular Buffer class is a simple, templated, first in first out buffer with modifiable type and size that overwrites when it reaches its max.
|
inline |
| int16 clockwerk::CircularBuffer< T, L >::write | ( | const T & | instance | ) |
Write a single data item into the buffer.
| instance | The instance to write into the buffer |
| int16 clockwerk::CircularBuffer< T, L >::writeBuffer | ( | const T * | buffer, |
| uint32 | size ) |
Write a buffer of data items into the buffer.
| buffer | The buffer of data to write into the buffer |
| size | The number of items to write into the buffer |
1.16.1