ubuntu-location-service  ..
An aggregating location service providing positioning and geocoding capabilities to applications.
provider.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2012-2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU Lesser General Public License version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Thomas Voß <thomas.voss@canonical.com>
17  */
18 #ifndef LOCATION_SERVICE_COM_UBUNTU_LOCATION_PROVIDERS_GEOCLUE_PROVIDER_H_
19 #define LOCATION_SERVICE_COM_UBUNTU_LOCATION_PROVIDERS_GEOCLUE_PROVIDER_H_
20 
23 
24 namespace com
25 {
26 namespace ubuntu
27 {
28 namespace location
29 {
30 namespace providers
31 {
32 namespace geoclue
33 {
35 {
36  public:
38 
40  {
41  static std::string key_name() { return "name"; }
42  static std::string key_path() { return "path"; }
43  std::string name;
44  std::string path;
45 
48  };
49 
50  Provider(const Configuration& config);
51  ~Provider() noexcept;
52 
53  virtual bool matches_criteria(const Criteria&);
54 
55  virtual void start_position_updates();
56  virtual void stop_position_updates();
57 
58  virtual void start_velocity_updates();
59  virtual void stop_velocity_updates();
60 
61  virtual void start_heading_updates();
62  virtual void stop_heading_updates();
63 
64  private:
65  struct Private;
66  std::unique_ptr<Private> d;
67 };
68 }
69 }
70 }
71 }
72 }
73 #endif // LOCATION_SERVICE_COM_UBUNTU_LOCATION_PROVIDERS_GEOCLUE_PROVIDER_H_
The provider does not support any feature.
Requirements
Enumerates the requirements of a provider implementation.
Definition: provider.h:64
virtual void stop_position_updates()
Implementation-specific, empty by default.
virtual void start_velocity_updates()
Implementation-specific, empty by default.
Features
Enumerates the known features that can be supported by providers.
Definition: provider.h:53
STL namespace.
Definition: accuracy.h:23
virtual void stop_velocity_updates()
Implementation-specific, empty by default.
static Provider::Ptr create_instance(const ProviderFactory::Configuration &)
The Provider class is the abstract base of all positioning providers.
Definition: provider.h:45
std::shared_ptr< Provider > Ptr
Definition: provider.h:48
The provider does not require anything.
virtual void start_heading_updates()
Implementation-specific, empty by default.
com::ubuntu::location::Configuration Configuration
Summarizes criteria of a client session with respect to functionality and accuracy for position...
Definition: criteria.h:34
virtual bool matches_criteria(const Criteria &)
Checks if a provider satisfies a set of accuracy criteria.
virtual void stop_heading_updates()
Implementation-specific, empty by default.
virtual void start_position_updates()
Implementation-specific, empty by default.