Yate
RadioBufDesc Class Reference

A buffer description. More...

#include <yateradio.h>

Public Member Functions

 RadioBufDesc ()
 
void reset (unsigned int value=0)
 
void reset (unsigned int offset, unsigned int validS)
 
bool validSamples (unsigned int minSamples) const
 

Public Attributes

float * samples
 
unsigned int offs
 
unsigned int valid
 

Detailed Description

A buffer description.

Keeps a buffer pointer with offset and valid samples

Constructor & Destructor Documentation

◆ RadioBufDesc()

RadioBufDesc ( )
inline

Constructor

Member Function Documentation

◆ reset() [1/2]

void reset ( unsigned int offset,
unsigned int validS )
inline

Reset the buffer

Parameters
offsetNew offset
validSNew valid samples value

◆ reset() [2/2]

void reset ( unsigned int value = 0)
inline

Reset the buffer

Parameters
valueOffset and valid samples value

◆ validSamples()

bool validSamples ( unsigned int minSamples) const
inline

Check if the buffer is valid

Parameters
minSamplesRequired minimum number of valid samples
Returns
True if valid, false otherwise

Referenced by RadioReadBufs::valid().


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