a

Dependencies:   mbed mbed-rtos

Embed: (wiki syntax)

« Back to documentation index

CQueue< T, N > Class Template Reference

CQueue< T, N > Class Template Reference

It is used for executing queue container. More...

#include <queue.hpp>

Public Member Functions

 CQueue ()
 Queue Class constructor.
virtual ~CQueue ()
 Queue Class destructor.
bool isFull ()
 Is full method.
bool isEmpty ()
 Is empty method.
peek ()
 Peek method.
pop ()
 Pop method.
unsigned int getSize ()
 Get size method.
void push (T &f_char)
 Push method.
void push (T *f_char, unsigned int f_len)
 Push method.
void empty ()
 Empty queue method.

Detailed Description

template<class T, unsigned int N>
class CQueue< T, N >

It is used for executing queue container.

Template Parameters:
TThe type of the varieble
NThe size of the queue

Definition at line 24 of file queue.hpp.


Constructor & Destructor Documentation

CQueue (  )

Queue Class constructor.

Constructor method

Definition at line 19 of file queue.inl.

~CQueue (  ) [virtual]

Queue Class destructor.

Destructor method

Definition at line 34 of file queue.inl.


Member Function Documentation

void empty (  )

Empty queue method.

Returns:
None

Definition at line 148 of file queue.inl.

unsigned int getSize (  )

Get size method.

Returns the size of the queue

Returns:
Queue size

Definition at line 137 of file queue.inl.

bool isEmpty (  )

Is empty method.

Returns:
True if Queue EMPTY

Definition at line 55 of file queue.inl.

bool isFull (  )

Is full method.

Returns:
True if Queue FULL

Definition at line 44 of file queue.inl.

T peek (  )

Peek method.

Returns:
Value on top of queue

Definition at line 66 of file queue.inl.

T pop (  )

Pop method.

Method for removing the item on top of the queue and returning it

Returns:
Element at top of the queue

Definition at line 79 of file queue.inl.

void push ( T *  f_char,
unsigned int  f_len 
)

Push method.

Method for inserting a sequence of items on top of the queue

Parameters:
f_charpointer to element to be added to the queue
f_lennumber of elements to be added
Returns:
None

Definition at line 121 of file queue.inl.

void push ( T &  f_char )

Push method.

Method for inserting an item on top of the queue

Parameters:
f_charelement to be added to the queue
Returns:
None

Definition at line 102 of file queue.inl.