Central Position Provider. More...

#include <PositionProvider.h>

Public Member Functions
	PositionProvider (QObject *parent=nullptr)
	Standard constructor.
	~PositionProvider () override=default
	Standard destructor.
QGeoCoordinate	approximateLastValidCoordinate () const
	Getter function for the property with the same name.
QBindable< QGeoCoordinate >	bindableApproximateLastValidCoordinate () const
	Getter function for the property with the same name.
QBindable< QGeoCoordinate >	bindableLastValidCoordinate ()
	Getter function for the property with the same name.
QBindable< Units::Angle >	bindableLastValidTT ()
	Getter function for the property with the same name.
Positioning::PositionInfo	positionInfo () const
	Getter method for property with the same name.
QBindable< Positioning::PositionInfo >	bindablePositionInfo () const
	Getter method for property with the same name.
bool	receivingPositionInfo () const
	Getter method for property with the same name.
QBindable< bool >	bindableReceivingPositionInfo ()
	Getter method for property with the same name.
QString	statusString () const
	Getter method for property with the same name.
QBindable< QString >	bindableStatusString () const
	Getter method for property with the same name.
Q_INVOKABLE void	startUpdates ()
	startUpdates

Static Public Member Functions
static QGeoCoordinate	lastValidCoordinate ()
	Getter function for the property with the same name.
static Units::Angle	lastValidTT ()
	Getter function for the property with the same name.

Properties
QGeoCoordinate	approximateLastValidCoordinate
	Approximate last valid coordinate.
QGeoCoordinate	lastValidCoordinate
	Last valid coordinate reading.
Units::Angle	lastValidTT
	Last valid true track.
Positioning::PositionInfo	positionInfo
	Position information.
bool	receivingPositionInfo
	Indicator that position information is being received.
QString	statusString
	Source status.

Detailed Description

Central Position Provider.

This class collects position data from the various sources (satellite, network, traffic receiver, …) chooses the best available source and exposes the data to QML and other parts of the program.

There exists one static instance of this class, which can be accessed via the method globalInstance(). No other instance of this class should be used.

Data from the standard operating system data source (typically: satnav or wifi) is only provided after startUpdates() has been called.

The methods in this class are reentrant, but not thread safe.

Definition at line 48 of file PositionProvider.h.

Constructor & Destructor Documentation

◆ PositionProvider()

Positioning::PositionProvider::PositionProvider ( QObject * parent = nullptr )

explicit

Standard constructor.

Parameters

parent The standard QObject parent pointer

Member Function Documentation

◆ approximateLastValidCoordinate()

QGeoCoordinate Positioning::PositionProvider::approximateLastValidCoordinate ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property approximateLastValidCoordinate

Definition at line 138 of file PositionProvider.h.

◆ bindableApproximateLastValidCoordinate()

QBindable< QGeoCoordinate > Positioning::PositionProvider::bindableApproximateLastValidCoordinate ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property approximateLastValidCoordinate

Definition at line 144 of file PositionProvider.h.

◆ bindableLastValidCoordinate()

QBindable< QGeoCoordinate > Positioning::PositionProvider::bindableLastValidCoordinate ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property lastValidCoordinate

Definition at line 156 of file PositionProvider.h.

◆ bindableLastValidTT()

QBindable< Units::Angle > Positioning::PositionProvider::bindableLastValidTT ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property lastValidTrack

Definition at line 168 of file PositionProvider.h.

◆ bindablePositionInfo()

QBindable< Positioning::PositionInfo > Positioning::PositionProvider::bindablePositionInfo ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property positionInfo

Definition at line 180 of file PositionProvider.h.

◆ bindableReceivingPositionInfo()

QBindable< bool > Positioning::PositionProvider::bindableReceivingPositionInfo ( )

inlinenodiscard

Getter method for property with the same name.

Returns: Property receivingPositionInfo

Definition at line 192 of file PositionProvider.h.

◆ bindableStatusString()

