arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
QueueFromVector< T > Class Template Reference

FIFO Queue which is based on a Vector. More...

#include <QueueFromVector.h>

Public Member Functions

 QueueFromVector (size_t size, T empty)
 
size_t capacity ()
 
bool clear ()
 
bool dequeue (T &data)
 
bool empty ()
 
bool enqueue (T &data)
 
bool is_full ()
 
bool peek (T &data)
 
bool resize (size_t size)
 
void setAllocator (Allocator &allocator)
 
size_t size ()
 
Vector< T > & toVector ()
 

Protected Attributes

int32_t _end_pos = 0
 
null_value
 
Vector< T > vector
 

Detailed Description

template<class T>
class audio_tools::QueueFromVector< T >

FIFO Queue which is based on a Vector.

Author
Phil Schatzmann
Template Parameters
T

Constructor & Destructor Documentation

◆ QueueFromVector()

template<class T >
QueueFromVector ( size_t  size,
empty 
)
inline

Member Function Documentation

◆ capacity()

template<class T >
size_t capacity ( )
inline

◆ clear()

template<class T >
bool clear ( )
inline

◆ dequeue()

template<class T >
bool dequeue ( T &  data)
inline

◆ empty()

template<class T >
bool empty ( )
inline

◆ enqueue()

template<class T >
bool enqueue ( T &  data)
inline

◆ is_full()

template<class T >
bool is_full ( )
inline

◆ peek()

template<class T >
bool peek ( T &  data)
inline

◆ resize()

template<class T >
bool resize ( size_t  size)
inline

Grows or shrinks the queue's capacity, keeping any queued elements. If shrinking below the number of currently queued elements, the newest ones (that no longer fit) are dropped.

◆ setAllocator()

template<class T >
void setAllocator ( Allocator allocator)
inline

◆ size()

template<class T >
size_t size ( )
inline

◆ toVector()

template<class T >
Vector< T > & toVector ( )
inline

Member Data Documentation

◆ _end_pos

template<class T >
int32_t _end_pos = 0
protected

◆ null_value

template<class T >
T null_value
protected

◆ vector

template<class T >
Vector<T> vector
protected

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