ubuntu-location-service  ..
An aggregating location service providing positioning and geocoding capabilities to applications.
com::ubuntu::location Namespace Reference

Namespaces

 connectivity
 
 providers
 
 service
 
 units
 
 wgs84
 

Classes

struct  Accuracy
 
struct  AccuracyTraits
 
struct  Clock
 Defines the timebase of the location service. More...
 
struct  Criteria
 Summarizes criteria of a client session with respect to functionality and accuracy for position, velocity and heading measurements. More...
 
class  DefaultProviderSelectionPolicy
 
class  Engine
 The Engine class encapsulates a positioning engine, relying on a set of providers and reporters to acquire and publish location information. More...
 
struct  Position
 The Position struct models a position in the wgs84 coordinate system. More...
 
class  Provider
 The Provider class is the abstract base of all positioning providers. More...
 
class  ProviderEnumerator
 
class  ProviderFactory
 
struct  ProviderSelection
 
class  ProviderSelectionPolicy
 
class  ProxyProvider
 
struct  SpaceVehicle
 A space-vehicle as visible to providers. More...
 
struct  Update
 Templated class that wraps a value and timestamp. More...
 

Typedefs

typedef boost::property_tree::ptree Configuration
 
typedef units::Quantity
< units::PlaneAngle
Heading
 
template<typename T >
using Optional = boost::optional< T >
 
typedef units::Quantity
< units::Velocity
Velocity
 Velocity is measured in m/s. More...
 

Enumerations

enum  AccuracyLevel {
  AccuracyLevel::country,
  AccuracyLevel::region,
  AccuracyLevel::locality,
  AccuracyLevel::postalcode,
  AccuracyLevel::street,
  AccuracyLevel::detailed,
  AccuracyLevel::best = detailed,
  AccuracyLevel::worst = country
}
 
enum  SatelliteBasedPositioningState {
  SatelliteBasedPositioningState::on,
  SatelliteBasedPositioningState::off
}
 The SatelliteBasedPositioningState enum describes whether satellite assisted positioning is enabled or disabled. More...
 
enum  WifiAndCellIdReportingState {
  WifiAndCellIdReportingState::on,
  WifiAndCellIdReportingState::off
}
 

Functions

template<typename T >
std::ostream & operator<< (std::ostream &out, const Accuracy< T > &update)
 
Criteria operator+ (const Criteria &lhs, const Criteria &rhs)
 operator + merges lhs and rhs such that satisfying the new criteria satisfies lhs and rhs. More...
 
void init (int *argc, char ***argv)
 Initializes the library. More...
 
void shutdown ()
 Shuts down the library and frees all acquired resources. More...
 
std::ostream & operator<< (std::ostream &out, const Position &position)
 
units::Quantity< units::Lengthhaversine_distance (const Position &p1, const Position &p2)
 
Provider::Features operator| (Provider::Features lhs, Provider::Features rhs)
 
Provider::Features operator& (Provider::Features lhs, Provider::Features rhs)
 
Provider::Requirements operator| (Provider::Requirements lhs, Provider::Requirements rhs)
 
Provider::Requirements operator& (Provider::Requirements lhs, Provider::Requirements rhs)
 
bool operator== (const ProviderSelection &lhs, const ProviderSelection &rhs)
 
std::ostream & operator<< (std::ostream &out, const SpaceVehicle &sv)
 
template<typename T >
std::ostream & operator<< (std::ostream &out, const Update< T > &update)
 Pretty-prints the update to the provided output stream. More...
 

Typedef Documentation

typedef boost::property_tree::ptree com::ubuntu::location::Configuration

Definition at line 29 of file configuration.h.

Heading is measured in ° deviation from true north.

Definition at line 30 of file heading.h.

template<typename T >
using com::ubuntu::location::Optional = typedef boost::optional<T>

Definition at line 30 of file optional.h.

Velocity is measured in m/s.

Definition at line 30 of file velocity.h.

Enumeration Type Documentation

Enumerator
country 
region 
locality 
postalcode 
street 
detailed 
best 
worst 

Definition at line 29 of file accuracy.h.

The SatelliteBasedPositioningState enum describes whether satellite assisted positioning is enabled or disabled.

Enumerator
on 

Satellite assisted positioning is on.

off 

Satellite assisted positioning is off.

Definition at line 31 of file satellite_based_positioning_state.h.

Enumerator
on 

Wifi and Cell Ids might be reported to online location services.

off 

Wifi and Cell Ids are not reported. This is the default value.

Definition at line 27 of file wifi_and_cell_reporting_state.h.

Function Documentation

units::Quantity<units::Length> com::ubuntu::location::haversine_distance ( const Position &  p1,
const Position &  p2 
)
void com::ubuntu::location::init ( int *  argc,
char ***  argv 
)

Initializes the library.

Provider::Features com::ubuntu::location::operator& ( Provider::Features  lhs,
Provider::Features  rhs 
)
Provider::Requirements com::ubuntu::location::operator& ( Provider::Requirements  lhs,
Provider::Requirements  rhs 
)
Criteria com::ubuntu::location::operator+ ( const Criteria &  lhs,
const Criteria &  rhs 
)

operator + merges lhs and rhs such that satisfying the new criteria satisfies lhs and rhs.

std::ostream& com::ubuntu::location::operator<< ( std::ostream &  out,
const Position &  position 
)
template<typename T >
std::ostream& com::ubuntu::location::operator<< ( std::ostream &  out,
const Accuracy< T > &  update 
)
inline

Definition at line 68 of file accuracy.h.

template<typename T >
std::ostream& com::ubuntu::location::operator<< ( std::ostream &  out,
const Update< T > &  update 
)
inline

Pretty-prints the update to the provided output stream.

Parameters
outThe stream to write to.
updateThe value to be printed.

Definition at line 82 of file update.h.

bool com::ubuntu::location::operator== ( const ProviderSelection &  lhs,
const ProviderSelection &  rhs 
)
inline
Provider::Features com::ubuntu::location::operator| ( Provider::Features  lhs,
Provider::Features  rhs 
)
Provider::Requirements com::ubuntu::location::operator| ( Provider::Requirements  lhs,
Provider::Requirements  rhs 
)
void com::ubuntu::location::shutdown ( )

Shuts down the library and frees all acquired resources.