This class represents a property which computes through server actions the value of a requested attribute. More...

#include <Property.h>

Public Member Functions
	Property (const PropertyConstructorParameters &parameters, AbstractServerAction getServerAction, AbstractServerAction setServerAction)
	Constructor. More...

virtual	~Property ()
	Destructor.

template<typename PropDataType , typename PropFilterType >
std::auto_ptr< PropDataType >	get (AbstractDevice &device, const std::string &cyleSelector, const PropFilterType &filter)
	Template method that returns the value of a property This method is meant to be used by the developer to call a property without using the RDA data but using the real data type of the user's property. More...

template<typename PropDataType >
std::auto_ptr< PropDataType >	get (AbstractDevice &device, const std::string &cyleSelector)
	Template method that returns the value of a property This method is meant to be used by the developer to call a property without using the RDA data but using the real data type of the user's property. More...

std::auto_ptr< PropertyData >	get (AbstractDevice &device, const MultiplexingContext &context)
	Return the data of the property. To be used by property data exporters. More...

template<typename PropDataType , typename PropFilterType >
	__attribute__ ((deprecated)) void get(AbstractDevice &device
	Template method that returns the value of a property This method is meant to be used by the developer to call a property without using the RDA data but using the real data type of the user's property. More...

template<typename PropDataType >
	__attribute__ ((deprecated)) void get(AbstractDevice &device
	Template method that returns the value of a property This method is meant to be used by the developer to call a property without using the RDA data but using the real data type of the user's property. More...

template<typename PropDataType , typename PropFilterType >
void	set (AbstractDevice &dev, const std::string &cyleSelector, const PropDataType &data, const PropFilterType &filter)
	This method modifies the value of the property. More...

template<typename PropDataType >
void	set (AbstractDevice &dev, const std::string &cyleSelector, const PropDataType &data)
	This method modifies the value of the property. More...

bool	hasDataChanged (const MultiplexingContext &context, AbstractDevice &device, const cmw::data::Data &filter)
	Check if the data published by this property changed This method will be called to decide whether a notification needs to be sent or not. More...

void	validateParameters (const AbstractDevice &dev, const Selector &cycleSelector, bool hasFilter, const RequestType::RequestType requestType) const
	This method validates the request to the property throwing an exception in case it is not correct. More...

void	validateFilter (const AbstractDevice &dev, const cmw::data::Data &filter) const
	This method validates the filter data via user code in the GetAction throws an FesaException if the filter is not valid. More...

const std::string &	getName () const
	get name of the property More...

PropertyType::PropertyType	getType () const
	the type of the property (Acquisition/Setting) More...

bool	isAcquisition () const

bool	isGlobal () const
	to know if the property is global More...

bool	isMultiplexed () const

bool	isMultiplexedCapable () const

bool	isCycleBoundCapable () const

bool	isSelectorNeeded () const

bool	isSetting () const

bool	accessPointNeedsSelector (const AbstractDevice &device) const
	Returns true if the access point represented by this device/property needs a selector. An access point is the instantiation of this property on a device. This method returns true if the property and the device both need a selector, false otherwise. More...

bool	isSubscribable () const

virtual void	printConfig (FesaStream &configStream) const
	this method prints the property configuration into the stream passed by argument More...

const std::string &	getNotificationThreadKey () const
	this method generates an Listener error for all underliing subscribers More...

Protected Member Functions
std::auto_ptr< PropertyData >	getInternal (AbstractDevice &device, const MultiplexingContext &context, const cmw::data::Data &filter)
	This method returns the value of a property for a specific context. More...

std::auto_ptr< PropertyData >	getInternal (AbstractDevice &device, const Selector &cycleSelector, const cmw::data::Data &filter)
	This method returns the value of a property for a cycle selector. More...

void	setInternal (AbstractDevice &device, const Selector &cycleSelector, const cmw::data::Data &filter, const PropertyData &value)
	This method modifies the value of the property for a selector. More...

virtual void	validateCycleSelector (const AbstractDevice &device, const Selector &cycleSelector, RequestType::RequestType reqType) const
	Validates a cycle selector. Throws an exception if the selector is invalid. More...

bool	hasDataChanged (const RequestEvent &event, AbstractDevice &device, const cmw::data::Data &filter)
	Check if the data published by this property changed This method will be called to decide whether a notification needs to be sent or not. More...

bool	needFilter () const
	true if the property needs a filter

Protected Attributes
std::string	name_
	name of the property

bool	isGlobal_
	true if the property is global

bool	isSubscribable_
	true if the property supports subscription

PropertyType::PropertyType	type_
	indicates if the property is an acquisition or setting property

bool	selectorNeeded_

std::string	notificationThreadKey_
	the notification thread key associated to this property. This value is taken from teh code-generation and identifies the thread where all teh notification for this property will run

AbstractServerAction *	getServerAction_
	server action to get the value of the property

AbstractServerAction *	setServerAction_
	server action to set the value of the property

std::string	className_
	name of the class the property belongs to

Detailed Description

This class represents a property which computes through server actions the value of a requested attribute.

Constructor & Destructor Documentation

fesa::Property::Property	(	const PropertyConstructorParameters &	parameters,
		AbstractServerAction *	getServerAction,
		AbstractServerAction *	setServerAction
	)

Constructor.

Parameters

parameters	contains all mandatory parameters of the property
getServerAction	with the pointer to the server action that will be executed to get the value for the property (NULL if not used)
setServerAction	with the pointer to the server action that will be executed to set the value for the property (NULL if not used)

Member Function Documentation

template<typename PropDataType , typename PropFilterType >

fesa::Property::__attribute__ ( (deprecated) )

Template method that returns the value of a property This method is meant to be used by the developer to call a property without using the RDA data but using the real data type of the user's property.

Deprecated:: Use the version that returns a std::auto_ptr<PropDataType> instead.

Template Parameters

PropDataType	Type of the data, as it is defined in the custom class
PropFilterType	Type of the filter, as it is defined in the custom class

Parameters

	device	the device we want to access
	cyleSelector	cycle for which the value of the property will be retrieved
[out]	value	data containing the value of the property

Exceptions

This	function can throw different FesaExceptions

template<typename PropDataType >

fesa::Property::__attribute__ ( (deprecated) )

Template method that returns the value of a property This method is meant to be used by the developer to call a property without using the RDA data but using the real data type of the user's property.

Deprecated:: Use the version that returns a std::auto_ptr<PropDataType> instead.

Template Parameters

PropDataType Type of the data, as it is defined in the custom class

Parameters

	device	the device we want to access
	cyleSelector	cycle for which the value of the property will be retrieved
[out]	value	data containing the value of the property

Exceptions

This	function can throw different FesaExceptions

bool fesa::Property::accessPointNeedsSelector ( const AbstractDevice & device ) const

Returns true if the access point represented by this device/property needs a selector. An access point is the instantiation of this property on a device. This method returns true if the property and the device both need a selector, false otherwise.

Returns: true if the access point represented by this device/property needs a selector.

template<typename PropDataType , typename PropFilterType >

std::auto_ptr< PropDataType > fesa::Property::get	(	AbstractDevice &	device,
		const std::string &	cyleSelector,
		const PropFilterType &	filter
	)

Template method that returns the value of a property This method is meant to be used by the developer to call a property without using the RDA data but using the real data type of the user's property.

Template Parameters

PropDataType	Type of the data, as it is defined in the custom class
PropFilterType	Type of the filter, as it is defined in the custom class

Parameters

device	the device we want to access
cyleSelector	cycle for which the value of the property will be retrieved
filter	data containing the filter of the property

Returns: value data containing the value of the property

Exceptions

This	function can throw different FesaExceptions

template<typename PropDataType >

std::auto_ptr< PropDataType > fesa::Property::get	(	AbstractDevice &	device,
		const std::string &	cyleSelector
	)

Template method that returns the value of a property This method is meant to be used by the developer to call a property without using the RDA data but using the real data type of the user's property.

Template Parameters

PropDataType Type of the data, as it is defined in the custom class

Parameters

device	the device we want to access
cyleSelector	cycle for which the value of the property will be retrieved

Returns: value data containing the value of the property

Exceptions

This	function can throw different FesaExceptions

std::auto_ptr< PropertyData > fesa::Property::get	(	AbstractDevice &	device,
		const MultiplexingContext &	context
	)

Return the data of the property. To be used by property data exporters.

Parameters

device	The device for which the data of the property to be taken
context	The context for which the data of the property to be taken

Returns: The data of the property for the given device and the given context

Exceptions

FesaException

std::auto_ptr< PropertyData > fesa::Property::getInternal	(	AbstractDevice &	device,
		const MultiplexingContext &	context,
		const cmw::data::Data &	filter
	)

protected

This method returns the value of a property for a specific context.

Parameters

device	device we want to access
context	context for which we want the value of the property
filter	RDA data containing the filter of the property

Exceptions

This	function can throw different FesaExceptions

Returns: a PropertyData object containing the value of the property.

std::auto_ptr< PropertyData > fesa::Property::getInternal	(	AbstractDevice &	device,
		const Selector &	cycleSelector,
		const cmw::data::Data &	filter
	)

protected

This method returns the value of a property for a cycle selector.

Parameters

device	device we want to access
cycleSelector	cycle for which the value of the property will be retrieved
filter	RDA data containing the filter of the property

Returns: a PropertyData object containing the value of the property.

const std::string & fesa::Property::getName ( ) const

inline

get name of the property

Returns: reference to the name of the property

const std::string & fesa::Property::getNotificationThreadKey ( ) const

this method generates an Listener error for all underliing subscribers

Parameters

Messsage The error message

PropertyType::PropertyType fesa::Property::getType ( ) const

inline

the type of the property (Acquisition/Setting)

Returns: the type

bool fesa::Property::hasDataChanged	(	const MultiplexingContext &	context,
		AbstractDevice &	device,
		const cmw::data::Data &	filter
	)

Check if the data published by this property changed This method will be called to decide whether a notification needs to be sent or not.

Parameters

context	The context to use
device	The device this property belongs to
filter	The data filter

Returns: true if the data published by the property changed, false otherwise

bool fesa::Property::hasDataChanged	(	const RequestEvent &	event,
		AbstractDevice &	device,
		const cmw::data::Data &	filter
	)

protected

Check if the data published by this property changed This method will be called to decide whether a notification needs to be sent or not.

Parameters

event	The request event that triggered this server action
device	The device this property belongs to
filter	The data filter

Returns: true if the data published by the property changed, false otherwise

bool fesa::Property::isAcquisition ( ) const

inline

Returns: true if the property is an acquisition property

bool fesa::Property::isCycleBoundCapable ( ) const

Returns: true if the property has the capability to be cycle-bound. Note: only acquisition properties can have such capability. When called on a setting or command property, this function will always return false.

bool fesa::Property::isGlobal ( ) const

inline

to know if the property is global

Returns: true if the property is global, otherwise false

bool fesa::Property::isMultiplexed ( ) const

Deprecated:: use the direct equivalent isSelectorNeeded(), or isMultiplexedCapable() or isCycleBoundCapable() instead.

Returns: true if the property is multiplexed or cycle-bound.

bool fesa::Property::isMultiplexedCapable ( ) const

Returns: true if the property has the capability to be multiplexed. Note: only acquisition properties can have such capability. When called on a setting or command property, this function will always return false.

bool fesa::Property::isSelectorNeeded ( ) const

Returns: true if the property needs a selector (multiplexed setting property, or cycle-bound acquisition property). This is checked independently of a device. In order to check if a selector is needed for an access point (device/property pair), use accessPointNeedsSelector().

bool fesa::Property::isSetting ( ) const

inline

Returns: true if the property is a setting property

bool fesa::Property::isSubscribable ( ) const

inline

Returns: true if the property is subscribable

void fesa::Property::printConfig ( FesaStream & configStream ) const

virtual

this method prints the property configuration into the stream passed by argument

Parameters

configStream in which the information will be printed

template<typename PropDataType , typename PropFilterType >

void fesa::Property::set	(	AbstractDevice &	dev,
		const std::string &	cyleSelector,
		const PropDataType &	data,
		const PropFilterType &	filter
	)

This method modifies the value of the property.

Parameters

dev	device we want to access
cycleSelector	cycle for which the value of the property will be retrieved
data	value to set
filter	data containing the filter of the property

Exceptions

This	function can throw different FesaExceptions

template<typename PropDataType >

void fesa::Property::set	(	AbstractDevice &	dev,
		const std::string &	cyleSelector,
		const PropDataType &	data
	)

This method modifies the value of the property.

Parameters

dev	device we want to access
cycleSelector	cycle for which the value of the property will be retrieved
data	value to set

Exceptions

This	function can throw different FesaExceptions

void fesa::Property::setInternal	(	AbstractDevice &	device,
		const Selector &	cycleSelector,
		const cmw::data::Data &	filter,
		const PropertyData &	value
	)

protected

This method modifies the value of the property for a selector.

Parameters

device	device we want to access
cycleSelector	cycle for which the property will be set (ignored if the property is not multiplexed)
filter	RDA data containing the filter of the property
value	PropertyData containing the value to set

Exceptions

This	function can throw different FesaExceptions

void fesa::Property::validateCycleSelector	(	const AbstractDevice &	device,
		const Selector &	cycleSelector,
		RequestType::RequestType	reqType
	)		const

protectedvirtual

Validates a cycle selector. Throws an exception if the selector is invalid.

Parameters

device	The device on which the operation (get/set/monitor) is done
cycleSelector	to be checked
reqType	The type of request

Exceptions

FesaException indicating the reason why the selector is refused

void fesa::Property::validateFilter	(	const AbstractDevice &	dev,
		const cmw::data::Data &	filter
	)		const

This method validates the filter data via user code in the GetAction throws an FesaException if the filter is not valid.

Parameters

dev	device subscribed to
filter	data to validate

void fesa::Property::validateParameters	(	const AbstractDevice &	dev,
		const Selector &	cycleSelector,
		bool	hasFilter,
		const RequestType::RequestType	requestType
	)		const

This method validates the request to the property throwing an exception in case it is not correct.

Parameters

dev	device
cycleSelector
hasFilter	true if the property has filter
requestType	the type of request

Member Data Documentation

bool fesa::Property::selectorNeeded_

protected

True if the property needs a selector (multiplexed or cycle-bound).

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

Property.h
Property.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation