ubuntu-location-service
..
An aggregating location service providing positioning and geocoding capabilities to applications.
|
The Provider class is the abstract base of all positioning providers. More...
#include <provider.h>
Classes | |
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... | |
Public Types | |
enum | Features : std::size_t { Features::none = 0, Features::position = 1 << 0, Features::velocity = 1 << 1, Features::heading = 1 << 2 } |
Enumerates the known features that can be supported by providers. More... | |
enum | Requirements : std::size_t { Requirements::none = 0, Requirements::satellites = 1 << 0, Requirements::cell_network = 1 << 1, Requirements::data_network = 1 << 2, Requirements::monetary_spending = 1 << 3 } |
Enumerates the requirements of a provider implementation. More... | |
typedef std::shared_ptr< Provider > | Ptr |
Public Member Functions | |
virtual | ~Provider ()=default |
Provider (const Provider &)=delete | |
Provider & | operator= (const Provider &)=delete |
virtual const Updates & | updates () const |
Provides non-mutable access to this provider's updates. More... | |
virtual const Controller::Ptr & | state_controller () const |
Access to the controller facade of this provider instance. More... | |
virtual bool | supports (const Features &f) const |
Checks if the provider supports a specific feature. More... | |
virtual bool | requires (const Requirements &r) const |
Checks if the provider has got a specific requirement. More... | |
virtual bool | matches_criteria (const Criteria &criteria) |
Checks if a provider satisfies a set of accuracy criteria. More... | |
virtual void | on_wifi_and_cell_reporting_state_changed (WifiAndCellIdReportingState state) |
Called by the engine whenever the wifi and cell ID reporting state changes. More... | |
virtual void | on_reference_location_updated (const Update< Position > &position) |
Called by the engine whenever the reference location changed. More... | |
virtual void | on_reference_velocity_updated (const Update< Velocity > &velocity) |
Called by the engine whenever the reference velocity changed. More... | |
virtual void | on_reference_heading_updated (const Update< Heading > &heading) |
Called by the engine whenever the reference heading changed. More... | |
Protected Member Functions | |
Provider (const Features &features=Features::none, const Requirements &requirements=Requirements::none) | |
virtual Updates & | mutable_updates () |
virtual void | start_position_updates () |
Implementation-specific, empty by default. More... | |
virtual void | stop_position_updates () |
Implementation-specific, empty by default. More... | |
virtual void | start_heading_updates () |
Implementation-specific, empty by default. More... | |
virtual void | stop_heading_updates () |
Implementation-specific, empty by default. More... | |
virtual void | start_velocity_updates () |
Implementation-specific, empty by default. More... | |
virtual void | stop_velocity_updates () |
Implementation-specific, empty by default. More... | |
The Provider class is the abstract base of all positioning providers.
Definition at line 45 of file provider.h.
typedef std::shared_ptr<Provider> com::ubuntu::location::Provider::Ptr |
Definition at line 48 of file provider.h.
|
strong |
Enumerates the known features that can be supported by providers.
Definition at line 53 of file provider.h.
|
strong |
Enumerates the requirements of a provider implementation.
Definition at line 64 of file provider.h.
|
virtualdefault |
|
delete |
|
explicitprotected |
|
virtual |
Checks if a provider satisfies a set of accuracy criteria.
[in] | criteria | The criteria to check. |
Reimplemented in com::ubuntu::location::providers::skyhook::Provider, and com::ubuntu::location::providers::geoclue::Provider.
|
protectedvirtual |
|
virtual |
Called by the engine whenever the reference heading changed.
heading | The new reference heading. |
|
virtual |
Called by the engine whenever the reference location changed.
position | The new reference location. |
|
virtual |
Called by the engine whenever the reference velocity changed.
velocity | The new reference velocity. |
|
virtual |
Called by the engine whenever the wifi and cell ID reporting state changes.
state | The new state. |
|
virtual |
Checks if the provider has got a specific requirement.
r | Requirement to test for. |
|
protectedvirtual |
Implementation-specific, empty by default.
Reimplemented in com::ubuntu::location::providers::skyhook::Provider, com::ubuntu::location::providers::geoclue::Provider, and com::ubuntu::location::ProxyProvider.
|
protectedvirtual |
Implementation-specific, empty by default.
Reimplemented in com::ubuntu::location::providers::skyhook::Provider, com::ubuntu::location::providers::geoclue::Provider, and com::ubuntu::location::ProxyProvider.
|
protectedvirtual |
Implementation-specific, empty by default.
Reimplemented in com::ubuntu::location::providers::skyhook::Provider, com::ubuntu::location::providers::geoclue::Provider, and com::ubuntu::location::ProxyProvider.
|
virtual |
Access to the controller facade of this provider instance.
|
protectedvirtual |
Implementation-specific, empty by default.
Reimplemented in com::ubuntu::location::providers::skyhook::Provider, com::ubuntu::location::providers::geoclue::Provider, and com::ubuntu::location::ProxyProvider.
|
protectedvirtual |
Implementation-specific, empty by default.
Reimplemented in com::ubuntu::location::providers::skyhook::Provider, com::ubuntu::location::providers::geoclue::Provider, and com::ubuntu::location::ProxyProvider.
|
protectedvirtual |
Implementation-specific, empty by default.
Reimplemented in com::ubuntu::location::providers::skyhook::Provider, com::ubuntu::location::providers::geoclue::Provider, and com::ubuntu::location::ProxyProvider.
|
virtual |
Checks if the provider supports a specific feature.
f | Feature to test for |
|
virtual |
Provides non-mutable access to this provider's updates.
Controller::Ptr com::ubuntu::location::Provider::controller = Controller::Ptr{} |
Definition at line 279 of file provider.h.
Features com::ubuntu::location::Provider::features = Features::none |
Definition at line 276 of file provider.h.
Requirements com::ubuntu::location::Provider::requirements = Requirements::none |
Definition at line 277 of file provider.h.
Updates com::ubuntu::location::Provider::updates |
Definition at line 278 of file provider.h.