Skip to content

Class QfGnssPositionInformation

ClassList > QfGnssPositionInformation

Public Types

Type Name
enum AccuracyQuality
enum FixStatus

Public Properties

Type Name
property AccuracyQuality accuracyQuality
property int averagedCount
property double direction
property bool directionValid
property double elevation
property bool elevationValid
property QChar fixMode
property FixStatus fixStatus
property QString fixStatusDescription
property int fixType
property double hacc
property bool haccValid
property double hdop
property double hvacc
property double hvaccValid
property bool imuCorrection
property double imuHeading
property bool imuHeadingValid
property double imuPitch
property bool imuPitchValid
property double imuRoll
property bool imuRollValid
property double imuSteering
property bool imuSteeringValid
property bool isValid
property double latitude
property bool latitudeValid
property double longitude
property bool longitudeValid
property double magneticVariation
property double orientation
property bool orientationValid
property double pdop
property int quality
property QString qualityDescription
property bool satInfoComplete
property QList< int > satPrn
property QList< QgsSatelliteInfo > satellitesInView
property int satellitesUsed
property QString sourceName
property double speed
property bool speedValid
property QChar status
property QDateTime utcDateTime
property double vacc
property bool vaccValid
property double vdop
property double verticalSpeed

Public Functions

Type Name
QfGnssPositionInformation (double latitude=std::numeric_limits< double >::quiet_NaN(), double longitude=std::numeric_limits< double >::quiet_NaN(), double elevation=std::numeric_limits< double >::quiet_NaN(), double speed=std::numeric_limits< double >::quiet_NaN(), double direction=std::numeric_limits< double >::quiet_NaN(), const QList< QgsSatelliteInfo > & satellitesInView=QList< QgsSatelliteInfo >(), double pdop=0, double hdop=0, double vdop=0, double hacc=std::numeric_limits< double >::quiet_NaN(), double vacc=std::numeric_limits< double >::quiet_NaN(), QDateTime utcDateTime=QDateTime(), QChar fixMode=QChar(), int fixType=0, int quality=-1, int satellitesUsed=0, QChar status=QChar(), const QList< int > & satPrn=QList< int >(), bool satInfoComplete=false, double verticalSpeed=std::numeric_limits< double >::quiet_NaN(), double magneticVariation=std::numeric_limits< double >::quiet_NaN(), int averagedCount=0, const QString & sourceName=QString(), bool imuCorrection=false, double imuRoll=std::numeric_limits< double >::quiet_NaN(), double imuPitch=std::numeric_limits< double >::quiet_NaN(), double imuHeading=std::numeric_limits< double >::quiet_NaN(), double imuSteering=std::numeric_limits< double >::quiet_NaN(), double orientation=std::numeric_limits< double >::quiet_NaN())
AccuracyQuality accuracyQuality () const
int averagedCount () const
double direction () const
bool directionValid () const
double elevation () const
bool elevationValid () const
QChar fixMode () const
FixStatus fixStatus () const
QString fixStatusDescription () const
int fixType () const
double hacc () const
bool haccValid () const
double hdop () const
double hvacc () const
bool hvaccValid () const
bool imuCorrection () const
double imuHeading () const
bool imuHeadingValid () const
double imuPitch () const
bool imuPitchValid () const
double imuRoll () const
bool imuRollValid () const
double imuSteering () const
bool imuSteeringValid () const
bool isValid () const
double latitude () const
bool latitudeValid () const
double longitude () const
bool longitudeValid () const
double magneticVariation () const
bool operator!= (const QfGnssPositionInformation & other) const
bool operator== (const QfGnssPositionInformation & other) const
double orientation () const
bool orientationValid () const
double pdop () const
int quality () const
QString qualityDescription () const
bool satInfoComplete () const
QList< int > satPrn () const
QList< QgsSatelliteInfo > satellitesInView () const
int satellitesUsed () const
void setAccuracyQuality (AccuracyQuality quality)
void setAveragedCount (int averagedCount)
void setDirection (double direction)
void setElevation (double elevation)
void setFixMode (QChar fixMode)
void setFixType (int fixType)
void setHVacc (double hvacc)
void setHacc (double hacc)
void setHdop (double hdop)
void setImuCorrection (bool imuCorrection)
void setImuHeading (double heading)
void setImuPitch (double pitch)
void setImuRoll (double roll)
void setImuSteering (double steering)
void setLatitude (double latitude)
void setLongitude (double longitude)
void setMagneticVaritation (double magneticVariation)
void setOrientation (double orientation)
void setPdop (double pdop)
void setQuality (int quality)
void setSatInfoComplete (bool satInfoComplete)
void setSatPrn (const QList< int > & satPrn)
void setSatellitesInView (const QList< QgsSatelliteInfo > & satellitesInView)
void setSatellitesUsed (int satellitesUsed)
void setSourceName (const QString & sourceName)
void setSpeed (double speed)
void setStatus (QChar status)
void setUtcDateTime (const QDateTime & utcDateTime)
void setVacc (double vacc)
void setVdop (double vdop)
void setVerticalSpeed (double verticalSpeed)
QString sourceName () const
double speed () const
bool speedValid () const
QChar status () const
QDateTime utcDateTime () const
double vacc () const
bool vaccValid () const
double vdop () const
double verticalSpeed () const

