The Provider class is the abstract base of all positioning providers.
More...
#include <provider.h>
|
class | Controller |
| Facade for controlling the state of position/heading/velocity updates. More...
|
|
struct | Updates |
| Wraps all updates that can be delivered by a provider. More...
|
|
The Provider class is the abstract base of all positioning providers.
Definition at line 45 of file provider.h.
Enumerates the known features that can be supported by providers.
Enumerator |
---|
none |
The provider does not support any feature.
|
position |
The provider features position updates.
|
velocity |
The provider features velocity updates.
|
heading |
The provider features heading updates.
|
Definition at line 53 of file provider.h.
Enumerates the requirements of a provider implementation.
Enumerator |
---|
none |
The provider does not require anything.
|
satellites |
The provider requires satellites to be visible.
|
cell_network |
The provider requires a cell-network to work correctly.
|
data_network |
The provider requires a data-network to work correctly.
|
monetary_spending |
Using the provider results in monetary cost.
|
Definition at line 64 of file provider.h.
virtual com::ubuntu::location::Provider::~Provider |
( |
| ) |
|
|
virtualdefault |
com::ubuntu::location::Provider::Provider |
( |
const Provider & |
| ) |
|
|
delete |
virtual bool com::ubuntu::location::Provider::matches_criteria |
( |
const Criteria & |
criteria | ) |
|
|
virtual |
Checks if a provider satisfies a set of accuracy criteria.
- Parameters
-
[in] | criteria | The criteria to check. |
- Returns
- true iff the provider satisfies the given criteria.
virtual Updates& com::ubuntu::location::Provider::mutable_updates |
( |
| ) |
|
|
protectedvirtual |
virtual void com::ubuntu::location::Provider::on_reference_heading_updated |
( |
const Update< Heading > & |
heading | ) |
|
|
virtual |
Called by the engine whenever the reference heading changed.
- Parameters
-
heading | The new reference heading. |
virtual void com::ubuntu::location::Provider::on_reference_location_updated |
( |
const Update< Position > & |
position | ) |
|
|
virtual |
Called by the engine whenever the reference location changed.
- Parameters
-
position | The new reference location. |
virtual void com::ubuntu::location::Provider::on_reference_velocity_updated |
( |
const Update< Velocity > & |
velocity | ) |
|
|
virtual |
Called by the engine whenever the reference velocity changed.
- Parameters
-
velocity | The new reference velocity. |
Called by the engine whenever the wifi and cell ID reporting state changes.
- Parameters
-
virtual bool com::ubuntu::location::Provider::requires |
( |
const Requirements & |
r | ) |
const |
|
virtual |
Checks if the provider has got a specific requirement.
- Parameters
-
r | Requirement to test for. |
- Returns
- true iff the provider has the specific requirement.
virtual void com::ubuntu::location::Provider::start_heading_updates |
( |
| ) |
|
|
protectedvirtual |
virtual void com::ubuntu::location::Provider::start_position_updates |
( |
| ) |
|
|
protectedvirtual |
virtual void com::ubuntu::location::Provider::start_velocity_updates |
( |
| ) |
|
|
protectedvirtual |
virtual const Controller::Ptr& com::ubuntu::location::Provider::state_controller |
( |
| ) |
const |
|
virtual |
Access to the controller facade of this provider instance.
virtual void com::ubuntu::location::Provider::stop_heading_updates |
( |
| ) |
|
|
protectedvirtual |
virtual void com::ubuntu::location::Provider::stop_position_updates |
( |
| ) |
|
|
protectedvirtual |
virtual void com::ubuntu::location::Provider::stop_velocity_updates |
( |
| ) |
|
|
protectedvirtual |
virtual bool com::ubuntu::location::Provider::supports |
( |
const Features & |
f | ) |
const |
|
virtual |
Checks if the provider supports a specific feature.
- Parameters
-
- Returns
- true iff the provider supports the feature.
virtual const Updates& com::ubuntu::location::Provider::updates |
( |
| ) |
const |
|
virtual |
Provides non-mutable access to this provider's updates.
- Returns
- A non-mutable reference to the updates.
Updates com::ubuntu::location::Provider::updates |
The documentation for this class was generated from the following file:
- /build/location-service-Nrz4S5/location-service-2.1+15.10.20150706/include/location_service/com/ubuntu/location/provider.h