Queue< T > Class Template Reference

Public Member Functions
void	init (T *list, uint8_t size)
error_t	add (T item)
error_t	pop (T &item)
bool	isFull ()
bool	isEmpty ()
uint8_t	getLength ()
error_t	peek (T &item)

Member Function Documentation

add()

template<class T>

error_t Queue< T >::add ( T item )

inline

                      {
    if (this->length == this->size) {
      return ERROR_FAIL;
    } else {
      uint8_t nextTail = (this->tail + 1) % this->size;
      this->list[this->tail] = item;
      this->tail = nextTail;
      this->length++;
      return ERROR_SUCCESS;
    }
  }

getLength()

template<class T>

uint8_t Queue< T >::getLength ( )

inline

                      {
    return this->length;
  }

init()

template<class T>

void Queue< T >::init ( T * list, uint8_t size )

inline

                                   {
    this->list = list;
    this->size = size;
    this->head = 0;
    this->tail = 0;
    this->length = 0;
  }

isEmpty()

template<class T>

bool Queue< T >::isEmpty ( )

inline

                 {
    return (this->length == 0) ? true : false;
  }

isFull()

template<class T>

bool Queue< T >::isFull ( )

inline

                {
    return (this->length == this->size) ? true : false;
  }

peek()

template<class T>

error_t Queue< T >::peek ( T & item )

inline

                        {
    if (this->length > 0) {
      item = this->list[this->head];
      return ERROR_SUCCESS;
    } else {
      return ERROR_FAIL;
    }
  }

pop()

template<class T>

error_t Queue< T >::pop ( T & item )

inline

                       {
    error_t err = peek(item);
    if (err == ERROR_SUCCESS) {
      this->head = (this->head + 1) % this->size;
      this->length--;
    }
 
    return err;
  }

---

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

• include/Queue.hpp