Public Types Documentation

enum AccuracyQuality

enum QfGnssPositionInformation::AccuracyQuality {
    AccuracyUndetermined,
    AccuracyBad,
    AccuracyOk,
    AccuracyExcellent
};

enum FixStatus

enum QfGnssPositionInformation::FixStatus {
    NoData,
    NoFix,
    Fix2D,
    Fix3D
};

GPS fix status


Public Properties Documentation

property accuracyQuality [1/2]

AccuracyQuality QfGnssPositionInformation::accuracyQuality;

property averagedCount [1/2]

int QfGnssPositionInformation::averagedCount;

property direction [1/2]

double QfGnssPositionInformation::direction;

property directionValid [1/2]

bool QfGnssPositionInformation::directionValid;

property elevation [1/2]

double QfGnssPositionInformation::elevation;

property elevationValid [1/2]

bool QfGnssPositionInformation::elevationValid;

property fixMode [1/2]

QChar QfGnssPositionInformation::fixMode;

property fixStatus [1/2]

FixStatus QfGnssPositionInformation::fixStatus;

property fixStatusDescription [1/2]

QString QfGnssPositionInformation::fixStatusDescription;

property fixType [1/2]

int QfGnssPositionInformation::fixType;

property hacc [1/2]

double QfGnssPositionInformation::hacc;

property haccValid [1/2]

bool QfGnssPositionInformation::haccValid;

property hdop [1/2]

double QfGnssPositionInformation::hdop;

property hvacc [1/2]

double QfGnssPositionInformation::hvacc;

property hvaccValid [1/2]

double QfGnssPositionInformation::hvaccValid;

property imuCorrection [1/2]

bool QfGnssPositionInformation::imuCorrection;

property imuHeading [1/2]

double QfGnssPositionInformation::imuHeading;

property imuHeadingValid [1/2]

bool QfGnssPositionInformation::imuHeadingValid;

property imuPitch [1/2]

double QfGnssPositionInformation::imuPitch;

property imuPitchValid [1/2]

bool QfGnssPositionInformation::imuPitchValid;

property imuRoll [1/2]

double QfGnssPositionInformation::imuRoll;

property imuRollValid [1/2]

bool QfGnssPositionInformation::imuRollValid;

property imuSteering [1/2]

double QfGnssPositionInformation::imuSteering;

property imuSteeringValid [1/2]

bool QfGnssPositionInformation::imuSteeringValid;

property isValid [1/2]

bool QfGnssPositionInformation::isValid;

property latitude [1/2]

double QfGnssPositionInformation::latitude;

property latitudeValid [1/2]

bool QfGnssPositionInformation::latitudeValid;

property longitude [1/2]

double QfGnssPositionInformation::longitude;

property longitudeValid [1/2]

bool QfGnssPositionInformation::longitudeValid;

property magneticVariation [1/2]

double QfGnssPositionInformation::magneticVariation;

property orientation [1/2]

