buffer< T, N > Class Template Reference

#include <bufferpp.hpp>

Inheritance diagram for buffer< T, N >:

Collaboration diagram for buffer< T, N >:

Public Member Functions
	buffer ()
	buffer (semaphore *sem)
void	clear ()
void	init ()
void	notify (const T data)
bool	add (const T data)
T	peek ()
T	get (bool &ok)
bool	full ()
bool	empty ()
uint32_t	length ()

Public Attributes
uint32_t	pos
uint32_t	len
semaphore *	sem
T	buf [N]
uint32_t	error_overflow
uint32_t	error_underflow

Detailed Description

template<typename T, uint32_t N>
class buffer< T, N >

Definition at line 16 of file bufferpp.hpp.

Constructor & Destructor Documentation

template<typename T, uint32_t N>

buffer< T, N >::buffer ( )

inline

Definition at line 20 of file bufferpp.hpp.

             {

        init();
    }

template<typename T, uint32_t N>

buffer< T, N >::buffer ( semaphore *  sem )

inline

Sem is only incremented on successful add

Definition at line 26 of file bufferpp.hpp.

                           {

        this->sem = sem;
        *(this->sem) = semaphore();
        init();
    }

Member Function Documentation

template<typename T, uint32_t N>

bool buffer< T, N >::add ( const T  data )

inline

warning: drops Ts if buffer is full

Definition at line 56 of file bufferpp.hpp.

Referenced by buffer< int32_t, N >::notify(), and shell::type().

                           {

        if (full()) {
            ++error_overflow;
            return false;
        }
        buf[pos++] = (T) data;
        return true;
    }

Here is the caller graph for this function:

template<typename T, uint32_t N>

void buffer< T, N >::clear ( )

inline

Definition at line 33 of file bufferpp.hpp.

Referenced by shell::clear_buffer(), buffer< int32_t, N >::init(), and shell::print_ps1().

                 {

        while(pos>0) {
            buf[--pos] = 0;
        }
    }

Here is the caller graph for this function:

template<typename T, uint32_t N>

bool buffer< T, N >::empty ( )

inline

Definition at line 101 of file bufferpp.hpp.

                 {

        return pos == 0;
    }

template<typename T, uint32_t N>

bool buffer< T, N >::full ( )

inline

Definition at line 96 of file bufferpp.hpp.

Referenced by buffer< int32_t, N >::add(), and shell::type().

                {

        return pos == len;
    }

Here is the caller graph for this function:

template<typename T, uint32_t N>

T buffer< T, N >::get ( bool &  ok )

inline

warning: returns 0 if no more Ts in buffer

Definition at line 76 of file bufferpp.hpp.

Referenced by shell::backspace(), and shell_handler().

                    {

        /* base case */
        if (pos <= 0) {
            ++error_underflow;
            ok = false;
            return 0;
        }

        /* normal operation */
        ok = true;

        T ret = buf[--pos];

        /*buf is always null-terminated*/
        buf[pos] = 0;

        return ret;
    }

Here is the caller graph for this function:

template<typename T, uint32_t N>

void buffer< T, N >::init ( )

inline

Definition at line 40 of file bufferpp.hpp.

Referenced by buffer< int32_t, N >::buffer().

                {
        error_overflow = 0;
        error_underflow = 0;
        pos = 0;
        len = N;
        clear();
    }

Here is the caller graph for this function:

template<typename T, uint32_t N>

uint32_t buffer< T, N >::length ( )

inline

Definition at line 106 of file bufferpp.hpp.

Referenced by shell::execute_command().

                      {

        return pos;
    }

Here is the caller graph for this function:

template<typename T, uint32_t N>

void buffer< T, N >::notify ( const T  data )

inline

Definition at line 48 of file bufferpp.hpp.

Referenced by UART0_Handler().

                              {

        if (add(data)) {
            sem->post();
        }
    }

Here is the caller graph for this function:

template<typename T, uint32_t N>

T buffer< T, N >::peek ( )

inline

Definition at line 66 of file bufferpp.hpp.

             {

        if (pos == 0) {
            return buf[len-1];
        } else {
            return buf[pos-1];
        }
    }

Member Data Documentation

template<typename T, uint32_t N>

T buffer< T, N >::buf[N]

Definition at line 115 of file bufferpp.hpp.

Referenced by circularbuffer< int16_t, 32 >::add(), buffer< int32_t, N >::add(), ir::average(), ping::average(), buffer< int32_t, N >::clear(), shell::execute_command(), circularbuffer< int16_t, 32 >::get(), buffer< int32_t, N >::get(), circularbuffer< int16_t, 32 >::peek(), and buffer< int32_t, N >::peek().

template<typename T, uint32_t N>

uint32_t buffer< T, N >::error_overflow

Definition at line 117 of file bufferpp.hpp.

Referenced by buffer< int32_t, N >::add(), and buffer< int32_t, N >::init().

template<typename T, uint32_t N>

uint32_t buffer< T, N >::error_underflow

Definition at line 118 of file bufferpp.hpp.

Referenced by buffer< int32_t, N >::get(), and buffer< int32_t, N >::init().

template<typename T, uint32_t N>

uint32_t buffer< T, N >::len

Definition at line 113 of file bufferpp.hpp.

Referenced by circularbuffer< int16_t, 32 >::add(), ping::average(), ir::average(), buffer< int32_t, N >::full(), circularbuffer< int16_t, 32 >::get(), buffer< int32_t, N >::init(), and buffer< int32_t, N >::peek().

template<typename T, uint32_t N>

uint32_t buffer< T, N >::pos

Definition at line 112 of file bufferpp.hpp.

Referenced by circularbuffer< int16_t, 32 >::add(), buffer< int32_t, N >::add(), buffer< int32_t, N >::clear(), buffer< int32_t, N >::empty(), buffer< int32_t, N >::full(), circularbuffer< int16_t, 32 >::get(), buffer< int32_t, N >::get(), buffer< int32_t, N >::init(), buffer< int32_t, N >::length(), circularbuffer< int16_t, 32 >::peek(), and buffer< int32_t, N >::peek().

template<typename T, uint32_t N>

semaphore* buffer< T, N >::sem

Definition at line 114 of file bufferpp.hpp.

Referenced by buffer< int32_t, N >::buffer(), and buffer< int32_t, N >::notify().

---

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

• board-progs/autonomous-racer/common/bufferpp.hpp