Collapse all Symbian^3 Product Developer Library

MSsyPropertyProvider Class Reference

class MSsyPropertyProvider

Channel property provider implementation

Public Member Functions
void	CheckPropertyDependenciesL(const TSensrvChannelId, const TSensrvProperty &, RSensrvChannelList &)
void	GetAllPropertiesL(const TSensrvChannelId, RSensrvPropertyList &)
void	GetPropertyL(const TSensrvChannelId, TSensrvProperty &)
void	GetPropertyProviderInterfaceL(TUid, TAny *&)
void	SetPropertyL(const TSensrvChannelId, const TSensrvProperty &)

Member Functions Documentation

CheckPropertyDependenciesL(const TSensrvChannelId, const TSensrvProperty &, RSensrvChannelList &)

void	CheckPropertyDependenciesL	(	const TSensrvChannelId	aChannelId,
			const TSensrvProperty &	aProperty,
			RSensrvChannelList &	aAffectedChannels
		)	[pure virtual]

Check if property value affects other sensor channels already open. If the new property value is legal but affects somehow other channels' properties, SSY must return list of the affected channels so that the sensor server can check if the client is allowed to set this property. If the SSY value is not legal SSY must leave with KErrArgument-value.

Since: S60 5.0

leave: KErrNotFound If the property is not found.

Parameters

const TSensrvChannelId aChannelId	Channel Id to be linked to this operation
const TSensrvProperty & aProperty	Property to be checked.
RSensrvChannelList & aAffectedChannels	Return list of the channel which will be affected if the property value will be set.

GetAllPropertiesL(const TSensrvChannelId, RSensrvPropertyList &)

void	GetAllPropertiesL	(	const TSensrvChannelId	aChannelId,
			RSensrvPropertyList &	aChannelPropertyList
		)	[pure virtual]

Get all channel properties. Returns all properties which are related to this channel.

Since: S60 5.0

Parameters

const TSensrvChannelId aChannelId	Channel Id to be linked to this get all properties operation
RSensrvPropertyList & aChannelPropertyList	List of the all properties of the channel.

GetPropertyL(const TSensrvChannelId, TSensrvProperty &)

void	GetPropertyL	(	const TSensrvChannelId	aChannelId,
			TSensrvProperty &	aProperty
		)	[pure virtual]

Get channel property value. The property parameter contains channel id and item index.

In case of array property, the required array index is also included. If array index is not defined and the property is an array property, then array info property object must be returned (ESensrvArrayPropertyInfo).

SSY fills values and attributes to the property object.

Since: S60 5.0

leave: KErrNotFound If the property is not found.

Parameters

const TSensrvChannelId aChannelId	Channel Id to be linked to this get property operation
TSensrvProperty & aProperty	Reference to a property object to be filled with property values and attributes.

GetPropertyProviderInterfaceL(TUid, TAny *&)

void	GetPropertyProviderInterfaceL	(	TUid	aInterfaceUid,
			TAny *&	aInterface
		)	[pure virtual]

Returns a pointer to a specified interface - to allow future extension of this class without breaking binary compatibility

Since: S60 5.0

Parameters

TUid aInterfaceUid	Identifier of the interface to be retrieved
TAny *& aInterface	A reference to a pointer that retrieves the specified interface.

SetPropertyL(const TSensrvChannelId, const TSensrvProperty &)

void	SetPropertyL	(	const TSensrvChannelId	aChannelId,
			const TSensrvProperty &	aProperty
		)	[pure virtual]

Set property for the channel. SSY is responsible for checking that the property setting is legal.

Since: S60 5.0

leave: KErrNotFound If the property is not found.

leave: KErrArgument If the property value is invalid.

leave: KErrPermissionDenied If client capabilities are not enough to set the property.

Parameters

const TSensrvChannelId aChannelId	Channel Id to be linked to this set property operation
const TSensrvProperty & aProperty	Rereference to a property object to be set. iSecurityInfo of the property contains client capabilities.