double QfGnssPositionInformation::orientation;

property orientationValid [1/2]

bool QfGnssPositionInformation::orientationValid;

property pdop [1/2]

double QfGnssPositionInformation::pdop;

property quality [1/2]

int QfGnssPositionInformation::quality;

property qualityDescription [1/2]

QString QfGnssPositionInformation::qualityDescription;

property satInfoComplete [1/2]

bool QfGnssPositionInformation::satInfoComplete;

property satPrn [1/2]

QList<int> QfGnssPositionInformation::satPrn;

property satellitesInView [1/2]

QList<QgsSatelliteInfo> QfGnssPositionInformation::satellitesInView;

property satellitesUsed [1/2]

int QfGnssPositionInformation::satellitesUsed;

property sourceName [1/2]

QString QfGnssPositionInformation::sourceName;

property speed [1/2]

double QfGnssPositionInformation::speed;

property speedValid [1/2]

bool QfGnssPositionInformation::speedValid;

property status [1/2]

QChar QfGnssPositionInformation::status;

property utcDateTime [1/2]

QDateTime QfGnssPositionInformation::utcDateTime;

property vacc [1/2]

double QfGnssPositionInformation::vacc;

property vaccValid [1/2]

bool QfGnssPositionInformation::vaccValid;

property vdop [1/2]

double QfGnssPositionInformation::vdop;

property verticalSpeed [1/2]

double QfGnssPositionInformation::verticalSpeed;

Public Functions Documentation

function QfGnssPositionInformation

QfGnssPositionInformation::QfGnssPositionInformation (
    double latitude=std::numeric_limits< double >::quiet_NaN(),
    double longitude=std::numeric_limits< double >::quiet_NaN(),
    double elevation=std::numeric_limits< double >::quiet_NaN(),
    double speed=std::numeric_limits< double >::quiet_NaN(),
    double direction=std::numeric_limits< double >::quiet_NaN(),
    const QList< QgsSatelliteInfo > & satellitesInView=QList< QgsSatelliteInfo >(),
    double pdop=0,
    double hdop=0,
    double vdop=0,
    double hacc=std::numeric_limits< double >::quiet_NaN(),
    double vacc=std::numeric_limits< double >::quiet_NaN(),
    QDateTime utcDateTime=QDateTime(),
    QChar fixMode=QChar(),
    int fixType=0,
    int quality=-1,
    int satellitesUsed=0,
    QChar status=QChar(),
    const QList< int > & satPrn=QList< int >(),
    bool satInfoComplete=false,
    double verticalSpeed=std::numeric_limits< double >::quiet_NaN(),
    double magneticVariation=std::numeric_limits< double >::quiet_NaN(),
    int averagedCount=0,
    const QString & sourceName=QString(),
    bool imuCorrection=false,
    double imuRoll=std::numeric_limits< double >::quiet_NaN(),
    double imuPitch=std::numeric_limits< double >::quiet_NaN(),
    double imuHeading=std::numeric_limits< double >::quiet_NaN(),
    double imuSteering=std::numeric_limits< double >::quiet_NaN(),
    double orientation=std::numeric_limits< double >::quiet_NaN()
) 

GNSSPositionInformation constructor.


function accuracyQuality [2/2]

inline AccuracyQuality QfGnssPositionInformation::accuracyQuality () const

function averagedCount [2/2]

inline int QfGnssPositionInformation::averagedCount () const

function direction [2/2]

inline double QfGnssPositionInformation::direction () const

function directionValid [2/2]

inline bool QfGnssPositionInformation::directionValid () const

function elevation [2/2]

inline double QfGnssPositionInformation::elevation () const

function elevationValid [2/2]

inline bool QfGnssPositionInformation::elevationValid () const

function fixMode [2/2]

inline QChar QfGnssPositionInformation::fixMode () const

function fixStatus [2/2]

FixStatus QfGnssPositionInformation::fixStatus () const

Returns the fix status


function fixStatusDescription [2/2]

QString QfGnssPositionInformation::fixStatusDescription () const

Returns the fix status as string


function fixType [2/2]

inline int QfGnssPositionInformation::fixType () const

