Class mudaq::CircularBufferProxy

template <unsigned O, typename T>

ClassList > mudaq > CircularBufferProxy

More...

  • #include <mudaq_circular_buffer.hpp>

Inherited by the following classes: mudaq::CircularBuffer

Public Types

Type Name
typedef CircularSubBufferProxy< BUFFER_ORDER, T > SubBuffer

Public Static Attributes

Type Name
const size_t BUFFER_MASK = (BUFFER\_SIZE - 1)
const size_t BUFFER_ORDER = O
const size_t BUFFER_SIZE = (1 &lt;&lt; BUFFER\_ORDER)

Public Functions

Type Name
CircularBufferProxy ()
CircularBufferProxy (void * base)
bool empty () const
bool operator! () const
T operator[] (size_t idx) const
size_t size () const
SubBuffer sub_buffer (size_t offset, size_t size) const

Detailed Description

access an existing block of memory as a circular buffer

Public Types Documentation

typedef SubBuffer

typedef CircularSubBufferProxy<BUFFER_ORDER, T> mudaq::CircularBufferProxy< O, T >::SubBuffer;

Public Static Attributes Documentation

variable BUFFER_MASK

const size_t mudaq::CircularBufferProxy< O, T >::BUFFER_MASK;

variable BUFFER_ORDER

const size_t mudaq::CircularBufferProxy< O, T >::BUFFER_ORDER;

variable BUFFER_SIZE

const size_t mudaq::CircularBufferProxy< O, T >::BUFFER_SIZE;

Public Functions Documentation

function CircularBufferProxy [1/2]

inline mudaq::CircularBufferProxy::CircularBufferProxy ()

function CircularBufferProxy [2/2]

inline mudaq::CircularBufferProxy::CircularBufferProxy (
    void * base
)

function empty

inline bool mudaq::CircularBufferProxy::empty () const

function operator!

inline bool mudaq::CircularBufferProxy::operator! () const

function operator[]

inline T mudaq::CircularBufferProxy::operator[] (
    size_t idx
) const

function size

inline size_t mudaq::CircularBufferProxy::size () const

function sub_buffer

inline SubBuffer mudaq::CircularBufferProxy::sub_buffer (
    size_t offset,
    size_t size
) const

The documentation for this class was generated from the following file midas_fe/libmudaq/mudaq_circular_buffer.hpp