Embedded Template Library  1.0
 All Classes Files Functions Variables Typedefs Friends Modules Pages
etl::deque_base Class Reference

#include <deque_base.h>

Public Types

typedef size_t size_type
 

Public Member Functions

size_type size () const
 
bool empty () const
 
bool full () const
 
size_type capacity () const
 
size_type max_size () const
 
size_t available () const
 
void clear ()
 Clears the deque.
 

Protected Member Functions

 deque_base (size_t max_size, size_t buffer_size)
 Constructor.
 

Protected Attributes

size_type current_size
 The current number of elements in the deque.
 
const size_type MAX_SIZE
 The maximum number of elements in the deque.
 
const size_type BUFFER_SIZE
 The of elements in the buffer.
 

Detailed Description

The base class for all templated deque types.

Member Function Documentation

size_t etl::deque_base::available ( ) const
inline

Returns the remaining capacity.

Returns
The remaining capacity.
size_type etl::deque_base::capacity ( ) const
inline

Returns the capacity of the deque.

Returns
The capacity of the deque.
bool etl::deque_base::empty ( ) const
inline

Checks the 'empty' state of the deque.

Returns
true if empty.
bool etl::deque_base::full ( ) const
inline

Checks the 'full' state of the deque.

Returns
true if full.
size_type etl::deque_base::max_size ( ) const
inline

Returns the maximum possible size of the deque.

Returns
The maximum size of the deque.
size_type etl::deque_base::size ( ) const
inline

Gets the current size of the deque.

Returns
The current size of the deque.

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