function hacc [2/2]

inline double QfGnssPositionInformation::hacc () const

function haccValid [2/2]

inline bool QfGnssPositionInformation::haccValid () const

function hdop [2/2]

inline double QfGnssPositionInformation::hdop () const

function hvacc [2/2]

inline double QfGnssPositionInformation::hvacc () const

function hvaccValid [2/2]

inline bool QfGnssPositionInformation::hvaccValid () const

function imuCorrection [2/2]

inline bool QfGnssPositionInformation::imuCorrection () const

function imuHeading [2/2]

inline double QfGnssPositionInformation::imuHeading () const

function imuHeadingValid [2/2]

inline bool QfGnssPositionInformation::imuHeadingValid () const

function imuPitch [2/2]

inline double QfGnssPositionInformation::imuPitch () const

function imuPitchValid [2/2]

inline bool QfGnssPositionInformation::imuPitchValid () const

function imuRoll [2/2]

inline double QfGnssPositionInformation::imuRoll () const

function imuRollValid [2/2]

inline bool QfGnssPositionInformation::imuRollValid () const

function imuSteering [2/2]

inline double QfGnssPositionInformation::imuSteering () const

function imuSteeringValid [2/2]

inline bool QfGnssPositionInformation::imuSteeringValid () const

function isValid [2/2]

bool QfGnssPositionInformation::isValid () const

Returns whether the connection information is valid


function latitude [2/2]

inline double QfGnssPositionInformation::latitude () const

function latitudeValid [2/2]

inline bool QfGnssPositionInformation::latitudeValid () const

function longitude [2/2]

inline double QfGnssPositionInformation::longitude () const

function longitudeValid [2/2]

inline bool QfGnssPositionInformation::longitudeValid () const

function magneticVariation [2/2]

inline double QfGnssPositionInformation::magneticVariation () const

function operator!=

inline bool QfGnssPositionInformation::operator!= (
    const QfGnssPositionInformation & other
) const

function operator==

bool QfGnssPositionInformation::operator== (
    const QfGnssPositionInformation & other
) const

function orientation [2/2]

inline double QfGnssPositionInformation::orientation () const

function orientationValid [2/2]

inline bool QfGnssPositionInformation::orientationValid () const

function pdop [2/2]

inline double QfGnssPositionInformation::pdop () const

function quality [2/2]

inline int QfGnssPositionInformation::quality () const

function qualityDescription [2/2]

QString QfGnssPositionInformation::qualityDescription () const

Returns a descriptive string for the signal quality


function satInfoComplete [2/2]

inline bool QfGnssPositionInformation::satInfoComplete () const

function satPrn [2/2]

inline QList< int > QfGnssPositionInformation::satPrn () const

function satellitesInView [2/2]

inline QList< QgsSatelliteInfo > QfGnssPositionInformation::satellitesInView () const

function satellitesUsed [2/2]

inline int QfGnssPositionInformation::satellitesUsed () const

function setAccuracyQuality

inline void QfGnssPositionInformation::setAccuracyQuality (
    AccuracyQuality quality
) 

Accuracy quality classification. Indicates if the position accuracy is bad, ok, or excellent, based on user-provided thresholds.


function setAveragedCount

inline void QfGnssPositionInformation::setAveragedCount (
    int averagedCount
) 

Returns the number of collected position from which the averaged positioning details were computed

Note:

A value of zero means the position information isn't averaged


function setDirection

inline void QfGnssPositionInformation::setDirection (
    double direction
) 

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


function setElevation

inline void QfGnssPositionInformation::setElevation (
    double elevation
) 

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


function setFixMode

inline void QfGnssPositionInformation::setFixMode (
    QChar fixMode
) 

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


function setFixType

inline void QfGnssPositionInformation::setFixType (
    int fixType
) 

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


function setHVacc

inline void QfGnssPositionInformation::setHVacc (
    double hvacc
) 

3D accuracy in meters 3DRMS


function setHacc

inline void QfGnssPositionInformation::setHacc (
    double hacc
) 

Horizontal accuracy in meters. RMS


function setHdop

inline void QfGnssPositionInformation::setHdop (
    double hdop
) 

Horizontal dilution of precision.


function setImuCorrection

inline void QfGnssPositionInformation::setImuCorrection (
    bool imuCorrection
) 

Returns TRUE when IMU correction is active


function setImuHeading

inline void QfGnssPositionInformation::setImuHeading (
    double heading
) 

IMU heading


function setImuPitch

inline void QfGnssPositionInformation::setImuPitch (
    double pitch
) 

IMU pitch


function setImuRoll

inline void QfGnssPositionInformation::setImuRoll (
    double roll
) 

IMU roll


function setImuSteering

inline void QfGnssPositionInformation::setImuSteering (
    double steering
) 

IMU steering


function setLatitude

inline void QfGnssPositionInformation::setLatitude (
    double latitude
) 

Latitude in decimal degrees, using the WGS84 datum. A positive value indicates the Northern Hemisphere, and a negative value indicates the Southern Hemisphere.


function setLongitude

inline void QfGnssPositionInformation::setLongitude (
    double longitude
) 

Longitude in decimal degrees, using the WGS84 datum. A positive value indicates the Eastern Hemisphere, and a negative value indicates the Western Hemisphere.


function setMagneticVaritation

inline void QfGnssPositionInformation::setMagneticVaritation (
    double magneticVariation
) 

magnetic variation in degrees


function setOrientation

inline void QfGnssPositionInformation::setOrientation (
    double orientation
) 

Orientation (in degrees)


function setPdop

inline void QfGnssPositionInformation::setPdop (
    double pdop
) 

Dilution of precision.


function setQuality

inline void QfGnssPositionInformation::setQuality (
    int quality
) 

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


function setSatInfoComplete

inline void QfGnssPositionInformation::setSatInfoComplete (
    bool satInfoComplete
) 

TRUE if satellite information is complete.


function setSatPrn

inline void QfGnssPositionInformation::setSatPrn (
    const QList< int > & satPrn
) 

IDs of satellites used in the position fix.


function setSatellitesInView

inline void QfGnssPositionInformation::setSatellitesInView (
    const QList< QgsSatelliteInfo > & satellitesInView
) 

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


function setSatellitesUsed

inline void QfGnssPositionInformation::setSatellitesUsed (
    int satellitesUsed
) 

Count of satellites used in obtaining the fix.


function setSourceName

inline void QfGnssPositionInformation::setSourceName (
    const QString & sourceName
) 

source name (used by QtPositioning)


function setSpeed

inline void QfGnssPositionInformation::setSpeed (
    double speed
) 

Ground speed, in km/h.


function setStatus

inline void QfGnssPositionInformation::setStatus (
    QChar status
) 

Status (A = active or V = void)


function setUtcDateTime

inline void QfGnssPositionInformation::setUtcDateTime (
    const QDateTime & utcDateTime
) 

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


function setVacc

inline void QfGnssPositionInformation::setVacc (
    double vacc
) 

Vertical accuracy in meters VRMS


function setVdop

inline void QfGnssPositionInformation::setVdop (
    double vdop
) 

Vertical dilution of precision.


function setVerticalSpeed

inline void QfGnssPositionInformation::setVerticalSpeed (
    double verticalSpeed
) 

Vertical speed, in km/h.


function sourceName [2/2]

inline QString QfGnssPositionInformation::sourceName () const

function speed [2/2]

inline double QfGnssPositionInformation::speed () const

function speedValid [2/2]

inline bool QfGnssPositionInformation::speedValid () const

function status [2/2]

inline QChar QfGnssPositionInformation::status () const

function utcDateTime [2/2]

inline QDateTime QfGnssPositionInformation::utcDateTime () const

function vacc [2/2]

inline double QfGnssPositionInformation::vacc () const

function vaccValid [2/2]

inline bool QfGnssPositionInformation::vaccValid () const

function vdop [2/2]

inline double QfGnssPositionInformation::vdop () const

function verticalSpeed [2/2]

inline double QfGnssPositionInformation::verticalSpeed () const


The documentation for this class was generated from the following file src/core/positioning/qfgnsspositioninformation.h