fesa::SettingFieldArray< T > Class Template Reference

#include <SettingField.h>

Inheritance diagram for fesa::SettingFieldArray< T >:

List of all members.

Public Member Functions
	SettingFieldArray (const std::string &fieldName, bool multiplexed, bool multiMultiplexed, DataStore *pDataStore, bool persistent, bool shared, int32_t size, const DataIntegrity bufferType=DoubleBuffered)
	Constructor.
	~SettingFieldArray ()
	destructor
const T *	get (uint32_t &size, MultiplexingContext *context)
	Method to retrieve active field value.
void	set (const T *val, uint32_t size, MultiplexingContext *context)
	Method to set the new value of the pending buffer of the field.
uint32_t	getSize (MultiplexingContext *context)
	retrieve the current size of the array
Protected Member Functions
void	checkContext (MultiplexingContext *context)

---

Detailed Description

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

Definition at line 294 of file SettingField.h.

---

Constructor & Destructor Documentation

template<typename T >

fesa::SettingFieldArray< T >::SettingFieldArray	(	const std::string &	fieldName,
		bool	multiplexed,
		bool	multiMultiplexed,
		DataStore *	pDataStore,
		bool	persistent,
		bool	shared,
		int32_t	size,
		const DataIntegrity	bufferType = DoubleBuffered
	)			[inline]

Constructor.

Parameters:

name

of the field, multiplexing criterion, pointer to DataStore

Definition at line 337 of file SettingField.h.

References fesa::AbstractField::isShared_.

template<typename T >

fesa::SettingFieldArray< T >::~SettingFieldArray

(

)

[inline]

destructor

Definition at line 348 of file SettingField.h.

---

Member Function Documentation

template<typename T >

void fesa::SettingFieldArray< T >::checkContext

(

MultiplexingContext *

context

)

[inline, protected]

Definition at line 418 of file SettingField.h.

References FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, FesaErrorWrongSourceContextSettingField, fesa::MultiplexingContext::getSettingAccessMask(), fesa::MultiplexingContext::getType(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::MultiplexingContext::NoneCtxt, and fesa::MultiplexingContext::SET_ALLOWED.

Referenced by fesa::SettingFieldArray< T >::set(), fesa::SettingFieldStructArray< T >::setCell(), and fesa::SettingFieldScalarArray< T >::setCell().

template<typename T >

const T * fesa::SettingFieldArray< T >::get	(	uint32_t &	size,
		MultiplexingContext *	context
	)			[inline]

Method to retrieve active field value.

Parameters:

context

the multiplexing context

Returns:

the value of the active buffer

Definition at line 353 of file SettingField.h.

References fesa::FieldValue< T[]>::activeBuffer(), fesa::MultiplexingContext::CHECK_FLAG_TO_BE_SYNC, FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, fesa::FieldValue< T[]>::getActiveCurrentSize(), fesa::FieldArray< T >::getFieldValue(), fesa::MultiplexingContext::getSettingAccessMask(), fesa::AbstractMultiplexingManager::getSlot(), fesa::MultiplexingContext::getType(), fesa::FieldValueBase::isToBeSync(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::MultiplexingContext::NoneCtxt, and fesa::FieldValue< T[]>::pendingBuffer().

template<typename T >

uint32_t fesa::SettingFieldArray< T >::getSize

(

MultiplexingContext *

context

)

[inline]

retrieve the current size of the array

Parameters:

context

the multiplexing context

Returns:

current dimension of the array

Definition at line 407 of file SettingField.h.

References FesaErrorNULLPointerToContext, fesa::FieldValue< T[]>::getActiveCurrentSize(), fesa::FieldArray< T >::getFieldValue(), fesa::AbstractField::multiplexingManager_, and fesa::AbstractMultiplexingManager::requireSlot().

template<typename T >

void fesa::SettingFieldArray< T >::set	(	const T *	val,
		uint32_t	size,
		MultiplexingContext *	context
	)			[inline]

Method to set the new value of the pending buffer of the field.

Parameters:

	val	pointer to new value of field
	size	length of array dimension
	context	the multiplexing context

Definition at line 381 of file SettingField.h.

References fesa::SettingFieldArray< T >::checkContext(), fesa::FieldArray< T >::checkMaxDimension(), FesaErrorNULLPointerToContext, FesaErrorWrongSourceContextSettingField, fesa::FieldArray< T >::getFieldValue(), fesa::MultiplexingContext::getSettingAccessMask(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::FieldValue< T[]>::pendingBuffer(), fesa::AbstractField::registerModifiedField(), fesa::AbstractMultiplexingManager::requireSlot(), fesa::AbstractField::resetToBeSync(), fesa::MultiplexingContext::SET_ALLOWED, and fesa::FieldValue< T[]>::setPendingCurrentSize().

---

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

• DataStore/SettingField.h