Embedded Template Library  1.0
 All Classes Files Functions Variables Typedefs Friends Modules Pages
etl::queue< T, SIZE > Class Template Reference

#include <queue.h>

Public Member Functions

 queue ()
 Default constructor.
 
void swap (queue &other)
 Swap.
 
- Public Member Functions inherited from etl::iqueue< T >
reference front ()
 
const_reference front () const
 
reference back ()
 
const_reference back () const
 
void push (parameter_t item)
 
reference push ()
 
- Public Member Functions inherited from etl::queue_base
size_type size () const
 Returns the current number of items in the queue.
 
size_type capacity () const
 Returns the maximum number of items that can be queued.
 
size_type max_size () const
 Returns the maximum number of items that can be queued.
 
bool empty () const
 
bool full () const
 
size_t available () const
 
void clear ()
 Clears the queue to the empty state.
 
void pop ()
 

Additional Inherited Members

- Public Types inherited from etl::iqueue< T >
typedef T value_type
 The type stored in the queue.
 
typedef T & reference
 A reference to the type used in the queue.
 
typedef const T & const_reference
 A const reference to the type used in the queue.
 
typedef T * pointer
 A pointer to the type used in the queue.
 
typedef const T * const_pointer
 A const pointer to the type used in the qu.
 
typedef queue_base::size_type size_type
 The type used for determining the size of the queue.
 
- Public Types inherited from etl::queue_base
typedef size_t size_type
 The type used for determining the size of queue.
 
- Protected Member Functions inherited from etl::iqueue< T >
 iqueue (T *buffer, size_type max_size)
 The constructor that is called from derived classes.
 
- Protected Member Functions inherited from etl::queue_base
 queue_base (size_type max_size)
 The constructor that is called from derived classes.
 
- Protected Attributes inherited from etl::queue_base
size_type in
 Where to input new data.
 
size_type out
 Where to get the oldest data.
 
size_type current_size
 The number of items in the queue.
 
const size_type MAX_SIZE
 The maximum number of items in the queue.
 

Detailed Description

template<typename T, const size_t SIZE>
class etl::queue< T, SIZE >

A fixed capacity queue. This queue does not support concurrent access by different threads.

Template Parameters
TThe type this queue should support.
SIZEThe maximum capacity of the queue.

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