fesa::FieldString Class Reference

#include <FieldString.h>

Inheritance diagram for fesa::FieldString:

List of all members.

Public Member Functions
	FieldString (const std::string &fieldName, const FieldCategory fieldCategory, bool multiplexed, bool multiMultiplexed, bool persistent, DataIntegrity bufferType, DataStore *pDataStore, int32_t size)
	Constructor.
	~FieldString ()
	destructor
uint32_t	getMaxSize ()
	retrieve the size of the array
Protected Member Functions
void	initialize (FieldElement &fieldElement)
	used to initialize some parameters of the field from the instance document
uint32_t	getFieldValueSize ()
	Method to get the size of the field-value object. The template of the field-value class depends on the field type.
void	setFieldValueAddress (char *pFV, bool initFieldsFlag)
	Maps an address in shared memory or on the heap to the field value member of the field class.
FieldValue< char[]> *	getFieldValue (int32_t slot)
void	copyValue (uint32_t slot, std::string &str)
	this method puts in the slot the value passed by parameter in the corresponding format
void	getValueToStore (int32_t slot, std::string &str)
Protected Attributes
uint32_t	maxSize_
	maximum size of the string without the finish symbol
FieldValue< char[]> *	fieldValue_
	value of field

---

Detailed Description

Definition at line 16 of file FieldString.h.

---

Constructor & Destructor Documentation

fesa::FieldString::FieldString	(	const std::string &	fieldName,
		const FieldCategory	fieldCategory,
		bool	multiplexed,
		bool	multiMultiplexed,
		bool	persistent,
		DataIntegrity	bufferType,
		DataStore *	pDataStore,
		int32_t	size
	)

Constructor.

Parameters:

name

of the field, field category, multiplexing criterion, pointer to DataStore

Definition at line 15 of file FieldString.cpp.

fesa::FieldString::~FieldString

(

)

destructor

Definition at line 23 of file FieldString.cpp.

---

Member Function Documentation

void fesa::FieldString::copyValue	(	uint32_t	slot,
		std::string &	str
	)			[protected, virtual]

this method puts in the slot the value passed by parameter in the corresponding format

Parameters:

	slot	to put the value
	val	value to put

Implements fesa::AbstractField.

Definition at line 86 of file FieldString.cpp.

References getFieldValue(), and maxSize_.

FieldValue< char[]> * fesa::FieldString::getFieldValue

(

int32_t

slot

)

[inline, protected, virtual]

Returns:

the field value object for the slot passed by parameter

Implements fesa::AbstractField.

Definition at line 28 of file FieldString.cpp.

References fieldValue_, and fesa::AbstractField::valueSize_.

Referenced by copyValue(), fesa::SettingFieldString::get(), fesa::GenericFieldString::get(), fesa::AcqFieldString::get(), getValueToStore(), fesa::SettingFieldString::set(), fesa::GenericFieldString::set(), and fesa::AcqFieldString::set().

uint32_t fesa::FieldString::getFieldValueSize

(

)

[protected, virtual]

Method to get the size of the field-value object. The template of the field-value class depends on the field type.

Returns:

the size in bytes of the field value object.

Implements fesa::AbstractField.

Definition at line 76 of file FieldString.cpp.

References fesa::AbstractField::buffer_, maxSize_, and fesa::AbstractField::valueSize_.

uint32_t fesa::FieldString::getMaxSize

(

)

retrieve the size of the array

Parameters:

size

of the array the context

Definition at line 117 of file FieldString.cpp.

References maxSize_.

void fesa::FieldString::getValueToStore	(	int32_t	slot,
		std::string &	str
	)			[protected, virtual]

Implements fesa::AbstractField.

Definition at line 101 of file FieldString.cpp.

References fesa::FieldValue< char[]>::activeBuffer(), getFieldValue(), fesa::FieldValueBase::hasPendingChanged(), fesa::FieldValueBase::isToBeSync(), and fesa::FieldValue< char[]>::pendingBuffer().

void fesa::FieldString::initialize

(

FieldElement &

fieldElement

)

[protected, virtual]

used to initialize some parameters of the field from the instance document

Parameters:

fieldElement

that contains the values for the field

Reimplemented from fesa::AbstractField.

Definition at line 66 of file FieldString.cpp.

References fesa::FieldElement::dimension1_, and maxSize_.

void fesa::FieldString::setFieldValueAddress	(	char *	pFV,
		bool	initFieldsFlag
	)			[protected, virtual]

Maps an address in shared memory or on the heap to the field value member of the field class.

Parameters:

pFV

pointer to a field value.

Implements fesa::AbstractField.

Definition at line 37 of file FieldString.cpp.

References fesa::AbstractField::buffer_, FesaErrorSettingFieldValueAddress, fieldValue_, fesa::AbstractMultiplexingManager::getDepth(), maxSize_, fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, and fesa::AbstractField::valueSize_.

---

Member Data Documentation

FieldValue<char[]>* fesa::FieldString::fieldValue_ [protected]

value of field

Definition at line 87 of file FieldString.h.

Referenced by fesa::ConfigFieldString::get(), fesa::ConfigFieldString::getAsString(), getFieldValue(), and setFieldValueAddress().

uint32_t fesa::FieldString::maxSize_ [protected]

maximum size of the string without the finish symbol

Definition at line 81 of file FieldString.h.

Referenced by copyValue(), getFieldValueSize(), getMaxSize(), initialize(), fesa::SettingFieldString::set(), fesa::GenericFieldString::set(), fesa::AcqFieldString::set(), and setFieldValueAddress().

---

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

• DataStore/FieldString.h
• DataStore/FieldString.cpp