QGIS API Documentation  3.13.0-Master (7f54853aae)
Public Types | Public Member Functions | Public Attributes | List of all members
QgsGpsInformation Class Reference

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

#include <qgsgpsconnection.h>

Public Types

enum  FixStatus { NoData, NoFix, Fix2D, Fix3D }
 GPS fix status. More...
 

Public Member Functions

FixStatus fixStatus () const
 Returns the fix status. More...
 
bool isValid () const
 Returns whether the connection information is valid. More...
 

Public Attributes

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

Detailed Description

Encapsulates information relating to a GPS position fix.

Definition at line 98 of file qgsgpsconnection.h.

Member Enumeration Documentation

◆ FixStatus

GPS fix status.

Since
QGIS 3.10
Enumerator
NoData 
NoFix 
Fix2D 
Fix3D 

Definition at line 106 of file qgsgpsconnection.h.

Member Function Documentation

◆ fixStatus()

QgsGpsInformation::FixStatus QgsGpsInformation::fixStatus ( ) const

Returns the fix status.

Since
QGIS 3.10

Definition at line 50 of file qgsgpsconnection.cpp.

◆ isValid()

bool QgsGpsInformation::isValid ( ) const

Returns whether the connection information is valid.

Since
QGIS 3.10

Definition at line 31 of file qgsgpsconnection.cpp.

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 141 of file qgsgpsconnection.h.

◆ elevation

double QgsGpsInformation::elevation = 0

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

Definition at line 129 of file qgsgpsconnection.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 190 of file qgsgpsconnection.h.

◆ fixType

int QgsGpsInformation::fixType = 0

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

Definition at line 195 of file qgsgpsconnection.h.

◆ hacc

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

Horizontal accuracy in meters.

Definition at line 172 of file qgsgpsconnection.h.

◆ hdop

double QgsGpsInformation::hdop = 0

Horizontal dilution of precision.

Definition at line 163 of file qgsgpsconnection.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 118 of file qgsgpsconnection.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 124 of file qgsgpsconnection.h.

◆ pdop

double QgsGpsInformation::pdop = 0

Dilution of precision.

Definition at line 158 of file qgsgpsconnection.h.

◆ quality

int QgsGpsInformation::quality = -1

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

Definition at line 200 of file qgsgpsconnection.h.

◆ satellitesInView

QList<QgsSatelliteInfo> QgsGpsInformation::satellitesInView

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

Definition at line 153 of file qgsgpsconnection.h.

◆ satellitesUsed

int QgsGpsInformation::satellitesUsed = 0

Count of satellites used in obtaining the fix.

Definition at line 205 of file qgsgpsconnection.h.

◆ satInfoComplete

bool QgsGpsInformation::satInfoComplete = false

true if satellite information is complete.

Definition at line 220 of file qgsgpsconnection.h.

◆ satPrn

QList<int> QgsGpsInformation::satPrn

IDs of satellites used in the position fix.

Definition at line 215 of file qgsgpsconnection.h.

◆ speed

double QgsGpsInformation::speed = 0

Ground speed, in km/h.

Definition at line 134 of file qgsgpsconnection.h.

◆ status

QChar QgsGpsInformation::status

Status (A = active or V = void)

Definition at line 210 of file qgsgpsconnection.h.

◆ utcDateTime

QDateTime QgsGpsInformation::utcDateTime

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

Definition at line 185 of file qgsgpsconnection.h.

◆ vacc

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

Vertical accuracy in meters.

Definition at line 174 of file qgsgpsconnection.h.

◆ vdop

double QgsGpsInformation::vdop = 0

Vertical dilution of precision.

Definition at line 168 of file qgsgpsconnection.h.


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