AGX Dynamics 2.42.2.1
Loading...
Searching...
No Matches
agxSensor::BinaryOutputView< T > Class Template Reference

View for reading sections of a binary packed buffer of the specified template parameter type. More...

#include <BinaryOutputView.h>

Classes

struct  iterator
 

Public Types

using value_type = T
 

Public Member Functions

 BinaryOutputView ()=default
 Constructs a default empty binary output view.
 
 BinaryOutputView (const void *buffer, size_t size)
 Constructs a binary output view starting from the specified buffer address and extending in the specified size.
 
const T * begin () const
 
bool empty () const
 
const T * end () const
 
const T & operator[] (size_t localIndex) const
 Random read access of value at the specified index.
 
size_t size () const
 

Detailed Description

template<typename T>
class agxSensor::BinaryOutputView< T >

View for reading sections of a binary packed buffer of the specified template parameter type.

Definition at line 29 of file BinaryOutputView.h.

Member Typedef Documentation

◆ value_type

template<typename T >
using agxSensor::BinaryOutputView< T >::value_type = T

Definition at line 32 of file BinaryOutputView.h.

Constructor & Destructor Documentation

◆ BinaryOutputView() [1/2]

template<typename T >
agxSensor::BinaryOutputView< T >::BinaryOutputView ( )
inlinedefault

Constructs a default empty binary output view.

◆ BinaryOutputView() [2/2]

template<typename T >
agxSensor::BinaryOutputView< T >::BinaryOutputView ( const void *  buffer,
size_t  size 
)
inline

Constructs a binary output view starting from the specified buffer address and extending in the specified size.

Parameters
buffer- address from where the binary output view should start
size- size of the binary output view window, in number of template parameter types

Definition at line 164 of file BinaryOutputView.h.

Member Function Documentation

◆ begin()

template<typename T >
const T * agxSensor::BinaryOutputView< T >::begin
inline
Returns
beginning iterator

Definition at line 183 of file BinaryOutputView.h.

◆ empty()

template<typename T >
bool agxSensor::BinaryOutputView< T >::empty
inline
Returns
true if empty, false otherwise

Definition at line 177 of file BinaryOutputView.h.

References m_size.

◆ end()

template<typename T >
const T * agxSensor::BinaryOutputView< T >::end
inline
Returns
ending iterator

Definition at line 189 of file BinaryOutputView.h.

References m_size.

◆ operator[]()

template<typename T >
const T & agxSensor::BinaryOutputView< T >::operator[] ( size_t  localIndex) const
inline

Random read access of value at the specified index.

Parameters
localIndex- index within the buffer view region
Returns
read access to the element

Definition at line 195 of file BinaryOutputView.h.

◆ size()

template<typename T >
size_t agxSensor::BinaryOutputView< T >::size
inline
Returns
size of the buffer view section, in number of template parameter types

Definition at line 171 of file BinaryOutputView.h.

References m_size.


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