Class mudaq::CircularSubBufferProxy

template <unsigned BUFFER_ORDER, typename T>

ClassList > mudaq > CircularSubBufferProxy

More...

  • #include <mudaq_circular_buffer.hpp>

Public Static Attributes

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

Public Functions

Type Name
CircularSubBufferProxy ()
CircularSubBufferProxy (volatile void * base, size_t offset, size_t size)
bool empty () const
uint32_t give_end () const
uint32_t give_offset () const
bool operator! () const
T operator[] (size_t idx) const
size_t size () const

Detailed Description

access an existing small block of memory inside a bigger circular buffer

Public Static Attributes Documentation

variable BUFFER_MASK

const size_t mudaq::CircularSubBufferProxy< BUFFER_ORDER, T >::BUFFER_MASK;

variable BUFFER_SIZE

const size_t mudaq::CircularSubBufferProxy< BUFFER_ORDER, T >::BUFFER_SIZE;

Public Functions Documentation

function CircularSubBufferProxy [1/2]

inline mudaq::CircularSubBufferProxy::CircularSubBufferProxy ()

function CircularSubBufferProxy [2/2]

inline mudaq::CircularSubBufferProxy::CircularSubBufferProxy (
    volatile void * base,
    size_t offset,
    size_t size
)

function empty

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

function give_end

inline uint32_t mudaq::CircularSubBufferProxy::give_end () const

function give_offset

inline uint32_t mudaq::CircularSubBufferProxy::give_offset () const

function operator!

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

function operator[]

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

function size

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

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