Clase Pds::CircBuffer

Clase que implementa un buffer circular de tamaño fijo. Más...

Namespaces
namespace	Pds
	Nombre de espacio para Pds (Procesamiento Digital de Senales)

Estructuras de datos
class	Pds::CircBuffer< Datum >
	La clase tipo Pds::CircBuffer . Esta clase genera un objeto con un buffer circular de tamaño fijo. Para usar incluir Pds/CircBuffer. Más...

Varios tipos de constructores
Crean una objeto Pds::CircBuffer
	Pds::CircBuffer< Datum >::CircBuffer (void)
	Crea un objeto vacio de tipo Pds::CircBuffer. Más...
	Pds::CircBuffer< Datum >::CircBuffer (unsigned int Nel)
	Crea un objeto de tipo Pds::CircBuffer. Más...
	Pds::CircBuffer< Datum >::CircBuffer (const Pds::CircBuffer< Datum > &B)
	Crea un objeto de tipo Pds::CircBuffer de otro. Más...
	Pds::CircBuffer< Datum >::~CircBuffer ()

Lectura y escritura de datos en Pds::CircBuffer
Lectura y escritura de datos en el buffer
Datum &	Pds::CircBuffer< Datum >::operator[] (const int &id)
	Lee y escribe datos en la memoria en el Pds::CircBuffer. Más...
bool	Pds::CircBuffer< Datum >::Push (const Datum &Dat)
	Empuja un nuevo dato en la memoria Buff[0] del Pds::CircBuffer y descarta Buff[-1] Buff[N-1]. Más...

Mostrando datos
bool	Pds::CircBuffer< Datum >::IsEmpty (void) const
	Retorna true si el objeto esta vacio y false si no. Más...
unsigned int	Pds::CircBuffer< Datum >::Nel (void) const
	Retorna el número de elementos del circular buffer. Más...

Descripción detallada

Clase que implementa un buffer circular de tamaño fijo.

#include <Pds/CircBuffer>

Pds::CircBuffer

Documentación de las funciones

CircBuffer() [1/3]

template<typename Datum >

Pds::CircBuffer< Datum >::CircBuffer

(

void

)

Crea un objeto vacio de tipo Pds::CircBuffer.

Pds::CircBuffer<double> V();

Definición en la línea 206 del archivo CircBuffer.hpp.

{
    this->nel = 0;    
    this->data = NULL;
    this->front = 0;
}

CircBuffer() [2/3]

template<typename Datum >

Pds::CircBuffer< Datum >::CircBuffer

(

unsigned int

Nel

)

Crea un objeto de tipo Pds::CircBuffer.

Pds::CircBuffer<double> V(5);

Parámetros

[in]

Nel

El número de elementos del buffer.

Definición en la línea 214 del archivo CircBuffer.hpp.

                                                :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;
}

Hace referencia a Pds::CircBuffer< Datum >::data, Pds::CircBuffer< Datum >::front, Pds::CircBuffer< Datum >::nel y Pds::CircBuffer< Datum >::Nel().

Gráfico de llamadas para esta función:

CircBuffer() [3/3]

template<typename Datum >

Pds::CircBuffer< Datum >::CircBuffer

(

const Pds::CircBuffer< Datum > &

B

)

Crea un objeto de tipo Pds::CircBuffer de otro.

Pds::CircBuffer<double> V(3);
V[0]=1;V[1]=-1;V[2]=1;
Pds::CircBuffer<double> B(V);

Parámetros

[in]

B

Desde donde se copiarán los datos.

Definición en la línea 227 del archivo CircBuffer.hpp.

                                                             :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;
}

Hace referencia a Pds::CircBuffer< Datum >::data, Pds::CircBuffer< Datum >::front y Pds::CircBuffer< Datum >::nel.

operator[]()

template<typename Datum >

Datum & Pds::CircBuffer< Datum >::operator[]

(

const int &

id

)

Lee y escribe datos en la memoria en el Pds::CircBuffer.

Pds::CircBuffer<double> V(3);

V[0]=1;V[-2]=-1;V[2]=2;

std::cout<<V[0]<<"\t"<<V[1]<<"\t"<<V[2]<<"\n";

La salida sería:

1       -1      2

Parámetros

[in]

id

Elemento a acceder en la memoria del buffer.

Definición en la línea 254 del archivo CircBuffer.hpp.

{
    int ID=id;
    while(ID<0) ID=this->nel+ID;
    return this->data[(this->front+ID)%this->nel];
}

Push()

template<typename Datum >

bool Pds::CircBuffer< Datum >::Push

(

const Datum &

Dat

)

Empuja un nuevo dato en la memoria Buff[0] del Pds::CircBuffer y descarta Buff[-1] Buff[N-1].

Si nuestro objeto se llama Buff, el dato Dat pasa a ocupar la posicion Buff[0], y el antiguo dato Buff[0] ahora estará en la posición Buff[1] y Buff[N-1] es descartado.

Pds::CircBuffer<double> Buff(3);

Buff[0]=1;Buff[-2]=-1;Buff[2]=2;

Buff.Push(3);
std::cout<<V[0]<<"\t"<<V[1]<<"\t"<<V[2]<<"\n";

La salida sería:

3       1       -1

Pds::CircBuffer

Parámetros

[in]

Dat

Dato a colocar al frente del buffer.

Ejemplos

example_circbuffer.cpp.

Definición en la línea 262 del archivo CircBuffer.hpp.

{
    if(this->nel==0)    return false;
 
    this->front = (this->nel+this->front -1) % this->nel;
    this->data[this->front] = Dat;
    return true;
}

IsEmpty()

template<typename Datum >

bool Pds::CircBuffer< Datum >::IsEmpty

(

void

)

const

Retorna true si el objeto esta vacio y false si no.

Pds::CircBuffer<double> V(3);
V[0]=1;V[-2]=-1;V[2]=2;

if(V.IsEmpty()==false)  
std::cout<<V[0]<<"\t"<<V[1]<<"\t"<<V[2]<<"\n";

La salida sería:

1       -1      2

Devuelve

Retorna true si el objeto esta vacio y false si no.

Ejemplos

example_circbuffer.cpp.

Definición en la línea 273 del archivo CircBuffer.hpp.

{
    if((this->nel==0)||(this->data==NULL))  return true;
    return false;
}

Nel()

template<typename Datum >

unsigned int Pds::CircBuffer< Datum >::Nel

(

void

)

const

Retorna el número de elementos del circular buffer.

Devuelve

Retorna el número de elementos del circular buffer.

Ejemplos

example_circbuffer.cpp.

Definición en la línea 280 del archivo CircBuffer.hpp.

{
    if((this->nel==0)||(this->data==NULL))  return 0;
    return this->nel;
}

Referenciado por Pds::CircBuffer< Datum >::CircBuffer().

~CircBuffer()

template<typename Datum >

Pds::CircBuffer< Datum >::~CircBuffer

Definición en la línea 245 del archivo CircBuffer.hpp.

{
    delete[] this->data;
    this->data = NULL;
    this->front = 0;
    this->nel = 0;  
}