fesa::SettingFieldArray2D< T > Class Template Reference

#include <SettingField.h>

Inheritance diagram for fesa::SettingFieldArray2D< T >:
fesa::FieldArray2D< T > fesa::AbstractField fesa::SettingFieldScalarArray2D< T > fesa::SettingFieldStructArray2D< T >

List of all members.

Public Member Functions

 SettingFieldArray2D (const std::string &fieldName, bool multiplexed, bool multiMultiplexed, DataStore *pDataStore, bool persistent, bool shared, int32_t size1, int32_t size2, const DataIntegrity bufferType=DoubleBuffered)
 ~SettingFieldArray2D ()
const T ** get (uint32_t &size1, uint32_t &size2, MultiplexingContext *context)
 Method to retrieve active field value.
void getColumn (uint32_t index, uint32_t size, T *column, uint32_t &currentSize, MultiplexingContext *context)
 Method to retrieve column of active field value.
const T * getRow (uint32_t index, uint32_t &size, MultiplexingContext *context)
 Method to retrieve row of active field value.
void set (const T *const *val, uint32_t size1, uint32_t size2, MultiplexingContext *context)
 Method to set the new value of the pending buffer of the field.
void setColumn (const T *val, uint32_t index, uint32_t size, MultiplexingContext *context)
 Method to set a column of the pending buffer of an array2D.
void setRow (const T *val, uint32_t index, uint32_t size, MultiplexingContext *context)
 Method to set a row of the pending buffer of an array2D.
void getSize (uint32_t &size1, uint32_t &size2, MultiplexingContext *context)
 retrieve the current size of the array

Protected Member Functions

void checkContext (MultiplexingContext *context)

Detailed Description

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

Definition at line 678 of file SettingField.h.

Constructor & Destructor Documentation

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

Definition at line 766 of file SettingField.h.

References fesa::AbstractField::isShared_.

template<typename T >
fesa::SettingFieldArray2D< T >::~SettingFieldArray2D (  )  [inline]

Definition at line 777 of file SettingField.h.

Member Function Documentation

template<typename T >
void fesa::SettingFieldArray2D< T >::checkContext ( MultiplexingContext *  context  )  [inline, protected]

Definition at line 1019 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::SettingFieldArray2D< T >::set(), fesa::SettingFieldStructArray2D< T >::setCell(), fesa::SettingFieldScalarArray2D< T >::setCell(), fesa::SettingFieldArray2D< T >::setColumn(), and fesa::SettingFieldArray2D< T >::setRow().

template<typename T >
const T ** fesa::SettingFieldArray2D< T >::get ( uint32_t &  size1,
uint32_t &  size2,
MultiplexingContext *  context 
) [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 782 of file SettingField.h.

References fesa::FieldValue< T[][1]>::activeBuffer(), fesa::MultiplexingContext::CHECK_FLAG_TO_BE_SYNC, FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, fesa::FieldValue< T[][1]>::getActiveCurrentSize(), fesa::FieldArray2D< 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[][1]>::pendingBuffer().

template<typename T >
void fesa::SettingFieldArray2D< T >::getColumn ( uint32_t  index,
uint32_t  size,
T *  column,
uint32_t &  currentSize,
MultiplexingContext *  context 
) [inline]

Method to retrieve column of active field value.

Parameters:
index index of column
size length of column
column that will receive the values
context the multiplexing context
Returns:
the column in the parameter column

Definition at line 810 of file SettingField.h.

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

template<typename T >
const T * fesa::SettingFieldArray2D< T >::getRow ( uint32_t  index,
uint32_t &  size,
MultiplexingContext *  context 
) [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 854 of file SettingField.h.

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

template<typename T >
void fesa::SettingFieldArray2D< T >::getSize ( uint32_t &  size1,
uint32_t &  size2,
MultiplexingContext *  context 
) [inline]

retrieve the current size of the array

Parameters:
context the multiplexing context
size1 output value giving back the current first dimension of the array
size2 output value giving back the current second dimension of the array

Definition at line 1007 of file SettingField.h.

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

template<typename T >
void fesa::SettingFieldArray2D< T >::set ( const T *const *  val,
uint32_t  size1,
uint32_t  size2,
MultiplexingContext *  context 
) [inline]

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

Parameters:
val Pointer to pointer to new values
size1 length of array dimension 1
size2 length of array dimension 2
context the multiplexing context

Definition at line 894 of file SettingField.h.

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

template<typename T >
void fesa::SettingFieldArray2D< T >::setColumn ( const T *  val,
uint32_t  index,
uint32_t  size,
MultiplexingContext *  context 
) [inline]

Method to set a column of the pending buffer of an array2D.

Parameters:
val new value for the array column
index column index of array row to be set
size length of array column to be set
context the multiplexing context

Definition at line 920 of file SettingField.h.

References fesa::SettingFieldArray2D< T >::checkContext(), fesa::FieldArray2D< T >::checkMaxDimensions(), FesaErrorNULLPointerToContext, FesaErrorWrongSourceContextSettingField, fesa::FieldValue< T[][1]>::getActiveCurrentSize(), fesa::FieldArray2D< T >::getFieldValue(), fesa::FieldValue< T[][1]>::getPendingCurrentSize(), fesa::MultiplexingContext::getSettingAccessMask(), fesa::FieldValueBase::hasPendingChanged(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::FieldValue< T[][1]>::pendingBuffer(), fesa::AbstractField::registerModifiedField(), fesa::AbstractMultiplexingManager::requireSlot(), fesa::AbstractField::resetToBeSync(), fesa::MultiplexingContext::SET_ALLOWED, and fesa::FieldValue< T[][1]>::setPendingCurrentSize().

template<typename T >
void fesa::SettingFieldArray2D< T >::setRow ( const T *  val,
uint32_t  index,
uint32_t  size,
MultiplexingContext *  context 
) [inline]

Method to set a row of the pending buffer of an array2D.

Parameters:
val new value for the array row
index row index of array row to be set
size length of array row to be set
context the multiplexing context

Definition at line 964 of file SettingField.h.

References fesa::SettingFieldArray2D< T >::checkContext(), fesa::FieldArray2D< T >::checkMaxDimensions(), FesaErrorNULLPointerToContext, FesaErrorWrongSourceContextSettingField, fesa::FieldValue< T[][1]>::getActiveCurrentSize(), fesa::FieldArray2D< T >::getFieldValue(), fesa::FieldValue< T[][1]>::getPendingCurrentSize(), fesa::MultiplexingContext::getSettingAccessMask(), fesa::FieldValueBase::hasPendingChanged(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::FieldValue< T[][1]>::pendingBuffer(), fesa::AbstractField::registerModifiedField(), fesa::AbstractMultiplexingManager::requireSlot(), fesa::AbstractField::resetToBeSync(), fesa::MultiplexingContext::SET_ALLOWED, and fesa::FieldValue< T[][1]>::setPendingCurrentSize().

The documentation for this class was generated from the following file:
Generated on 18 Jan 2013 for Fesa by  doxygen 1.6.1