agxSensor::BinaryOutputBuffer Class Reference

Buffer used for sensor output of a wide range of output element types. More...

#include <BinaryOutputView.h>

Public Member Functions
size_t	elementSize () const
bool	empty () const
template<typename T >
const T *	ptr () const
void	resize (size_t size, size_t elementSize)
	Resize the buffer to fit the given number of elements of the given size.
void *	rwPtr ()
const void *	rwPtr () const
size_t	size () const
template<typename T >
BinaryOutputView< T >	view (size_t startIndex=0u, size_t numElements=agx::InvalidIndex) const
	Create a view into a section of the buffer.

Detailed Description

Buffer used for sensor output of a wide range of output element types.

Definition at line 96 of file BinaryOutputView.h.

Member Function Documentation

elementSize()

size_t agxSensor::BinaryOutputBuffer::elementSize ( ) const

inline

Returns

element size in bytes

Definition at line 205 of file BinaryOutputView.h.

Referenced by resize().

empty()

bool agxSensor::BinaryOutputBuffer::empty ( ) const

inline

Returns

true if empty, false otherwise

Definition at line 210 of file BinaryOutputView.h.

References m_size.

ptr()

template<typename T >

const T * agxSensor::BinaryOutputBuffer::ptr

inline

Returns

address to the start of the buffer in the given template argument type

Definition at line 239 of file BinaryOutputView.h.

References agxAssert1.

resize()

void agxSensor::BinaryOutputBuffer::resize ( size_t  size, size_t  elementSize  )

inline

Resize the buffer to fit the given number of elements of the given size.

Parameters

size	- number of elements to fit in the buffer
elementSize	- size of one element in bytes

Definition at line 215 of file BinaryOutputView.h.

References elementSize(), m_size, and size().

rwPtr() [1/2]

void * agxSensor::BinaryOutputBuffer::rwPtr ( )

inline

Returns

native raw address to the start of the buffer

Definition at line 228 of file BinaryOutputView.h.

rwPtr() [2/2]

const void * agxSensor::BinaryOutputBuffer::rwPtr ( ) const

inline

Returns

native raw address to the start of the buffer

Definition at line 233 of file BinaryOutputView.h.

size()

size_t agxSensor::BinaryOutputBuffer::size ( ) const

inline

Returns

size of the buffer in number of elements

Definition at line 200 of file BinaryOutputView.h.

References m_size.

Referenced by resize().

view()

template<typename T >

BinaryOutputView< T > agxSensor::BinaryOutputBuffer::view ( size_t  startIndex = 0u, size_t  numElements = agx::InvalidIndex  ) const

inline

Create a view into a section of the buffer.

Parameters

startIndex	- starting index position within the buffer in number of elements
numElements	- size of the view section in number of elements

Returns

Read view into a section of the buffer

Definition at line 246 of file BinaryOutputView.h.

References agx::InvalidIndex, and m_size.

---

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

• BinaryOutputView.h