ubuntu-location-service
..
An aggregating location service providing positioning and geocoding capabilities to applications.
|
The Engine class encapsulates a positioning engine, relying on a set of providers and reporters to acquire and publish location information. More...
#include <engine.h>
Classes | |
struct | Configuration |
The Configuration struct summarizes the state of the engine. More... | |
struct | Updates |
Summarizes all updates delivered via the engine. More... | |
Public Types | |
enum | Status { Status::off, Status::on, Status::active } |
The State enum models the current state of the engine. More... | |
typedef std::shared_ptr< Engine > | Ptr |
Public Member Functions | |
Engine (const std::shared_ptr< ProviderSelectionPolicy > &provider_selection_policy) | |
Engine (const Engine &)=delete | |
Engine & | operator= (const Engine &)=delete |
virtual | ~Engine () |
virtual ProviderSelection | determine_provider_selection_for_criteria (const Criteria &criteria) |
Calculates a set of providers that satisfies the given criteria. More... | |
virtual bool | has_provider (const Provider::Ptr &provider) noexcept |
Checks if the engine knows about a specific provider. More... | |
virtual void | add_provider (const Provider::Ptr &provider) |
Makes a provider known to the engine. More... | |
virtual void | remove_provider (const Provider::Ptr &provider) noexcept |
Removes a provider from the engine. More... | |
virtual void | for_each_provider (const std::function< void(const Provider::Ptr &)> &enumerator) const noexcept |
Iterates all known providers and invokes the provided enumerator for each of them. More... | |
![]() | |
ProviderEnumerator (const ProviderEnumerator &)=delete | |
virtual | ~ProviderEnumerator ()=default |
ProviderEnumerator & | operator= (const ProviderEnumerator &)=delete |
bool | operator== (const ProviderEnumerator &) const =delete |
virtual void | for_each_provider (const std::function< void(const std::shared_ptr< Provider > &)> &) const =0 |
Public Attributes | |
Configuration | configuration |
The engine's configuration. More... | |
Updates | updates |
All updates distributed via the engine. More... | |
Additional Inherited Members | |
![]() | |
ProviderEnumerator ()=default | |
The Engine class encapsulates a positioning engine, relying on a set of providers and reporters to acquire and publish location information.
typedef std::shared_ptr<Engine> com::ubuntu::location::Engine::Ptr |
|
strong |
com::ubuntu::location::Engine::Engine | ( | const std::shared_ptr< ProviderSelectionPolicy > & | provider_selection_policy | ) |
|
delete |
|
virtual |
|
virtual |
Makes a provider known to the engine.
provider | The new provider. |
|
virtual |
Calculates a set of providers that satisfies the given criteria.
[in] | criteria | The criteria to be satisfied by the returned provider selection. |
|
virtualnoexcept |
Iterates all known providers and invokes the provided enumerator for each of them.
enumerator | The functor to be invoked for each provider. |
|
virtualnoexcept |
Checks if the engine knows about a specific provider.
|
virtualnoexcept |
Removes a provider from the engine.
provider | The provider to be removed. |
Configuration com::ubuntu::location::Engine::configuration |
Updates com::ubuntu::location::Engine::updates |