hu::varadiistvan::xplra::MultiBuffer::DataRef Class Reference

#include <MultiBuffer.h>

Public Member Functions
	DataRef (const std::string &name, uint8_t type, const DataRef *previous=0, size_t length=0, size_t offset=0) noexcept
size_t	getSize () const noexcept
size_t	getAlignment () const noexcept
bool	isArray () const noexcept
size_t	getCopyLength (size_t userLength, size_t userOffset) const noexcept

Public Attributes
std::string	name
uint8_t	type
size_t	length
size_t	offset
size_t	dataOffset

Detailed Description

Information about a dataref.

Definition at line 61 of file MultiBuffer.h.

Constructor & Destructor Documentation

DataRef()

MultiBuffer::DataRef::DataRef ( const std::string &  name, uint8_t  type, const DataRef *  previous = 0, size_t  length = 0, size_t  offset = 0  )

inlinenoexcept

Construct the dataref with the given data.

Definition at line 54 of file MultiBuffer.cc.

Member Function Documentation

getAlignment()

size_t MultiBuffer::DataRef::getAlignment ( ) const

inlinenoexcept

Get the alignment requirement of the data represented by this dataref.

Definition at line 95 of file MultiBuffer.cc.

getCopyLength()

size_t MultiBuffer::DataRef::getCopyLength ( size_t  userLength, size_t  userOffset  ) const

inlinenoexcept

Get the length of the data the can be copied for the given user parameters.

Definition at line 125 of file MultiBuffer.cc.

getSize()

size_t MultiBuffer::DataRef::getSize ( ) const

inlinenoexcept

Get the size of the data represented by this object.

Definition at line 73 of file MultiBuffer.cc.

isArray()

bool MultiBuffer::DataRef::isArray ( ) const

noexcept

Determine if the dataref is an array.

Definition at line 114 of file MultiBuffer.cc.

Member Data Documentation

dataOffset

size_t hu::varadiistvan::xplra::MultiBuffer::DataRef::dataOffset

The offset within the data buffer.

Definition at line 87 of file MultiBuffer.h.

length

size_t hu::varadiistvan::xplra::MultiBuffer::DataRef::length

The length in case of array types.

Definition at line 77 of file MultiBuffer.h.

name

std::string hu::varadiistvan::xplra::MultiBuffer::DataRef::name

The name.

Definition at line 67 of file MultiBuffer.h.

offset

size_t hu::varadiistvan::xplra::MultiBuffer::DataRef::offset

The offset in case of array types.

Definition at line 82 of file MultiBuffer.h.

type

uint8_t hu::varadiistvan::xplra::MultiBuffer::DataRef::type

The type (the protocol constant).

Definition at line 72 of file MultiBuffer.h.

---

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

• MultiBuffer.h
• MultiBuffer.cc