QGIS API Documentation 3.41.0-Master (d5b93354e9c)
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Friends | List of all members
QgsGpsInformation Class Reference

Encapsulates information relating to a GPS position fix. More...

#include <qgsgpsinformation.h>

Public Member Functions

Qgis::GpsFixStatus bestFixStatus (Qgis::GnssConstellation &constellation) const
 Returns the best fix status and corresponding constellation.
 
QVariant componentValue (Qgis::GpsInformationComponent component) const
 Returns the value of the corresponding GPS information component.
 
QMap< Qgis::GnssConstellation, Qgis::GpsFixStatusconstellationFixStatus () const
 Returns a map of GNSS constellation to fix status.
 
Q_DECL_DEPRECATED Qgis::GpsFixStatus fixStatus () const
 Returns the fix status.
 
bool isValid () const
 Returns whether the connection information is valid.
 
Qgis::GpsNavigationStatus navigationStatus () const
 Returns the navigation status.
 
QString qualityDescription () const
 Returns a descriptive string for the signal quality.
 
void setNavigationStatus (Qgis::GpsNavigationStatus status)
 Sets the navigation status.
 

Public Attributes

double direction = std::numeric_limits< double >::quiet_NaN()
 The bearing measured in degrees clockwise from true north to the direction of travel.
 
double elevation = 0
 Altitude (in meters) above or below the mean sea level.
 
double elevation_diff = 0
 Geoidal separation (in meters).
 
QChar fixMode
 Fix mode (where M = Manual, forced to operate in 2D or 3D or A = Automatic, 3D/2D)
 
int fixType = 0
 Contains the fix type, where 1 = no fix, 2 = 2d fix, 3 = 3d fix.
 
double hacc = std::numeric_limits< double >::quiet_NaN()
 Horizontal accuracy in meters.
 
double hdop = 0
 Horizontal dilution of precision.
 
double hvacc = std::numeric_limits< double >::quiet_NaN()
 3D RMS
 
double latitude = 0
 Latitude in decimal degrees, using the WGS84 datum.
 
double longitude = 0
 Longitude in decimal degrees, using the WGS84 datum.
 
double pdop = 0
 Dilution of precision.
 
int quality = -1
 GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive, etc.)
 
Qgis::GpsQualityIndicator qualityIndicator = Qgis::GpsQualityIndicator::Unknown
 Returns the signal quality indicator.
 
QList< QgsSatelliteInfosatellitesInView
 Contains a list of information relating to the current satellites in view.
 
int satellitesUsed = 0
 Count of satellites used in obtaining the fix.
 
bool satInfoComplete = false
 true if satellite information is complete.
 
QList< int > satPrn
 IDs of satellites used in the position fix.
 
double speed = 0
 Ground speed, in km/h.
 
QChar status
 Status (A = active or V = void)
 
QDateTime utcDateTime
 The date and time at which this position was reported, in UTC time.
 
QTime utcTime
 The time at which this position was reported, in UTC time.
 
double vacc = std::numeric_limits< double >::quiet_NaN()
 Vertical accuracy in meters.
 
double vdop = 0
 Vertical dilution of precision.
 

Friends

class QgsNmeaConnection
 
class QgsQtLocationConnection
 

Detailed Description

Encapsulates information relating to a GPS position fix.

Definition at line 35 of file qgsgpsinformation.h.

Member Function Documentation

◆ bestFixStatus()

Qgis::GpsFixStatus QgsGpsInformation::bestFixStatus ( Qgis::GnssConstellation constellation) const

Returns the best fix status and corresponding constellation.

Parameters
constellationwill be set to the constellation with best fix status
Returns
best current fix status
Since
QGIS 3.30

Definition at line 24 of file qgsgpsinformation.cpp.

◆ componentValue()

QVariant QgsGpsInformation::componentValue ( Qgis::GpsInformationComponent  component) const

Returns the value of the corresponding GPS information component.

Since
QGIS 3.30

Definition at line 123 of file qgsgpsinformation.cpp.

◆ constellationFixStatus()

QMap< Qgis::GnssConstellation, Qgis::GpsFixStatus > QgsGpsInformation::constellationFixStatus ( ) const
inline

Returns a map of GNSS constellation to fix status.

Since
QGIS 3.30

Definition at line 160 of file qgsgpsinformation.h.

◆ fixStatus()

Qgis::GpsFixStatus QgsGpsInformation::fixStatus ( ) const

Returns the fix status.

Deprecated:
QGIS 3.40. Use constellationFixStatus() or bestFixStatus() instead.

Definition at line 66 of file qgsgpsinformation.cpp.

◆ isValid()

bool QgsGpsInformation::isValid ( ) const

Returns whether the connection information is valid.

Since
QGIS 3.10

Definition at line 42 of file qgsgpsinformation.cpp.

◆ navigationStatus()

Qgis::GpsNavigationStatus QgsGpsInformation::navigationStatus ( ) const
inline

Returns the navigation status.

See also
setNavigationStatus()
Since
QGIS 3.38

Definition at line 211 of file qgsgpsinformation.h.

◆ qualityDescription()

QString QgsGpsInformation::qualityDescription ( ) const

Returns a descriptive string for the signal quality.

Since
QGIS 3.16

Definition at line 86 of file qgsgpsinformation.cpp.

◆ setNavigationStatus()

void QgsGpsInformation::setNavigationStatus ( Qgis::GpsNavigationStatus  status)
inline

