Sensor feature control

Data Structures
class	telux::sensor::ISensorFeatureEventListener
	ISensorFeatureEventListener interface is used to receive notifications related to sensor feature events. More...
class	telux::sensor::ISensorFeatureManager
	Sensor Feature Manager class provides APIs to interact with the sensor framework to list the available features, enable them or disable them. The availability of sensor features depends on the capabilities of the underlying hardware. More...

Detailed Description

This section contains APIs related to contrlling the features the sensor sub-system offers.

---

Data Structure Documentation

class telux::sensor::ISensorFeatureEventListener

ISensorFeatureEventListener interface is used to receive notifications related to sensor feature events.

The listener method can be invoked from multiple different threads. Client needs to make sure that implementation is thread-safe.

Public Member Functions
virtual void	onEvent (SensorFeatureEvent event)
virtual	~ISensorFeatureEventListener ()

Constructor & Destructor Documentation

virtual telux::sensor::ISensorFeatureEventListener::~ISensorFeatureEventListener ( )

virtual

The destructor for the sensor feature event listener

Member Function Documentation

virtual void telux::sensor::ISensorFeatureEventListener::onEvent ( SensorFeatureEvent  event )

virtual

This function is called to notify about sensor feature events

Parameters

[in]

id

- The sensor feature event that got triggered

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

class telux::sensor::ISensorFeatureManager

Sensor Feature Manager class provides APIs to interact with the sensor framework to list the available features, enable them or disable them. The availability of sensor features depends on the capabilities of the underlying hardware.

Public Member Functions
virtual telux::common::ServiceStatus	getServiceStatus ()=0
virtual telux::common::Status	getAvailableFeatures (std::vector< SensorFeature > &features)=0
virtual telux::common::Status	enableFeature (std::string name)=0
virtual telux::common::Status	disableFeature (std::string name)=0
virtual telux::common::Status	registerListener (std::weak_ptr< ISensorFeatureEventListener > listener)=0
virtual telux::common::Status	deregisterListener (std::weak_ptr< ISensorFeatureEventListener > listener)=0
virtual	~ISensorFeatureManager ()

Constructor & Destructor Documentation

virtual telux::sensor::ISensorFeatureManager::~ISensorFeatureManager ( )

virtual

Destructor for ISensorFeatureManager

Member Function Documentation

virtual telux::common::ServiceStatus telux::sensor::ISensorFeatureManager::getServiceStatus ( )

pure virtual

Checks the status of sensor sub-system and returns the result.

Returns

the status of sensor sub-system status telux::common::ServiceStatus

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::sensor::ISensorFeatureManager::getAvailableFeatures ( std::vector< SensorFeature > &  features )

pure virtual

Request the sensor framework to provide the available features. The feature could be offered by the sensor framework or the underlying hardware.

Parameters

[out]

features

List of sensor features the sensor framework offers

Returns

status of the request telux::common::Status

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::sensor::ISensorFeatureManager::enableFeature ( std::string  name )

pure virtual

Enable the requested feature

Parameters

[in]

name

The name of the feature to be enabled.

Returns

status of the request telux::common::Status

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::sensor::ISensorFeatureManager::disableFeature ( std::string  name )

pure virtual

Disable the requested feature

Parameters

[in]

name

The name of the feature to be disabled.

Returns

status of the request telux::common::Status

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::sensor::ISensorFeatureManager::registerListener ( std::weak_ptr< ISensorFeatureEventListener >  listener )

pure virtual

Register a listener for sensor feature related events

Returns

status of registration request - telux::common::Status

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::sensor::ISensorFeatureManager::deregisterListener ( std::weak_ptr< ISensorFeatureEventListener >  listener )

pure virtual

Deregister a sensor feature event listener

Returns

status of deregistration request - telux::common::Status

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.