fesa::SettingFieldStringArray Class Reference

#include <SettingField.h>

Inheritance diagram for fesa::SettingFieldStringArray:

List of all members.

Public Member Functions
	SettingFieldStringArray (const std::string &fieldName, bool multiplexed, bool multiMultiplexed, DataStore *pDataStore, bool persistent, bool shared, int32_t size1, int32_t size2, const DataIntegrity bufferType=DoubleBuffered)
	Constructor.
	~SettingFieldStringArray ()
const char **	get (uint32_t &size1, MultiplexingContext *context)
	Method to retrieve the value of the field.
const char **	get (uint32_t &size1, uint32_t &size2, MultiplexingContext *context)
	Method to retrieve the value of the field.
const char *	getString (uint32_t index, MultiplexingContext *context)
	Method to retrieve one string of the field value.
void	set (const char **val, uint32_t size1, MultiplexingContext *context)
	Method to set the new value of the pending buffer of the field.
void	setString (const char *val, uint32_t index, MultiplexingContext *context)
	Method to set the one string of the pending buffer of the field.

---

Detailed Description

Definition at line 1337 of file SettingField.h.

---

Constructor & Destructor Documentation

fesa::SettingFieldStringArray::SettingFieldStringArray	(	const std::string &	fieldName,
		bool	multiplexed,
		bool	multiMultiplexed,
		DataStore *	pDataStore,
		bool	persistent,
		bool	shared,
		int32_t	size1,
		int32_t	size2,
		const DataIntegrity	bufferType = DoubleBuffered
	)

Constructor.

Parameters:

name

of the field, multiplexing criterion, pointer to DataStore

Definition at line 79 of file SettingField.cpp.

References fesa::AbstractField::isShared_.

fesa::SettingFieldStringArray::~SettingFieldStringArray

(

)

Definition at line 89 of file SettingField.cpp.

---

Member Function Documentation

const char** fesa::SettingFieldStringArray::get	(	uint32_t &	size1,
		uint32_t &	size2,
		MultiplexingContext *	context
	)

Method to retrieve the value of the field.

Parameters:

context

the multiplexing context

Returns:

the value of the pending buffer

const char ** fesa::SettingFieldStringArray::get	(	uint32_t &	size1,
		MultiplexingContext *	context
	)

Method to retrieve the value of the field.

Parameters:

context

the multiplexing context

Returns:

the value of the pending buffer

Definition at line 93 of file SettingField.cpp.

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

const char * fesa::SettingFieldStringArray::getString	(	uint32_t	index,
		MultiplexingContext *	context
	)

Method to retrieve one string of the field value.

Parameters:

	index	index of the string
	context	the multiplexing context

Returns:

the value of the pending buffer

Definition at line 120 of file SettingField.cpp.

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

void fesa::SettingFieldStringArray::set	(	const char **	val,
		uint32_t	size1,
		MultiplexingContext *	context
	)

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

Parameters:

	val	new value of field
	context	the multiplexing context

Definition at line 153 of file SettingField.cpp.

References FesaErrorFieldMaxDimensionsOutOfBound, FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, fesa::FieldStringArray::getFieldValue(), fesa::MultiplexingContext::getSettingAccessMask(), fesa::MultiplexingContext::getType(), fesa::FieldStringArray::maxSize1_, fesa::FieldStringArray::maxSize2_, fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::MultiplexingContext::NoneCtxt, fesa::FieldValue< char *[]>::pendingBuffer(), fesa::FieldStringArray::pointers_, fesa::AbstractField::registerModifiedField(), fesa::AbstractMultiplexingManager::requireSlot(), fesa::AbstractField::resetToBeSync(), fesa::MultiplexingContext::SET_ALLOWED, fesa::FieldValue< char *[]>::setPendingCurrentSize(), and fesa::StringUtilities::toString().

void fesa::SettingFieldStringArray::setString	(	const char *	val,
		uint32_t	index,
		MultiplexingContext *	context
	)

Method to set the one string of the pending buffer of the field.

Parameters:

	val	new value of field
	index	index of the string *
	context	the multiplexing context

Definition at line 198 of file SettingField.cpp.

References fesa::FieldValue< char *[]>::activeBuffer(), FesaErrorFieldMaxDimensionsOutOfBound, FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, fesa::FieldValue< char *[]>::getActiveCurrentSize(), fesa::FieldStringArray::getFieldValue(), fesa::FieldValue< char *[]>::getPendingCurrentSize(), fesa::MultiplexingContext::getSettingAccessMask(), fesa::MultiplexingContext::getType(), fesa::FieldValueBase::hasPendingChanged(), fesa::FieldStringArray::maxSize1_, fesa::FieldStringArray::maxSize2_, fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::MultiplexingContext::NoneCtxt, fesa::FieldValue< char *[]>::pendingBuffer(), fesa::FieldStringArray::pointers_, fesa::AbstractField::registerModifiedField(), fesa::AbstractMultiplexingManager::requireSlot(), fesa::AbstractField::resetToBeSync(), fesa::MultiplexingContext::SET_ALLOWED, fesa::FieldValue< char *[]>::setPendingCurrentSize(), and fesa::StringUtilities::toString().

---

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

• DataStore/SettingField.h
• DataStore/SettingField.cpp