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_SKYHOOK_PROVIDER_H_
19 #define LOCATION_SERVICE_COM_UBUNTU_LOCATION_PROVIDERS_SKYHOOK_PROVIDER_H_
20 
23 
24 #include <memory>
25 
26 namespace com
27 {
28 namespace ubuntu
29 {
30 namespace location
31 {
32 namespace providers
33 {
34 namespace skyhook
35 {
37 {
38  public:
40 
41  static const Provider::FeatureFlags& default_feature_flags();
42  static const Provider::RequirementFlags& default_requirement_flags();
43 
45  {
46  static std::string key_username() { return "username"; }
47  static std::string key_realm() { return "realm"; }
48  static std::string key_period() { return "period"; }
49 
50  std::string user_name;
51  std::string realm;
52  std::chrono::milliseconds period;
53  };
54 
55  Provider(const Configuration& config);
56  Provider(const Provider&) = delete;
57  Provider& operator=(const Provider&) = delete;
58  ~Provider() noexcept;
59 
60  virtual bool matches_criteria(const Criteria&);
61 
62  virtual void start_position_updates();
63  virtual void stop_position_updates();
64 
65  virtual void start_velocity_updates();
66  virtual void stop_velocity_updates();
67 
68  virtual void start_heading_updates();
69  virtual void stop_heading_updates();
70 
71  private:
72  struct Private;
73  std::unique_ptr<Private> d;
74 };
75 }
76 }
77 }
78 }
79 }
80 #endif // LOCATION_SERVICE_COM_UBUNTU_LOCATION_PROVIDERS_SKYHOOK_PROVIDER_H_
virtual void stop_position_updates()
Implementation-specific, empty by default.
static const Provider::FeatureFlags & default_feature_flags()
virtual void start_velocity_updates()
Implementation-specific, empty by default.
virtual void stop_heading_updates()
Implementation-specific, empty by default.
virtual void start_position_updates()
Implementation-specific, empty by default.
STL namespace.
Definition: accuracy.h:23
The Provider class is the abstract base of all positioning providers.
Definition: provider.h:45
static Provider::Ptr create_instance(const ProviderFactory::Configuration &config)
static const Provider::RequirementFlags & default_requirement_flags()
std::shared_ptr< Provider > Ptr
Definition: provider.h:48
virtual bool matches_criteria(const Criteria &)
Checks if a provider satisfies a set of accuracy criteria.
Provider & operator=(const Provider &)=delete
com::ubuntu::location::Configuration Configuration
virtual void start_heading_updates()
Implementation-specific, empty by default.
Summarizes criteria of a client session with respect to functionality and accuracy for position...
Definition: criteria.h:34
virtual void stop_velocity_updates()
Implementation-specific, empty by default.