flxDataArrayType< T > Class Template Reference

A templated class to define an array class of a specific type. More...

#include <flxCoreTypes.h>

Inheritance diagram for flxDataArrayType< T >:

Public Member Functions
	flxDataArrayType ()
	~flxDataArrayType ()
flxDataType_t	type (void)
	Return the data type of the array. More...
void	set (T *data, uint16_t d0, bool no_copy=false)
	Set the array data and pass in dimensions for the array. More...
void	set (T *data, uint16_t d0, uint16_t d1, bool no_copy=false)
	Set the array data and pass in dimensions for the array. More...
void	set (T *data, uint16_t d0, uint16_t d1, uint16_t d2, bool no_copy=false)
	Set the array data and pass in dimensions for the array. More...
T *	get ()
	Return a pointer to the array data. More...
Public Member Functions inherited from flxDataArray
	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
virtual void	reset ()
virtual void	freeAlloc (void)
virtual bool	setDataPtr (T *data, size_t length, bool no_copy)
Protected Member Functions inherited from flxDataArray
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
bool	_bAlloc
Protected Attributes inherited from flxDataArray
uint8_t	_n_dims
uint16_t	_dimensions [kMaxArrayDims]

Additional Inherited Members
Static Protected Attributes inherited from flxDataArray
static constexpr uint16_t	kMaxArrayDims = 3

Detailed Description

template<typename T>
class flxDataArrayType< T >

A templated class to define an array class of a specific type.

Constructor & Destructor Documentation

flxDataArrayType()

template<typename T >

flxDataArrayType< T >::flxDataArrayType ( )

inline

~flxDataArrayType()

template<typename T >

flxDataArrayType< T >::~flxDataArrayType ( )

inline

Member Function Documentation

freeAlloc()

template<typename T >

virtual void flxDataArrayType< T >::freeAlloc ( void  )

inlineprotectedvirtual

get()

template<typename T >

T * flxDataArrayType< T >::get ( )

inline

Return a pointer to the array data.

Returns

T* Templated type pointer

reset()

template<typename T >

virtual void flxDataArrayType< T >::reset ( )

inlineprotectedvirtual

Reimplemented from flxDataArray.

set() [1/3]

template<typename T >

void flxDataArrayType< T >::set ( T *  data, uint16_t  d0, bool  no_copy = false  )

inline

Set the array data and pass in dimensions for the array.

Parameters

data	The array data pointer
d0	The first dimension of the array
no_copy	If set, the data is not copied.

set() [2/3]

template<typename T >

void flxDataArrayType< T >::set ( T *  data, uint16_t  d0, uint16_t  d1, bool  no_copy = false  )

inline

Set the array data and pass in dimensions for the array.

Parameters

data	The array data pointer
d0	The first dimension of the array
d1	The second dimension of the array
no_copy	If set, the data is not copied.

set() [3/3]

template<typename T >

void flxDataArrayType< T >::set ( T *  data, uint16_t  d0, uint16_t  d1, uint16_t  d2, bool  no_copy = false  )

inline

Set the array data and pass in dimensions for the array.

Parameters

data	The array data pointer
d0	The first dimension of the array
d1	The second dimension of the array
d2	The third dimension of the array
no_copy	If set, the data is not copied.

setDataPtr()

template<typename T >

virtual bool flxDataArrayType< T >::setDataPtr ( T *  data, size_t  length, bool  no_copy  )

inlineprotectedvirtual

type()

template<typename T >

flxDataType_t flxDataArrayType< T >::type ( void  )

inlinevirtual

Return the data type of the array.

Returns

flxDataType_t

Implements flxDataArray.

Member Data Documentation

_bAlloc

template<typename T >

bool flxDataArrayType< T >::_bAlloc

protected

---

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

• src/core/flux_base/flxCoreTypes.h