Sets the navigation status.

See also
navigationStatus()
Since
QGIS 3.38

Definition at line 220 of file qgsgpsinformation.h.

Friends And Related Symbol Documentation

◆ QgsNmeaConnection

friend class QgsNmeaConnection
friend

Definition at line 253 of file qgsgpsinformation.h.

◆ QgsQtLocationConnection

friend class QgsQtLocationConnection
friend

Definition at line 254 of file qgsgpsinformation.h.

Member Data Documentation

◆ direction

double QgsGpsInformation::direction = std::numeric_limits< double >::quiet_NaN()

The bearing measured in degrees clockwise from true north to the direction of travel.

Definition at line 79 of file qgsgpsinformation.h.

◆ elevation

double QgsGpsInformation::elevation = 0

Altitude (in meters) above or below the mean sea level.

Definition at line 54 of file qgsgpsinformation.h.

◆ elevation_diff

double QgsGpsInformation::elevation_diff = 0

Geoidal separation (in meters).

The difference between the WGS-84 Earth ellipsoid and the mean sea level (geoid).

Negative values indicate that mean sea level is below the ellipsoid.

This value can be added to the elevation value to obtain the geoidal elevation.

Since
QGIS 3.18

Definition at line 67 of file qgsgpsinformation.h.

◆ fixMode

QChar QgsGpsInformation::fixMode

Fix mode (where M = Manual, forced to operate in 2D or 3D or A = Automatic, 3D/2D)

Definition at line 146 of file qgsgpsinformation.h.

◆ fixType

int QgsGpsInformation::fixType = 0

Contains the fix type, where 1 = no fix, 2 = 2d fix, 3 = 3d fix.

Deprecated:
QGIS 3.40. Use constellationFixStatus() or bestFixStatus() instead.

Definition at line 153 of file qgsgpsinformation.h.

◆ hacc

double QgsGpsInformation::hacc = std::numeric_limits< double >::quiet_NaN()

Horizontal accuracy in meters.

Definition at line 110 of file qgsgpsinformation.h.

◆ hdop

double QgsGpsInformation::hdop = 0

Horizontal dilution of precision.

Definition at line 101 of file qgsgpsinformation.h.

◆ hvacc

double QgsGpsInformation::hvacc = std::numeric_limits< double >::quiet_NaN()

3D RMS

Since
QGIS 3.18

Definition at line 118 of file qgsgpsinformation.h.

◆ latitude

double QgsGpsInformation::latitude = 0

Latitude in decimal degrees, using the WGS84 datum.

A positive value indicates the Northern Hemisphere, and a negative value indicates the Southern Hemisphere.

Definition at line 43 of file qgsgpsinformation.h.

◆ longitude

double QgsGpsInformation::longitude = 0

Longitude in decimal degrees, using the WGS84 datum.

A positive value indicates the Eastern Hemisphere, and a negative value indicates the Western Hemisphere.

Definition at line 49 of file qgsgpsinformation.h.

◆ pdop

double QgsGpsInformation::pdop = 0

Dilution of precision.

Definition at line 96 of file qgsgpsinformation.h.

◆ quality

int QgsGpsInformation::quality = -1

GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive, etc.)

Deprecated:
QGIS 3.40. Use qualityIndicator() instead.

Definition at line 176 of file qgsgpsinformation.h.

◆ qualityIndicator

Qgis::GpsQualityIndicator QgsGpsInformation::qualityIndicator = Qgis::GpsQualityIndicator::Unknown

Returns the signal quality indicator.

Since
QGIS 3.22.6

Definition at line 182 of file qgsgpsinformation.h.

◆ satellitesInView

QList<QgsSatelliteInfo> QgsGpsInformation::satellitesInView

Contains a list of information relating to the current satellites in view.

Definition at line 91 of file qgsgpsinformation.h.

◆ satellitesUsed

int QgsGpsInformation::satellitesUsed = 0

Count of satellites used in obtaining the fix.

Definition at line 187 of file qgsgpsinformation.h.

◆ satInfoComplete

bool QgsGpsInformation::satInfoComplete = false

true if satellite information is complete.

Definition at line 202 of file qgsgpsinformation.h.

◆ satPrn

QList<int> QgsGpsInformation::satPrn

IDs of satellites used in the position fix.

Definition at line 197 of file qgsgpsinformation.h.

◆ speed

double QgsGpsInformation::speed = 0

Ground speed, in km/h.

Definition at line 72 of file qgsgpsinformation.h.

◆ status

QChar QgsGpsInformation::status

Status (A = active or V = void)

Definition at line 192 of file qgsgpsinformation.h.

◆ utcDateTime

QDateTime QgsGpsInformation::utcDateTime

The date and time at which this position was reported, in UTC time.

Definition at line 141 of file qgsgpsinformation.h.

◆ utcTime

QTime QgsGpsInformation::utcTime

The time at which this position was reported, in UTC time.

Since
QGIS 3.30

Definition at line 136 of file qgsgpsinformation.h.

◆ vacc

double QgsGpsInformation::vacc = std::numeric_limits< double >::quiet_NaN()

Vertical accuracy in meters.

Definition at line 112 of file qgsgpsinformation.h.

◆ vdop

double QgsGpsInformation::vdop = 0

Vertical dilution of precision.

Definition at line 106 of file qgsgpsinformation.h.


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