LibBeamApi  0.3.8
Public Member Functions | Private Attributes | List of all members
BFifoCircPos Class Reference

This class implements a pointer into the Fifo's circular buffer. More...

#include <BFifoCirc.h>

Public Member Functions

 BFifoCircPos (uint32_t size)
 
void setSize (uint32_t size)
 
void set (uint32_t pos)
 Sets the position. More...
 
uint32_t pos ()
 The current position. More...
 
void increment (uint32_t numFifoSamples)
 Increment the pointer by the given value. More...
 
uint32_t difference (const BFifoCircPos &pos)
 Return the difference between the two pointers. More...
 
 operator int ()
 
void operator+= (uint32_t numFifoSamples)
 
int operator== (const BFifoCircPos &pos)
 
int operator!= (const BFifoCircPos &pos)
 

Private Attributes

uint32_t osize
 
uint32_t opos
 

Detailed Description

This class implements a pointer into the Fifo's circular buffer.

Constructor & Destructor Documentation

BFifoCircPos::BFifoCircPos ( uint32_t  size)

Member Function Documentation

uint32_t BFifoCircPos::difference ( const BFifoCircPos pos)

Return the difference between the two pointers.

void BFifoCircPos::increment ( uint32_t  numFifoSamples)

Increment the pointer by the given value.

BFifoCircPos::operator int ( )
int BFifoCircPos::operator!= ( const BFifoCircPos pos)
void BFifoCircPos::operator+= ( uint32_t  numFifoSamples)
int BFifoCircPos::operator== ( const BFifoCircPos pos)
uint32_t BFifoCircPos::pos ( )

The current position.

void BFifoCircPos::set ( uint32_t  pos)

Sets the position.

void BFifoCircPos::setSize ( uint32_t  size)

Member Data Documentation

uint32_t BFifoCircPos::opos
private
uint32_t BFifoCircPos::osize
private

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