Telematics SDK - Interface Specification
v1.46.14
|
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... | |
This section contains APIs related to contrlling the features the sensor sub-system offers.
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 () |
|
virtual |
The destructor for the sensor feature event listener
|
virtual |
This function is called to notify about sensor feature events
[in] | id | - The sensor feature event that got triggered |
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 () |
|
virtual |
Destructor for ISensorFeatureManager
|
pure virtual |
Checks the status of sensor sub-system and returns the result.
|
pure virtual |
Request the sensor framework to provide the available features. The feature could be offered by the sensor framework or the underlying hardware.
[out] | features | List of sensor features the sensor framework offers |
|
pure virtual |
Enable the requested feature
[in] | name | The name of the feature to be enabled. Enabling an already enabled feature would result in the API returning telux::common::Status::SUCCESS. |
|
pure virtual |
Disable the requested feature
[in] | name | The name of the feature to be disabled. Disabling an already disabled feature would result in the API returning telux::common::Status::SUCCESS. |
|
pure virtual |
Register a listener for sensor feature related events
|
pure virtual |
Deregister a sensor feature event listener