fesa::ConfigFieldArray2D< T > Class Template Reference

#include <ConfigurationField.h>

Inheritance diagram for fesa::ConfigFieldArray2D< T >:

List of all members.

Public Member Functions
	ConfigFieldArray2D (const std::string &fieldName, DataStore *pDataStore, int32_t size1, int32_t size2, const DataIntegrity bufferType=SingleBuffered)
	Constructor.
	~ConfigFieldArray2D ()
	destructor
const T **	get (uint32_t &size1, uint32_t &size2)
	Method to retrieve active field value.
void	getColumn (uint32_t index, uint32_t size, T *column, uint32_t &currentSize)
	Method to retrieve column of active field value.
const T *	getRow (uint32_t index, uint32_t &size)
	Method to retrieve row of active field value.
void	getSize (uint32_t &size1, uint32_t &size2)
	retrieve the current size of the array

---

Detailed Description

template<typename T>
class fesa::ConfigFieldArray2D< T >

Definition at line 322 of file ConfigurationField.h.

---

Constructor & Destructor Documentation

template<typename T >

fesa::ConfigFieldArray2D< T >::ConfigFieldArray2D	(	const std::string &	fieldName,
		DataStore *	pDataStore,
		int32_t	size1,
		int32_t	size2,
		const DataIntegrity	bufferType = SingleBuffered
	)			[inline]

Constructor.

Parameters:

	fieldName	name of the field
	criterionName	multiplexing criterion
	pDataStore	pointer to DataStore that contains the field

Definition at line 376 of file ConfigurationField.h.

template<typename T >

fesa::ConfigFieldArray2D< T >::~ConfigFieldArray2D

(

)

[inline]

destructor

Definition at line 384 of file ConfigurationField.h.

---

Member Function Documentation

template<typename T >

const T ** fesa::ConfigFieldArray2D< T >::get	(	uint32_t &	size1,
		uint32_t &	size2
	)			[inline]

Method to retrieve active field value.

Parameters:

	size1	length of row
	size2	length of column
	context	the multiplexing context

Returns:

the value of the active buffer

Definition at line 389 of file ConfigurationField.h.

References fesa::FieldValue< T[][1]>::activeBuffer(), fesa::FieldArray2D< T >::fieldValue_, and fesa::FieldValue< T[][1]>::getActiveCurrentSize().

template<typename T >

void fesa::ConfigFieldArray2D< T >::getColumn	(	uint32_t	index,
		uint32_t	size,
		T *	column,
		uint32_t &	currentSize
	)			[inline]

Method to retrieve column of active field value.

Parameters:

	index	index of column
	size	length of column
	column	to retrieve the value

Returns:

the column in the column parameter

Definition at line 396 of file ConfigurationField.h.

References fesa::FieldValue< T[][1]>::activeBuffer(), FesaErrorFieldCurrentDimensionsOutOfBound, fesa::FieldArray2D< T >::fieldValue_, fesa::FieldValue< T[][1]>::getActiveCurrentSize(), fesa::AbstractField::name_, and fesa::StringUtilities::toString().

template<typename T >

const T * fesa::ConfigFieldArray2D< T >::getRow	(	uint32_t	index,
		uint32_t &	size
	)			[inline]

Method to retrieve row of active field value.

Parameters:

	index	index of row
	size	length of row
	context	the multiplexing context

Returns:

the value of the active buffer

Definition at line 420 of file ConfigurationField.h.

References fesa::FieldValue< T[][1]>::activeBuffer(), FesaErrorFieldCurrentDimensionOutOfBound, fesa::FieldArray2D< T >::fieldValue_, fesa::FieldValue< T[][1]>::getActiveCurrentSize(), fesa::AbstractField::name_, and fesa::StringUtilities::toString().

template<typename T >

void fesa::ConfigFieldArray2D< T >::getSize	(	uint32_t &	size1,
		uint32_t &	size2
	)			[inline]

retrieve the current size of the array

Parameters:

	size1	first dimension of the array
	size2	second dimension of the array

Definition at line 439 of file ConfigurationField.h.

References fesa::FieldArray2D< T >::fieldValue_, and fesa::FieldValue< T[][1]>::getActiveCurrentSize().

---

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

• DataStore/ConfigurationField.h