fesa::GenericFieldArray2D< T > Class Template Reference

#include <GenericField.h>

Inheritance diagram for fesa::GenericFieldArray2D< T >:
fesa::FieldArray2D< T > fesa::AbstractField fesa::GenericFieldScalarArray2D< T > fesa::GenericFieldStructArray2D< T >

List of all members.

Public Member Functions

 GenericFieldArray2D (const std::string &fieldName, bool multiplexed, DataStore *pDataStore, bool persistent, int32_t size1, int32_t size2, DataIntegrity bufferType)
 Constructor.
 ~GenericFieldArray2D ()
 destructor
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

Detailed Description

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

Definition at line 504 of file GenericField.h.

Constructor & Destructor Documentation

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

Constructor.

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

Definition at line 592 of file GenericField.h.

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

destructor

Definition at line 600 of file GenericField.h.

Member Function Documentation

template<typename T >
const T ** fesa::GenericFieldArray2D< 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 605 of file GenericField.h.

References fesa::FieldValue< T[][1]>::activeBuffer(), FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, fesa::FieldValue< T[][1]>::getActiveCurrentSize(), fesa::FieldArray2D< T >::getFieldValue(), fesa::AbstractMultiplexingManager::getSlot(), fesa::MultiplexingContext::getType(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, and fesa::MultiplexingContext::NoneCtxt.

template<typename T >
void fesa::GenericFieldArray2D< 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
context the multiplexing context
Returns:
the value of the column in the parameter column

Definition at line 625 of file GenericField.h.

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

template<typename T >
const T * fesa::GenericFieldArray2D< 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 660 of file GenericField.h.

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

template<typename T >
void fesa::GenericFieldArray2D< 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 771 of file GenericField.h.

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

template<typename T >
void fesa::GenericFieldArray2D< 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 690 of file GenericField.h.

References fesa::FieldArray2D< T >::checkMaxDimensions(), FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, fesa::FieldArray2D< T >::getFieldValue(), fesa::MultiplexingContext::getType(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::MultiplexingContext::NoneCtxt, fesa::FieldValue< T[][1]>::pendingBuffer(), fesa::AbstractMultiplexingManager::requireSlot(), and fesa::FieldValue< T[][1]>::setPendingCurrentSize().

template<typename T >
void fesa::GenericFieldArray2D< 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 712 of file GenericField.h.

References fesa::FieldArray2D< T >::checkMaxDimensions(), FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, fesa::FieldArray2D< T >::getFieldValue(), fesa::FieldValue< T[][1]>::getPendingCurrentSize(), fesa::MultiplexingContext::getType(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::MultiplexingContext::NoneCtxt, fesa::FieldValue< T[][1]>::pendingBuffer(), fesa::AbstractMultiplexingManager::requireSlot(), and fesa::FieldValue< T[][1]>::setPendingCurrentSize().

template<typename T >
void fesa::GenericFieldArray2D< 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 742 of file GenericField.h.

References fesa::FieldArray2D< T >::checkMaxDimensions(), FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, fesa::FieldArray2D< T >::getFieldValue(), fesa::FieldValue< T[][1]>::getPendingCurrentSize(), fesa::MultiplexingContext::getType(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::MultiplexingContext::NoneCtxt, fesa::FieldValue< T[][1]>::pendingBuffer(), fesa::AbstractMultiplexingManager::requireSlot(), 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