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

#include <fusion_provider.h>

+ Inheritance diagram for com::ubuntu::location::FusionProvider:
+ Collaboration diagram for com::ubuntu::location::FusionProvider:

Public Types

typedef std::shared_ptr< FusionProviderPtr
 
- Public Types inherited from com::ubuntu::location::Provider
enum  Features : std::size_t {
  Features::none = 0,
  Features::position = 1 << 0,
  Features::velocity = 1 << 1,
  Features::heading = 1 << 2
}
 Enumerates the known features that can be supported by providers. More...
 
enum  Requirements : std::size_t {
  Requirements::none = 0,
  Requirements::satellites = 1 << 0,
  Requirements::cell_network = 1 << 1,
  Requirements::data_network = 1 << 2,
  Requirements::monetary_spending = 1 << 3
}
 Enumerates the requirements of a provider implementation. More...
 
typedef std::shared_ptr< ProviderPtr
 

Public Member Functions

 FusionProvider (const std::set< Provider::Ptr > &providers, const UpdateSelector::Ptr &update_selector)
 
bool matches_criteria (const Criteria &criteria) override
 Checks if a provider satisfies a set of accuracy criteria. More...
 
void on_wifi_and_cell_reporting_state_changed (location::WifiAndCellIdReportingState state) override
 Called by the engine whenever the wifi and cell ID reporting state changes. More...
 
void on_reference_location_updated (const Update< Position > &position) override
 Called by the engine whenever the reference location changed. More...
 
void on_reference_velocity_updated (const Update< Velocity > &velocity) override
 Called by the engine whenever the reference velocity changed. More...
 
void on_reference_heading_updated (const Update< Heading > &heading) override
 Called by the engine whenever the reference heading changed. More...
 
void start_position_updates () override
 Implementation-specific, empty by default. More...
 
void stop_position_updates () override
 Implementation-specific, empty by default. More...
 
void start_heading_updates () override
 Implementation-specific, empty by default. More...
 
void stop_heading_updates () override
 Implementation-specific, empty by default. More...
 
void start_velocity_updates () override
 Implementation-specific, empty by default. More...
 
void stop_velocity_updates () override
 Implementation-specific, empty by default. More...
 
- Public Member Functions inherited from com::ubuntu::location::Provider
virtual ~Provider ()=default
 
 Provider (const Provider &)=delete
 
Provideroperator= (const Provider &)=delete
 
virtual const Updatesupdates () const
 Provides non-mutable access to this provider's updates. More...
 
virtual const Controller::Ptrstate_controller () const
 Access to the controller facade of this provider instance. More...
 
virtual bool supports (const Features &f) const
 Checks if the provider supports a specific feature. More...
 
virtual bool requires (const Requirements &r) const
 Checks if the provider has got a specific requirement. More...
 

Additional Inherited Members

- Protected Member Functions inherited from com::ubuntu::location::Provider
 Provider (const Features &features=Features::none, const Requirements &requirements=Requirements::none)
 
virtual Updatesmutable_updates ()
 

Detailed Description

Definition at line 31 of file fusion_provider.h.

Member Typedef Documentation

Definition at line 34 of file fusion_provider.h.

Constructor & Destructor Documentation

com::ubuntu::location::FusionProvider::FusionProvider ( const std::set< Provider::Ptr > &  providers,
const UpdateSelector::Ptr update_selector 
)

Member Function Documentation

bool com::ubuntu::location::FusionProvider::matches_criteria ( const Criteria criteria)
overridevirtual

Checks if a provider satisfies a set of accuracy criteria.

Parameters
[in]criteriaThe criteria to check.
Returns
true iff the provider satisfies the given criteria.

Reimplemented from com::ubuntu::location::Provider.

void com::ubuntu::location::FusionProvider::on_reference_heading_updated ( const Update< Heading > &  heading)
overridevirtual

Called by the engine whenever the reference heading changed.

Parameters
headingThe new reference heading.

Reimplemented from com::ubuntu::location::Provider.

void com::ubuntu::location::FusionProvider::on_reference_location_updated ( const Update< Position > &  position)
overridevirtual

Called by the engine whenever the reference location changed.

Parameters
positionThe new reference location.

Reimplemented from com::ubuntu::location::Provider.

void com::ubuntu::location::FusionProvider::on_reference_velocity_updated ( const Update< Velocity > &  velocity)
overridevirtual

Called by the engine whenever the reference velocity changed.

Parameters
velocityThe new reference velocity.

Reimplemented from com::ubuntu::location::Provider.

void com::ubuntu::location::FusionProvider::on_wifi_and_cell_reporting_state_changed ( location::WifiAndCellIdReportingState  state)
overridevirtual

Called by the engine whenever the wifi and cell ID reporting state changes.

Parameters
stateThe new state.

Reimplemented from com::ubuntu::location::Provider.

void com::ubuntu::location::FusionProvider::start_heading_updates ( )
overridevirtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.

void com::ubuntu::location::FusionProvider::start_position_updates ( )
overridevirtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.

void com::ubuntu::location::FusionProvider::start_velocity_updates ( )
overridevirtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.

void com::ubuntu::location::FusionProvider::stop_heading_updates ( )
overridevirtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.

void com::ubuntu::location::FusionProvider::stop_position_updates ( )
overridevirtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.

void com::ubuntu::location::FusionProvider::stop_velocity_updates ( )
overridevirtual

Implementation-specific, empty by default.

Reimplemented from com::ubuntu::location::Provider.


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