fesa::SettingFieldStruct< T > Class Template Reference

Wrapper class for setting fields. More...

#include <SettingField.h>

Inheritance diagram for fesa::SettingFieldStruct< T >:

List of all members.

Public Member Functions
	SettingFieldStruct (const std::string &fieldName, bool multiplexed, bool multiMultiplexed, DataStore *pDataStore, bool persistent, bool shared, const DataIntegrity bufferType=DoubleBuffered)
	~SettingFieldStruct ()
	Destructor.
const T *	get (MultiplexingContext *)
	Method to retrieve the value of the field.
const T *	getPending (MultiplexingContext *)
	Method to retrieve the pending value of the field Pending value becomes active after a commit.
void	set (T *val, MultiplexingContext *)
	Method to set the new value of the pending buffer of the field.
Protected Member Functions
void	checkContext (MultiplexingContext *context)

---

Detailed Description

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

Wrapper class for setting fields.

Definition at line 149 of file SettingField.h.

---

Constructor & Destructor Documentation

template<typename T >

fesa::SettingFieldStruct< T >::SettingFieldStruct	(	const std::string &	fieldName,
		bool	multiplexed,
		bool	multiMultiplexed,
		DataStore *	pDataStore,
		bool	persistent,
		bool	shared,
		const DataIntegrity	bufferType = DoubleBuffered
	)			[inline]

Definition at line 192 of file SettingField.h.

References fesa::AbstractField::isShared_.

template<typename T >

fesa::SettingFieldStruct< T >::~SettingFieldStruct

(

)

[inline]

Destructor.

Definition at line 203 of file SettingField.h.

---

Member Function Documentation

template<typename T >

void fesa::SettingFieldStruct< T >::checkContext

(

MultiplexingContext *

context

)

[inline, protected]

Definition at line 277 of file SettingField.h.

References FesaErrorNoneContextforMuxedField, FesaErrorNULLPointerToContext, FesaErrorWrongSourceContextSettingField, fesa::MultiplexingContext::getSettingAccessMask(), fesa::MultiplexingContext::getType(), fesa::AbstractField::multiplexingManager_, fesa::AbstractField::name_, fesa::MultiplexingContext::NoneCtxt, and fesa::MultiplexingContext::SET_ALLOWED.

template<typename T >

const T * fesa::SettingFieldStruct< T >::get

(

MultiplexingContext *

context

)

[inline]

Method to retrieve the value of the field.

Parameters:

context

the multiplexing context

Returns:

the value

Definition at line 208 of file SettingField.h.

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

template<typename T >

const T * fesa::SettingFieldStruct< T >::getPending

(

MultiplexingContext *

context

)

[inline]

Method to retrieve the pending value of the field Pending value becomes active after a commit.

Parameters:

context

the multiplexing context

Returns:

the value of the pending buffer

Definition at line 235 of file SettingField.h.

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

template<typename T >

void fesa::SettingFieldStruct< 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 252 of file SettingField.h.

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

---

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

• DataStore/SettingField.h