The Interface class models the primary interface to the location service.
More...
#include <interface.h>
|
static const std::string & | path () |
| Queries the path that this object is known under. More...
|
|
The Interface class models the primary interface to the location service.
Definition at line 47 of file interface.h.
◆ Ptr
◆ Interface() [1/2]
com::lomiri::location::service::Interface::Interface |
( |
| ) |
|
|
protecteddefault |
◆ Interface() [2/2]
com::lomiri::location::service::Interface::Interface |
( |
const Interface & |
| ) |
|
|
delete |
◆ ~Interface()
virtual com::lomiri::location::service::Interface::~Interface |
( |
| ) |
|
|
virtualdefault |
◆ create_session_for_criteria()
Starts a new session for the given criteria.
- Exceptions
-
std::runtime_error | in case of errors. |
- Parameters
-
criteria | The client's requirements in terms of accuraccy and functionality |
- Returns
- A session instance.
◆ does_report_cell_and_wifi_ids()
virtual core::Property<bool>& com::lomiri::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.
◆ does_satellite_based_positioning()
virtual core::Property<bool>& com::lomiri::location::service::Interface::does_satellite_based_positioning |
( |
| ) |
|
|
pure virtual |
Whether the service uses satellite-based positioning.
- Returns
- A setable/getable/observable property.
◆ is_online()
virtual core::Property<bool>& com::lomiri::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.
◆ operator=()
◆ path()
static const std::string& com::lomiri::location::service::Interface::path |
( |
| ) |
|
|
inlinestatic |
Queries the path that this object is known under.
Definition at line 186 of file interface.h.
◆ state()
virtual const core::Property<State>& com::lomiri::location::service::Interface::state |
( |
| ) |
const |
|
pure virtual |
The overall state of the service.
- Returns
- a getable/observable property.
◆ visible_space_vehicles()
All space vehicles currently visible.
The documentation for this class was generated from the following file:
- /build/location-service-3.1.0~20230328163843.17~875cece+ubports20.04/include/location_service/com/lomiri/location/service/interface.h