Field template class for strings. More...

#include <FieldString.h>

Inheritance diagram for fesa::FieldString:

Public Types
typedef const char *	value_type
	data type stored in the field string

Public Member Functions
	FieldString (const FieldConfig &fieldConfig, DataStore *pDataStore, std::size_t size)
	Constructor. More...

	~FieldString ()
	destructor

std::size_t	getMaxSize () const
	retrieve the size of the array More...

Public Member Functions inherited from fesa::AbstractField
virtual	~AbstractField ()
	destructor

AbstractMultiplexingManager *	getMultiplexingManager ()

uint32_t	getMuxDepth () const

bool	isMultiplexed () const

const std::string &	getName () const

FieldCategory	getType () const

bool	isPersistent () const

bool	isShared () const

virtual std::string	getAsString (const MultiplexingContext *context) const =0
	Method to retrieve the value of the field converted to string. More...

std::string	getAttributeAsStringByName (const std::string &attribute, MultiplexingContext *context=NULL)
	Method to retrieve the struct attribute value converted to string. More...

Protected Member Functions
void	initializeDimensions (const boost::shared_ptr< FieldElement > &fieldElement)
	used to initialize dimensions of the field from the instance document More...

std::size_t	getFieldValueSize () const
	Method to get the size of the field-value object. The template of the field-value class depends on the field type. More...

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. More...

FieldValueArray< char > *	getFieldValue (int32_t slot)
	Get the field's value for a given slot. More...

void	copyValue (uint32_t slot, const std::string &str)
	this method puts in the slot the value passed by parameter in the corresponding format More...

void	getValueToStore (int32_t slot, std::string &str) const

void	setFieldValue (FieldValueArray< char > &fieldValue, const char *value)

void	setFieldValue (FieldValueArray< char > &fieldValue, const std::string &value)

Protected Member Functions inherited from fesa::AbstractField
virtual void	initializeDefaultValue (const std::string &value)
	Initialize the default value with a value provided in the instantiation file. More...

void	setMultiplexingManager (AbstractMultiplexingManager *muxManager)
	changes the multiplexing manager of the field. More...

void	setDataIntegrity (DataIntegrity dataIntegrity)
	changes the data integrity value of the field

void	restore (const PersistanceFieldElement &fieldElement)
	gives the value to the field from the field element This method should be used to populate the fields at instantiation More...

void	store (PersistanceFieldElement &fieldElement)
	Used to persist fields. More...

	AbstractField (const FieldConfig &fieldConfig, DataStore *dataStore)
	Constructor. More...

template<typename T >
T *	getSlotPointer (void *baseAddress, std::size_t slot)

template<typename T >
const T *	getSlotPointer (const void *baseAddress, std::size_t slot) const

virtual void	getAttributeValueToStore (int32_t slot, const std::string &attribute, std::string &str)

template<typename T >
void	validateValue (const T &value) const

template<typename T >
void	validateValues (const T *values, const std::size_t count) const

void	setMultiplexed (bool multiplexed)
	changes the multiplexing status

Protected Attributes
std::size_t	maxSize_
	maximum size of the string without the finish symbol

FieldValueArray< char > *	fieldValue_
	value of field

Protected Attributes inherited from fesa::AbstractField
std::string	name_
	name of the field

FieldCategory	fieldCategory_
	category of the field (Acquisition, Generic, Setting or Configuration)

bool	multiplexed_
	true if the field is multiplexed

bool	shared_
	flag that indicates whether field is shared byt RT and Server

bool	persistent_
	flag that indicates whether field is persistent

DataIntegrity	buffer_
	type of buffer of the field

AbstractMultiplexingManager *	multiplexingManager_
	multiplexing manager of the field

DataStore *	dataStore_
	The data store this field belongs to.

std::size_t	valueSize_
	size of the value

Additional Inherited Members
Static Public Attributes inherited from fesa::AbstractField
static const std::size_t	INVALID_SIZE = std::numeric_limits<std::size_t>::max()

Detailed Description

Field template class for strings.

Constructor & Destructor Documentation

fesa::FieldString::FieldString	(	const FieldConfig &	fieldConfig,
		DataStore *	pDataStore,
		std::size_t	size
	)

Constructor.

Parameters

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

Member Function Documentation

void fesa::FieldString::copyValue	(	uint32_t	slot,
		const std::string &	str
	)

protectedvirtual

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.

FieldValueArray< char > * fesa::FieldString::getFieldValue ( int32_t slot )

protectedvirtual

Get the field's value for a given slot.

Parameters

slot	The slot to get the field's value from

Returns: The field's value

Implements fesa::AbstractField.

std::size_t fesa::FieldString::getFieldValueSize ( ) const

protectedvirtual

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.

std::size_t fesa::FieldString::getMaxSize ( ) const

retrieve the size of the array

Parameters

size	of the array the context

void fesa::FieldString::getValueToStore	(	int32_t	slot,
		std::string &	str
	)		const

protectedvirtual

Returns: the value of the pending buffer as a string

Implements fesa::AbstractField.

void fesa::FieldString::initializeDimensions ( const boost::shared_ptr< FieldElement > & fieldElement )

protectedvirtual

used to initialize dimensions of the field from the instance document

Parameters

fieldElement that contains the values for the field

Reimplemented from fesa::AbstractField.

void fesa::FieldString::setFieldValue	(	FieldValueArray< char > &	fieldValue,
		const char *	value
	)

protected

Copies the given string to the fieldValue.

Parameters

fieldValue	the destination fieldValue
val	the null-terminated string to copy

void fesa::FieldString::setFieldValue	(	FieldValueArray< char > &	fieldValue,
		const std::string &	value
	)

protected

Copies the given string to the fieldValue.

Parameters

fieldValue	the destination fieldValue
val	the string to copy

void fesa::FieldString::setFieldValueAddress	(	char *	pFV,
		bool	initFieldsFlag
	)

protectedvirtual

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.

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

FieldString.h
FieldString.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation