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...

QString	qualityDescription () const
	Returns a descriptive string for the signal quality. 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...

double	elevation_diff = 0
	Geoidal separation (Diff. 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	hvacc = std::numeric_limits< double >::quiet_NaN()
	3D RMS 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, etc.) More...

Qgis::GpsQualityIndicator	qualityIndicator = Qgis::GpsQualityIndicator::Unknown
	Returns the signal quality indicator. More...

QList< QgsSatelliteInfo >	satellitesInView
	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 119 of file qgsgpsconnection.h.

Member Enumeration Documentation

◆ FixStatus

enum QgsGpsInformation::FixStatus

GPS fix status.

Since: QGIS 3.10

Enumerator
NoData
NoFix
Fix2D
Fix3D

Definition at line 127 of file qgsgpsconnection.h.

Member Function Documentation

◆ fixStatus()

QgsGpsInformation::FixStatus QgsGpsInformation::fixStatus ( ) const

Returns the fix status.

Since: QGIS 3.10

Definition at line 47 of file qgsgpsconnection.cpp.

◆ isValid()

bool QgsGpsInformation::isValid ( ) const

Returns whether the connection information is valid.

Since: QGIS 3.10

Definition at line 28 of file qgsgpsconnection.cpp.

◆ qualityDescription()

QString QgsGpsInformation::qualityDescription ( ) const

Returns a descriptive string for the signal quality.

Since: QGIS 3.16

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

◆ elevation

double QgsGpsInformation::elevation = 0

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

Definition at line 150 of file qgsgpsconnection.h.

◆ elevation_diff

double QgsGpsInformation::elevation_diff = 0

Geoidal separation (Diff.

between WGS-84 earth ellipsoid and mean sea level.

Since: QGIS 3.18

Definition at line 158 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 231 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 236 of file qgsgpsconnection.h.

◆ hacc

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

Horizontal accuracy in meters.

Definition at line 201 of file qgsgpsconnection.h.

◆ hdop

double QgsGpsInformation::hdop = 0

Horizontal dilution of precision.

Definition at line 192 of file qgsgpsconnection.h.

◆ hvacc

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

3D RMS

Since: QGIS 3.18

Definition at line 209 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 139 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 145 of file qgsgpsconnection.h.

◆ pdop

double QgsGpsInformation::pdop = 0

Dilution of precision.

Definition at line 187 of file qgsgpsconnection.h.

◆ quality

int QgsGpsInformation::quality = -1

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

Deprecated:: use qualityIndicator instead

Definition at line 242 of file qgsgpsconnection.h.

◆ qualityIndicator

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

Returns the signal quality indicator.

Since: QGIS 3.22.6

Definition at line 248 of file qgsgpsconnection.h.

◆ satellitesInView

QList<QgsSatelliteInfo> QgsGpsInformation::satellitesInView

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

Definition at line 182 of file qgsgpsconnection.h.

◆ satellitesUsed

int QgsGpsInformation::satellitesUsed = 0

Count of satellites used in obtaining the fix.

Definition at line 253 of file qgsgpsconnection.h.

◆ satInfoComplete

bool QgsGpsInformation::satInfoComplete = false

true if satellite information is complete.

Definition at line 268 of file qgsgpsconnection.h.

◆ satPrn

QList<int> QgsGpsInformation::satPrn

IDs of satellites used in the position fix.

Definition at line 263 of file qgsgpsconnection.h.

◆ speed

double QgsGpsInformation::speed = 0

Ground speed, in km/h.

Definition at line 163 of file qgsgpsconnection.h.

◆ status

QChar QgsGpsInformation::status

Status (A = active or V = void)

Definition at line 258 of file qgsgpsconnection.h.

◆ utcDateTime

QDateTime QgsGpsInformation::utcDateTime

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

Definition at line 226 of file qgsgpsconnection.h.

◆ vacc

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

Vertical accuracy in meters.

Definition at line 203 of file qgsgpsconnection.h.

◆ vdop

double QgsGpsInformation::vdop = 0

Vertical dilution of precision.

Definition at line 197 of file qgsgpsconnection.h.

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

/build/qgis-3.28.0+99sid/src/core/gps/qgsgpsconnection.h
/build/qgis-3.28.0+99sid/src/core/gps/qgsgpsconnection.cpp

Public Types

Public Member Functions

Public Attributes