QBindable< QString > Positioning::PositionProvider::bindableStatusString ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property statusString

Definition at line 207 of file PositionProvider.h.

◆ lastValidCoordinate()

QGeoCoordinate Positioning::PositionProvider::lastValidCoordinate ( )

staticnodiscard

Getter function for the property with the same name.

Returns: Property lastValidCoordinate

◆ lastValidTT()

Units::Angle Positioning::PositionProvider::lastValidTT ( )

staticnodiscard

Getter function for the property with the same name.

Returns: Property lastValidTrack

◆ positionInfo()

Positioning::PositionInfo Positioning::PositionProvider::positionInfo ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property positionInfo

Definition at line 174 of file PositionProvider.h.

◆ receivingPositionInfo()

bool Positioning::PositionProvider::receivingPositionInfo ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property receivingPositionInfo

Definition at line 186 of file PositionProvider.h.

◆ startUpdates()

Q_INVOKABLE void Positioning::PositionProvider::startUpdates ( )

inline

startUpdates

Requests permissions if necessary and starts to provide data from the standard operating system data source (typically SatNav or WiFi) if permissions were granted.

Definition at line 224 of file PositionProvider.h.

◆ statusString()

QString Positioning::PositionProvider::statusString ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property statusString

Definition at line 198 of file PositionProvider.h.

Property Documentation

◆ approximateLastValidCoordinate

QGeoCoordinate Positioning::PositionProvider::approximateLastValidCoordinate

read

Approximate last valid coordinate.

This property equals lastValidCoordinate, except that it is updated only every ten kilometers.

Definition at line 85 of file PositionProvider.h.

◆ lastValidCoordinate

QGeoCoordinate Positioning::PositionProvider::lastValidCoordinate

read

Last valid coordinate reading.

This property holds the last valid coordinate known. At the first start, this property is set to the location Freiburg Airport, EDTF. The value is stored in a QSetting at destruction, and restored in the construction.

Definition at line 94 of file PositionProvider.h.

◆ lastValidTT

Units::Angle Positioning::PositionProvider::lastValidTT

read

Last valid true track.

This property holds the last valid true track known. At the first start, this property is set to 0°. The value is stored in a QSetting at destruction, and restored in the construction.

Definition at line 102 of file PositionProvider.h.

◆ positionInfo

Positioning::PositionInfo Positioning::PositionProvider::positionInfo

read

Position information.

This property holds information about the device position. To ensure that the data is up-to-date, the position information will be set to an invalid positionInfo when no data has arrived for more than the time specified in PositionInfo::lifetime.

Definition at line 111 of file PositionProvider.h.

◆ receivingPositionInfo

bool Positioning::PositionProvider::receivingPositionInfo

read

Indicator that position information is being received.

This is a shortcut for positionInfo().isValid. This property exists because it does not change so often, and can thus be more efficient to use.

Definition at line 119 of file PositionProvider.h.

◆ statusString

QString Positioning::PositionProvider::statusString

read

Source status.

This property holds a translated, human-readable string that describes the status of the positionInfo source. This could typically be a string of the form "OK" or "Insufficient permission to access position info"

Definition at line 127 of file PositionProvider.h.

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

/home/runner/work/enroute/enroute/src/positioning/PositionProvider.h

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PositionProvider()

Member Function Documentation

◆ approximateLastValidCoordinate()

◆ bindableApproximateLastValidCoordinate()

◆ bindableLastValidCoordinate()

◆ bindableLastValidTT()

◆ bindablePositionInfo()

◆ bindableReceivingPositionInfo()

◆ bindableStatusString()

◆ lastValidCoordinate()

◆ lastValidTT()

◆ positionInfo()

◆ receivingPositionInfo()

◆ startUpdates()

◆ statusString()

Property Documentation

◆ approximateLastValidCoordinate

◆ lastValidCoordinate

◆ lastValidTT

◆ positionInfo

◆ receivingPositionInfo

◆ statusString