flxDataArray Class Reference

This class is used as a base class for the templated array classes. More...

#include <flxCoreTypes.h>

Inheritance diagram for flxDataArray:

Public Member Functions
	flxDataArray ()
virtual	~flxDataArray ()
virtual flxDataType_t	type ()=0
uint8_t	n_dimensions ()
	Return the number of dimensions in the array. More...
uint16_t *	dimensions ()
	Return a pointer to the array's dimensions array . More...
size_t	size (void)
	Return the total number of elements in the array. More...

Protected Member Functions
void	setDimensions (uint16_t d0)
void	setDimensions (uint16_t d0, uint16_t d1)
void	setDimensions (uint16_t d0, uint16_t d1, uint16_t d2)
virtual void	reset ()

Protected Attributes
uint8_t	_n_dims
uint16_t	_dimensions [kMaxArrayDims]

Static Protected Attributes
static constexpr uint16_t	kMaxArrayDims = 3

Detailed Description

This class is used as a base class for the templated array classes.

Note

Currently the interface only supports up to 3 dimensions.

Constructor & Destructor Documentation

flxDataArray()

flxDataArray::flxDataArray ( )

inline

~flxDataArray()

virtual flxDataArray::~flxDataArray ( )

inlinevirtual

Member Function Documentation

dimensions()

uint16_t * flxDataArray::dimensions ( )

inline

Return a pointer to the array's dimensions array .

Returns

uint16_t*

n_dimensions()

uint8_t flxDataArray::n_dimensions ( )

inline

Return the number of dimensions in the array.

Returns

uint8_t

reset()

virtual void flxDataArray::reset ( )

inlineprotectedvirtual

Reimplemented in flxDataArrayType< T >, and flxDataArrayType< char * >.

setDimensions() [1/3]

void flxDataArray::setDimensions ( uint16_t  d0 )

inlineprotected

setDimensions() [2/3]

void flxDataArray::setDimensions ( uint16_t  d0, uint16_t  d1  )

inlineprotected

setDimensions() [3/3]

void flxDataArray::setDimensions ( uint16_t  d0, uint16_t  d1, uint16_t  d2  )

inlineprotected

size()

size_t flxDataArray::size ( void  )

inline

Return the total number of elements in the array.

Returns

size_t

type()

virtual flxDataType_t flxDataArray::type ( )

pure virtual

Implemented in flxDataArrayType< T >, and flxDataArrayType< char * >.

Member Data Documentation

_dimensions

uint16_t flxDataArray::_dimensions[kMaxArrayDims]

protected

_n_dims

uint8_t flxDataArray::_n_dims

protected

kMaxArrayDims

constexpr uint16_t flxDataArray::kMaxArrayDims = 3

staticconstexprprotected

---

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

• src/core/flux_base/flxCoreTypes.h