lomiri-location-service ..
An aggregating location service providing positioning and geocoding capabilities to applications.
|
Facade for controlling the state of position/heading/velocity updates. More...
#include <provider.h>
Public Types | |
typedef std::shared_ptr< Controller > | Ptr |
Public Member Functions | |
virtual | ~Controller ()=default |
Controller (const Controller &)=delete | |
Controller & | operator= (const Controller &)=delete |
void | disable () |
disable switches the provider to a disabled state, such that subsequent calls to start* methods fail. | |
void | enable () |
enable switches the provider to an enabled state, such that subsequent calls to start* methods succeed. | |
virtual void | start_position_updates () |
Request to start position updates if not already running. | |
virtual void | stop_position_updates () |
Request to stop position updates. Only stops the provider when the last observer calls this function. | |
bool | are_position_updates_running () const |
Checks if position updates are currently running. | |
virtual void | start_heading_updates () |
Request to start heading updates if not already running. | |
virtual void | stop_heading_updates () |
Request to stop heading updates. Only stops the provider when the last observer calls this function. | |
bool | are_heading_updates_running () const |
Checks if position updates are currently running. | |
virtual void | start_velocity_updates () |
Request to start velocity updates if not already running. | |
virtual void | stop_velocity_updates () |
Request to stop velocity updates. Only stops the provider when the last observer calls this function. | |
bool | are_velocity_updates_running () const |
Checks if velocity updates are currently running. | |
Protected Member Functions | |
Controller (Provider &instance) | |
Facade for controlling the state of position/heading/velocity updates.
Multiple observers can request state changes for updates. This class ensures that the specific updates are started and stopped if at least one observer requests them and stopped when the last observer issues a stop request.
Definition at line 80 of file provider.h.
typedef std::shared_ptr<Controller> com::lomiri::location::Provider::Controller::Ptr |
Definition at line 83 of file provider.h.
|
virtualdefault |
|
delete |
|
explicitprotected |
bool com::lomiri::location::Provider::Controller::are_heading_updates_running | ( | ) | const |
Checks if position updates are currently running.
bool com::lomiri::location::Provider::Controller::are_position_updates_running | ( | ) | const |
Checks if position updates are currently running.
bool com::lomiri::location::Provider::Controller::are_velocity_updates_running | ( | ) | const |
Checks if velocity updates are currently running.
void com::lomiri::location::Provider::Controller::disable | ( | ) |
disable switches the provider to a disabled state, such that subsequent calls to start* methods fail.
void com::lomiri::location::Provider::Controller::enable | ( | ) |
enable switches the provider to an enabled state, such that subsequent calls to start* methods succeed.
|
delete |
|
virtual |
Request to start heading updates if not already running.
|
virtual |
Request to start position updates if not already running.
|
virtual |
Request to start velocity updates if not already running.
|
virtual |
Request to stop heading updates. Only stops the provider when the last observer calls this function.
|
virtual |
Request to stop position updates. Only stops the provider when the last observer calls this function.
|
virtual |
Request to stop velocity updates. Only stops the provider when the last observer calls this function.