fesa::GenericFieldScalar< T > Class Template Reference

Wrapper class for scalar generic fields. The generic field API offer methods to set fields, in contrast to configuration fields which cannot be set dynamically because they are constant. More...

#include <GenericField.h>

Inheritance diagram for fesa::GenericFieldScalar< T >:

List of all members.

Public Member Functions
	GenericFieldScalar (const std::string &fieldName, bool multiplexed, DataStore *pDataStore, bool persistent=false, DataIntegrity bufferType=SingleBuffered)
	Constructor.
	~GenericFieldScalar ()
	destructor
T	get (MultiplexingContext *)
	Method to retrieve the value of the field.
void	set (T val, MultiplexingContext *)
	Method to set the new value of the pending buffer of the field.

---

Detailed Description

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

Wrapper class for scalar generic fields. The generic field API offer methods to set fields, in contrast to configuration fields which cannot be set dynamically because they are constant.

Definition at line 23 of file GenericField.h.

---

Constructor & Destructor Documentation

template<typename T >

fesa::GenericFieldScalar< T >::GenericFieldScalar	(	const std::string &	fieldName,
		bool	multiplexed,
		DataStore *	pDataStore,
		bool	persistent = false,
		DataIntegrity	bufferType = SingleBuffered
	)			[inline]

Constructor.

Parameters:

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

Definition at line 56 of file GenericField.h.

template<typename T >

fesa::GenericFieldScalar< T >::~GenericFieldScalar

(

)

[inline]

destructor

Definition at line 64 of file GenericField.h.

---

Member Function Documentation

template<typename T >

T fesa::GenericFieldScalar< T >::get

(

MultiplexingContext *

context

)

[inline]

Method to retrieve the value of the field.

Parameters:

context

the multiplexing context

Returns:

the value of the pending buffer

Definition at line 69 of file GenericField.h.

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

template<typename T >

void fesa::GenericFieldScalar< T >::set	(	T	val,
		MultiplexingContext *	context
	)			[inline]

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 86 of file GenericField.h.

References FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, fesa::Field< T >::getFieldValue(), fesa::MultiplexingContext::getType(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::MultiplexingContext::NoneCtxt, fesa::FieldValue< T >::pendingBuffer(), and fesa::AbstractMultiplexingManager::requireSlot().

---

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

• DataStore/GenericField.h