CircBuffer.hpp

/*
 * CircBuffer.hpp
 * 
 * Copyright 2018 Fernando Pujaico Rivera <fernando.pujaico.rivera@gmail.com>
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 * 
 */
 
#ifndef __PDS_CIRCBUFFER_HPP__
#define __PDS_CIRCBUFFER_HPP__
 
#include <string>
 
namespace Pds{
 
template<typename Datum> 
class CircBuffer
{
 
private:
    unsigned int nel;
    
    Datum *data;
    
    unsigned int front;
 
 
public:
 
    CircBuffer(void);
 
    CircBuffer(unsigned int Nel);
 
    CircBuffer(const Pds::CircBuffer<Datum> &B);
 
    ~CircBuffer();
 
public:
    Datum &operator[](const int &id);
 
    bool Push(const Datum &Dat);
    
public:
    bool IsEmpty(void) const;
    
    unsigned int Nel(void) const;
    
}; // Class CircBuffer
 
} // namespace Pds
 
 
template<typename Datum> 
Pds::CircBuffer<Datum>::CircBuffer(void)
{
    this->nel = 0;    
    this->data = NULL;
    this->front = 0;
}
 
template<typename Datum> 
Pds::CircBuffer<Datum>::CircBuffer(unsigned int Nel):CircBuffer()
{
    if (Nel==0) return;
    
    this->data = new Datum[Nel];
    if(this->data==NULL)    return;
    
    //for(unsigned int i=0;i<Nel;i++) this->data[i]=0;
    this->nel = Nel;
    this->front = 0;
}
 
template<typename Datum> 
Pds::CircBuffer<Datum>::CircBuffer(const Pds::CircBuffer<Datum> &B):CircBuffer()
{
    if(this!=&B) //Comprueba que no se esté intentando igualar un objeto a sí mismo
    {
        if (B.nel==0) return;
        
        this->data = new Datum[B.nel];
        if(this->data==NULL)    return;
        
        for(unsigned int i=0;i<B.nel;i++) this->data[i]=B.data[i];
        this->nel = B.nel;
        this->front = B.front;
    }
    
    return;
}
 
template<typename Datum> 
Pds::CircBuffer<Datum>::~CircBuffer()
{
    delete[] this->data;
    this->data = NULL;
    this->front = 0;
    this->nel = 0;  
}
 
template<typename Datum> 
Datum &Pds::CircBuffer<Datum>::operator[](const int &id)
{
    int ID=id;
    while(ID<0) ID=this->nel+ID;
    return this->data[(this->front+ID)%this->nel];
}
 
template<typename Datum> 
bool Pds::CircBuffer<Datum>::Push(const Datum &Dat)
{
    if(this->nel==0)    return false;
 
    this->front = (this->nel+this->front -1) % this->nel;
    this->data[this->front] = Dat;
    return true;
}
 
 
template<typename Datum> 
bool Pds::CircBuffer<Datum>::IsEmpty(void) const
{
    if((this->nel==0)||(this->data==NULL))  return true;
    return false;
}
 
template<typename Datum> 
unsigned int Pds::CircBuffer<Datum>::Nel(void) const
{
    if((this->nel==0)||(this->data==NULL))  return 0;
    return this->nel;
}
 
#endif