ubuntu-location-service  ..
An aggregating location service providing positioning and geocoding capabilities to applications.
com::ubuntu::location::service::Interface Class Referenceabstract

The Interface class models the primary interface to the location service. More...

#include <interface.h>

+ Collaboration diagram for com::ubuntu::location::service::Interface:

Classes

struct  CreateSessionForCriteria
 
struct  Errors
 
struct  Properties
 

Public Types

typedef std::shared_ptr< InterfacePtr
 

Public Member Functions

 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
virtual ~Interface ()=default
 
virtual const core::Property< State > & state () const =0
 The overall state of the service. More...
 
virtual core::Property< bool > & does_satellite_based_positioning ()=0
 Whether the service uses satellite-based positioning. More...
 
virtual core::Property< bool > & is_online ()=0
 Whether the overall service and its positioning engine is online or not. More...
 
virtual core::Property< bool > & does_report_cell_and_wifi_ids ()=0
 Whether the engine and its providers/reporters do call home to report reference locations together with wifi and cell ids. More...
 
virtual core::Property< std::map< SpaceVehicle::Key, SpaceVehicle > > & visible_space_vehicles ()=0
 All space vehicles currently visible. More...
 
virtual session::Interface::Ptr create_session_for_criteria (const Criteria &criteria)=0
 Starts a new session for the given criteria. More...
 

Static Public Member Functions

static const std::string & path ()
 Queries the path that this object is known under. More...
 

Protected Member Functions

 Interface ()=default
 

Detailed Description

The Interface class models the primary interface to the location service.

Definition at line 47 of file interface.h.

Member Typedef Documentation

Definition at line 181 of file interface.h.

Constructor & Destructor Documentation

com::ubuntu::location::service::Interface::Interface ( )
protecteddefault

Referenced by path().

com::ubuntu::location::service::Interface::Interface ( const Interface )
delete
virtual com::ubuntu::location::service::Interface::~Interface ( )
virtualdefault

Referenced by path().

Member Function Documentation

virtual session::Interface::Ptr com::ubuntu::location::service::Interface::create_session_for_criteria ( const Criteria criteria)
pure virtual

Starts a new session for the given criteria.

Exceptions
std::runtime_errorin case of errors.
Parameters
criteriaThe client's requirements in terms of accuraccy and functionality
Returns
A session instance.

Referenced by path().

virtual core::Property<bool>& com::ubuntu::location::service::Interface::does_report_cell_and_wifi_ids ( )
pure virtual

Whether the engine and its providers/reporters do call home to report reference locations together with wifi and cell ids.

We consider this feature privacy sensitive and it defaults to false. The user has to explicitly opt-in into this feature.

Returns
A setable/getable/observable property.

Referenced by path().

virtual core::Property<bool>& com::ubuntu::location::service::Interface::does_satellite_based_positioning ( )
pure virtual

Whether the service uses satellite-based positioning.

Returns
A setable/getable/observable property.

Referenced by path().

virtual core::Property<bool>& com::ubuntu::location::service::Interface::is_online ( )
pure virtual

Whether the overall service and its positioning engine is online or not.

Returns
A setable/getable/observable property.

Referenced by path().

Interface& com::ubuntu::location::service::Interface::operator= ( const Interface )
delete

Referenced by path().

static const std::string& com::ubuntu::location::service::Interface::path ( )
inlinestatic

Queries the path that this object is known under.

Definition at line 186 of file interface.h.

References create_session_for_criteria(), does_report_cell_and_wifi_ids(), does_satellite_based_positioning(), Interface(), is_online(), operator=(), state(), visible_space_vehicles(), and ~Interface().

+ Here is the call graph for this function:

virtual const core::Property<State>& com::ubuntu::location::service::Interface::state ( ) const
pure virtual

The overall state of the service.

Returns
a getable/observable property.

Referenced by path().

virtual core::Property<std::map<SpaceVehicle::Key, SpaceVehicle> >& com::ubuntu::location::service::Interface::visible_space_vehicles ( )
pure virtual

All space vehicles currently visible.

Referenced by path().


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