#include <FieldFunctionList.h>

Inheritance diagram for fesa::FieldFunctionList:

Public Member Functions
std::size_t	getMaxNFunctions () const

std::size_t	getMaxNPoints () const

Public Member Functions inherited from fesa::FieldArray< detail::FunctionStorage >
	FieldArray (const FieldConfig &fieldConfig, DataStore *pDataStore, std::size_t size)
	Constructor. More...

	~FieldArray ()
	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...

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

void	checkMaxDimensions (const ImmutableFunctionList &functionList) const

void	checkValues (const ImmutableFunctionList &functionList) const

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

Protected Member Functions inherited from fesa::FieldArray< detail::FunctionStorage >
std::size_t	getFieldValueSize () const

std::size_t	getFieldValueAlignment () const

std::size_t	getFieldValueDataOffset () const

void	checkMaxDimension (std::size_t size) const
	this method checks whether the size passed by parameter is within the max size of the array. If it is not, the method throws a FesaException More...

void	checkIndexBounds (const FieldValueArray< detail::FunctionStorage > &fieldValue, std::size_t index) const

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

void	setFieldValue (FieldValueArray< detail::FunctionStorage > &fieldValue, const detail::FunctionStorage *val, std::size_t size)

void	setFieldValue (FieldValueArray< detail::FunctionStorage > &fieldValue, RandomAccessIterator first, RandomAccessIterator last)

void	setCellValue (FieldValueArray< detail::FunctionStorage > &fieldValue, const detail::FunctionStorage &val, std::size_t index)

const detail::FunctionStorage &	getCellRef (const FieldValueArray< detail::FunctionStorage > &fieldValue, std::size_t index) const

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, bool ignoreInvalidValues)
	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

Additional Inherited Members
Public Types inherited from fesa::FieldArray< detail::FunctionStorage >
typedef detail::FunctionStorage	value_type
	data type stored in the field array

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

Protected Attributes inherited from fesa::FieldArray< detail::FunctionStorage >
std::size_t	maxSize_
	maximum size of the array

FieldValueArray < detail::FunctionStorage > *	fieldValue_
	value of field in the first slot

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

Detailed Description

Represents a field containing a function list. A function list is stored as an array of array of points. Every function has its own size (represented by FunctionStorage). Every function is stored at a fixed place in memory that never changes, allowing to modify individual functions efficiently.

Member Function Documentation

void fesa::FieldFunctionList::checkMaxDimensions ( const ImmutableFunctionList & functionList ) const

protected

Ensures that functionList fits the dimensions of this field.

Exceptions

FesaException if it doesn't fit.

void fesa::FieldFunctionList::checkValues ( const ImmutableFunctionList & functionList ) const

protected

Ensures that data in functionList is correctly formed.

Exceptions

FesaException if data is malformed.

void fesa::FieldFunctionList::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

Reimplemented from fesa::FieldArray< detail::FunctionStorage >.

std::size_t fesa::FieldFunctionList::getMaxNFunctions ( ) const

Returns the maximum number of functions that this field can hold.

std::size_t fesa::FieldFunctionList::getMaxNPoints ( ) const

Returns the maximum number of points a function of this field can have.

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

protectedvirtual

Returns: the value of the pending buffer as a string

Reimplemented from fesa::FieldArray< detail::FunctionStorage >.

void fesa::FieldFunctionList::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::FieldArray< detail::FunctionStorage >.

void fesa::FieldFunctionList::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.

Reimplemented from fesa::FieldArray< detail::FunctionStorage >.

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

FieldFunctionList.h
FieldFunctionList.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation