ubuntu-location-service  ..
An aggregating location service providing positioning and geocoding capabilities to applications.
com::ubuntu::location::providers::geoclue::Provider Class Reference

#include <provider.h>

+ Inheritance diagram for com::ubuntu::location::providers::geoclue::Provider:
+ Collaboration diagram for com::ubuntu::location::providers::geoclue::Provider:

Classes

struct  Configuration
 

Public Member Functions

 Provider (const Configuration &config)
 
 ~Provider () noexcept
 
virtual bool matches_criteria (const Criteria &)
 Checks if a provider satisfies a set of accuracy criteria. More...
 
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_velocity_updates ()
 Implementation-specific, empty by default. More...
 
virtual void stop_velocity_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...
 
- Public Member Functions inherited from com::ubuntu::location::Provider
 Provider (const Provider &)=delete
 
Provideroperator= (const Provider &)=delete
 
virtual const Updatesupdates () const
 Provides non-mutable access to this provider's updates. More...
 
virtual const Controller::Ptrstate_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 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...
 

Static Public Member Functions

static Provider::Ptr create_instance (const ProviderFactory::Configuration &)
 

Additional Inherited Members

- Public Types inherited from com::ubuntu::location::Provider
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< ProviderPtr
 
- Protected Member Functions inherited from com::ubuntu::location::Provider
 Provider (const Features &features=Features::none, const Requirements &requirements=Requirements::none)
 
virtual Updatesmutable_updates ()
 

Detailed Description

Definition at line 34 of file provider.h.

Constructor & Destructor Documentation

com::ubuntu::location::providers::geoclue::Provider::Provider ( const Configuration config)
com::ubuntu::location::providers::geoclue::Provider::~Provider ( )
virtualnoexcept

Reimplemented from com::ubuntu::location::Provider.

Member Function Documentation

static Provider::Ptr com::ubuntu::location::providers::geoclue::Provider::create_instance ( const ProviderFactory::Configuration )
static
virtual bool com::ubuntu::location::providers::geoclue::Provider::matches_criteria ( const Criteria criteria)
virtual

Checks if a provider satisfies a set of accuracy criteria.

Parameters
[in]criteriaThe criteria to check.
Returns
true iff the provider satisfies the given criteria.

Reimplemented from com::ubuntu::location::Provider.

virtual void com::ubuntu::location::providers::geoclue::Provider::start_heading_updates ( )
virtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.

virtual void com::ubuntu::location::providers::geoclue::Provider::start_position_updates ( )
virtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.

virtual void com::ubuntu::location::providers::geoclue::Provider::start_velocity_updates ( )
virtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.

virtual void com::ubuntu::location::providers::geoclue::Provider::stop_heading_updates ( )
virtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.

virtual void com::ubuntu::location::providers::geoclue::Provider::stop_position_updates ( )
virtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.

virtual void com::ubuntu::location::providers::geoclue::Provider::stop_velocity_updates ( )
virtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.


The documentation for this class was generated from the following file: