commonlib
ArrayBufferSourceDesc< T > Class Template Reference

Array wrapper for buffer source. More...

#include <array_buffer.h>

Inheritance diagram for ArrayBufferSourceDesc< T >:
BaseArrayDescImpl< T, IDirectArraySourceBuffer< T > > IDirectArraySourceBuffer< T > ISourceBuffer< T > ArrayBufferSource< T >

Public Member Functions

 ArrayBufferSourceDesc (T *buffer, size_t capacity)
 
size_t getReadPos () override
 Function returns current read position. More...
 
void incrementReadPosition (size_t pos) override
 Function increments read position for N samples. More...
 
size_t getSize () override
 Function returns current buffer size in samples. More...
 
- Public Member Functions inherited from BaseArrayDescImpl< T, IDirectArraySourceBuffer< T > >
 BaseArrayDescImpl (T *buffer, size_t capacity)
 
std::recursive_mutex & getLock () override
 
T * getData () const override
 
size_t getCapacity () const override
 
- Public Member Functions inherited from IDirectArraySourceBuffer< T >
size_t readSamples (T *samples, size_t samplesCount, bool incrementPosition=true) override
 Function reads the samples from buffer. More...
 
virtual size_t readSamplesAt (T *samples, size_t samplesCount, bool incrementPosition=true, size_t readOffset=0)
 Function reads the samples from buffer. More...
 

Protected Attributes

size_t readPos
 
size_t size
 

Additional Inherited Members

- Protected Member Functions inherited from IDirectArraySourceBuffer< T >
virtual size_t read (T *samples, size_t samplesCount, size_t pos)
 Implements read from buffer. More...
 
virtual size_t read (T *samples, size_t samplesCount)
 Function read from buffer from current location. More...
 

Detailed Description

template<typename T>
class ArrayBufferSourceDesc< T >

Array wrapper for buffer source.

Member Function Documentation

◆ getReadPos()

template<typename T>
size_t ArrayBufferSourceDesc< T >::getReadPos ( )
inlineoverridevirtual

Function returns current read position.

Returns
Current read position.

Implements IDirectArraySourceBuffer< T >.

◆ getSize()

template<typename T>
size_t ArrayBufferSourceDesc< T >::getSize ( )
inlineoverridevirtual

Function returns current buffer size in samples.

Returns
Size in samples.

Implements ISourceBuffer< T >.

◆ incrementReadPosition()

template<typename T>
void ArrayBufferSourceDesc< T >::incrementReadPosition ( size_t  pos)
inlineoverridevirtual

Function increments read position for N samples.

Parameters
posan increment value
Returns
void

Implements ISourceBuffer< T >.


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