fifo.hpp

Go to the documentation of this file.

/*****************************************************************************
** Ifdefs
*****************************************************************************/

#ifndef ECL_CONTAINERS_FIFO_HPP_
#define ECL_CONTAINERS_FIFO_HPP_

/*****************************************************************************
** Includes
*****************************************************************************/

#include <algorithm> // std::copy
#include <ecl/config/macros.hpp>
#include <ecl/errors/compile_time_assert.hpp>
#include <ecl/exceptions/standard_exception.hpp>
#include "array.hpp"

/*****************************************************************************
** Namespaces
*****************************************************************************/

namespace ecl {

/*****************************************************************************
** Interface
*****************************************************************************/
template<typename T>
class ECL_PUBLIC FiFo
{
public:
        FiFo( const unsigned int length = 0 ) :
                size_fifo(length),
                running_index(0)
        {
                if ( size_fifo > 0 ) {
                        data.resize( size_fifo );
                }
        }

        FiFo( const unsigned int length, const T &value ) :
                size_fifo(length),
                running_index(0)
        {
                if ( size_fifo > 0 ) {
                        data = Array<T>::Constant(size_fifo,value);
                }
        }
        virtual ~FiFo() {} 
        T & operator[] (int idx) {
                return data[ ((running_index+idx)%size_fifo) ];
        }

        const T & operator[] (int idx) const {
                return data[ ((running_index+idx)%size_fifo) ];
        }

        void push_back( const T & datum ) {
                data[ running_index++ ] = datum;
                running_index %= size_fifo;
        }

        void fill( const T & value ) {
                for( unsigned int i=0; i<size_fifo; i++ ) data[i] = value;
        }

        unsigned int get_idx() { return running_index;}

        void resize( unsigned int length ) ecl_assert_throw_decl(StandardException) {
                size_fifo = length;
                ecl_assert_throw( (size_fifo>0), StandardException(LOC, OutOfRangeError, "SimpleFIFO start with zero size buffer"));
                data.resize( size_fifo );
        }

private:
        ecl::Array <T>data;
        unsigned int size_fifo;
        unsigned int running_index;
};

} // namespace ecl

#endif /* ECL_CONTAINERS_FIFO_HPP_ */