QGIS API Documentation 3.29.0-Master (006c3c0232)
Public Member Functions | Public Attributes | Friends | List of all members
QgsSatelliteInfo Class Reference

Encapsulates information relating to a GPS satellite. More...

#include <qgssatelliteinformation.h>

Public Member Functions

Qgis::GnssConstellation constellation () const
 Returns the GNSS constellation associated with the information. More...
 
bool operator!= (const QgsSatelliteInfo &other) const
 
bool operator== (const QgsSatelliteInfo &other) const
 

Public Attributes

double azimuth = std::numeric_limits< double >::quiet_NaN()
 The azimuth of the satellite to true north, in degrees. More...
 
double elevation = std::numeric_limits< double >::quiet_NaN()
 Elevation of the satellite, in degrees. More...
 
int id = 0
 Contains the satellite identifier number. More...
 
bool inUse = false
 true if satellite was used in obtaining the position fix. More...
 
QChar satType
 satType value from NMEA message $GxGSV, where x: P = GPS; S = SBAS (GPSid> 32 then SBasid = GPSid + 87); N = generic satellite; L = GLONASS; A = GALILEO; B = BEIDOU; Q = QZSS; More...
 
int signal = -1
 Signal strength (0-99dB), or -1 if not available. More...
 

Friends

class QgsNmeaConnection
 

Detailed Description

Encapsulates information relating to a GPS satellite.

Definition at line 33 of file qgssatelliteinformation.h.

Member Function Documentation

◆ constellation()

Qgis::GnssConstellation QgsSatelliteInfo::constellation ( ) const
inline

Returns the GNSS constellation associated with the information.

Since
QGIS 3.30

Definition at line 95 of file qgssatelliteinformation.h.

◆ operator!=()

bool QgsSatelliteInfo::operator!= ( const QgsSatelliteInfo other) const
inline

Definition at line 108 of file qgssatelliteinformation.h.

◆ operator==()

bool QgsSatelliteInfo::operator== ( const QgsSatelliteInfo other) const
inline

Definition at line 97 of file qgssatelliteinformation.h.

Friends And Related Function Documentation

◆ QgsNmeaConnection

friend class QgsNmeaConnection
friend

Definition at line 117 of file qgssatelliteinformation.h.

Member Data Documentation

◆ azimuth

double QgsSatelliteInfo::azimuth = std::numeric_limits< double >::quiet_NaN()

The azimuth of the satellite to true north, in degrees.

Definition at line 70 of file qgssatelliteinformation.h.

◆ elevation

double QgsSatelliteInfo::elevation = std::numeric_limits< double >::quiet_NaN()

Elevation of the satellite, in degrees.

Definition at line 56 of file qgssatelliteinformation.h.

◆ id

int QgsSatelliteInfo::id = 0

Contains the satellite identifier number.

The satellite identifier number can be used to identify a satellite inside the satellite system. For satellite system GPS the satellite identifier number represents the PRN (Pseudo-random noise) number. For satellite system GLONASS the satellite identifier number represents the slot number.

Definition at line 44 of file qgssatelliteinformation.h.

◆ inUse

bool QgsSatelliteInfo::inUse = false

true if satellite was used in obtaining the position fix.

Definition at line 49 of file qgssatelliteinformation.h.

◆ satType

QChar QgsSatelliteInfo::satType

satType value from NMEA message $GxGSV, where x: P = GPS; S = SBAS (GPSid> 32 then SBasid = GPSid + 87); N = generic satellite; L = GLONASS; A = GALILEO; B = BEIDOU; Q = QZSS;

Definition at line 88 of file qgssatelliteinformation.h.

◆ signal

int QgsSatelliteInfo::signal = -1

Signal strength (0-99dB), or -1 if not available.

Definition at line 82 of file qgssatelliteinformation.h.


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