commonlib
ArrayBufferTargetDesc< T > Class Template Reference

Array wrapper for buffer target. More...

#include <array_buffer.h>

Inheritance diagram for ArrayBufferTargetDesc< T >:
BaseArrayDescImpl< T, IDirectArrayTargetBuffer< T > > IDirectArrayTargetBuffer< T > ITargetBuffer< T > ArrayBufferTarget< T >

Public Member Functions

 ArrayBufferTargetDesc (T *buffer, size_t capacity)
 
size_t getWritePos () override
 Function returns current write position. More...
 
void incrementWritePosition (size_t pos) override
 Function increments write position for N samples. More...
 
size_t getRemainingSize () override
 Function returns remaining size in samples. More...
 
- Public Member Functions inherited from BaseArrayDescImpl< T, IDirectArrayTargetBuffer< 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 IDirectArrayTargetBuffer< T >
size_t writeSamples (const T *samples, size_t samplesCount, bool incrementPosition=true) override
 Function pushes the samples into buffer. More...
 

Protected Attributes

size_t remainingSize
 
size_t writePos
 

Additional Inherited Members

- Protected Member Functions inherited from IDirectArrayTargetBuffer< T >
virtual size_t write (const T *samples, size_t samplesCount, size_t pos)
 Implements write into buffer. More...
 
virtual size_t write (const T *samples, size_t samplesCount)
 Implements write into buffer to current location. More...
 

Detailed Description

template<typename T>
class ArrayBufferTargetDesc< T >

Array wrapper for buffer target.

Member Function Documentation

◆ getRemainingSize()

template<typename T>
size_t ArrayBufferTargetDesc< T >::getRemainingSize ( )
inlineoverridevirtual

Function returns remaining size in samples.

Returns
Size in samples.

Implements ITargetBuffer< T >.

◆ getWritePos()

template<typename T>
size_t ArrayBufferTargetDesc< T >::getWritePos ( )
inlineoverridevirtual

Function returns current write position.

Returns
Current write position.

Implements IDirectArrayTargetBuffer< T >.

◆ incrementWritePosition()

template<typename T>
void ArrayBufferTargetDesc< T >::incrementWritePosition ( size_t  pos)
inlineoverridevirtual

Function increments write position for N samples.

Parameters
posan increment value
Returns
void

Implements ITargetBuffer< T >.


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