Class GnssPositionInformation

ClassList > GnssPositionInformation

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
	GnssPositionInformation (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 GnssPositionInformation & other) const
bool	operator== (const GnssPositionInformation & 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 GnssPositionInformation::AccuracyQuality {
    AccuracyUndetermined,
    AccuracyBad,
    AccuracyOk,
    AccuracyExcellent
};

---

enum FixStatus

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

GPS fix status

---

Public Properties Documentation

property accuracyQuality [1/2]

AccuracyQuality GnssPositionInformation::accuracyQuality;

---

property averagedCount [1/2]

int GnssPositionInformation::averagedCount;

---

property direction [1/2]

double GnssPositionInformation::direction;

---

property directionValid [1/2]

bool GnssPositionInformation::directionValid;

---

property elevation [1/2]

double GnssPositionInformation::elevation;

---

property elevationValid [1/2]

bool GnssPositionInformation::elevationValid;

---

property fixMode [1/2]

QChar GnssPositionInformation::fixMode;

---

property fixStatus [1/2]

FixStatus GnssPositionInformation::fixStatus;

---

property fixStatusDescription [1/2]

QString GnssPositionInformation::fixStatusDescription;

---

property fixType [1/2]

int GnssPositionInformation::fixType;

---

property hacc [1/2]

double GnssPositionInformation::hacc;

---

property haccValid [1/2]

bool GnssPositionInformation::haccValid;

---

property hdop [1/2]

double GnssPositionInformation::hdop;

---

property hvacc [1/2]

double GnssPositionInformation::hvacc;

---

property hvaccValid [1/2]

double GnssPositionInformation::hvaccValid;

---

property imuCorrection [1/2]

bool GnssPositionInformation::imuCorrection;

---

property imuHeading [1/2]

double GnssPositionInformation::imuHeading;

---

property imuHeadingValid [1/2]

bool GnssPositionInformation::imuHeadingValid;

---

property imuPitch [1/2]

double GnssPositionInformation::imuPitch;

---

property imuPitchValid [1/2]

bool GnssPositionInformation::imuPitchValid;

---

property imuRoll [1/2]

double GnssPositionInformation::imuRoll;

---

property imuRollValid [1/2]

bool GnssPositionInformation::imuRollValid;

---

property imuSteering [1/2]

double GnssPositionInformation::imuSteering;

---

property imuSteeringValid [1/2]

bool GnssPositionInformation::imuSteeringValid;

---

property isValid [1/2]

bool GnssPositionInformation::isValid;

---

property latitude [1/2]

double GnssPositionInformation::latitude;

---

property latitudeValid [1/2]

bool GnssPositionInformation::latitudeValid;

---

property longitude [1/2]

double GnssPositionInformation::longitude;

---

property longitudeValid [1/2]

bool GnssPositionInformation::longitudeValid;

---

property magneticVariation [1/2]

double GnssPositionInformation::magneticVariation;

---

property orientation [1/2]

double GnssPositionInformation::orientation;

---

property orientationValid [1/2]

bool GnssPositionInformation::orientationValid;

---

property pdop [1/2]

double GnssPositionInformation::pdop;

---

property quality [1/2]

int GnssPositionInformation::quality;

---

property qualityDescription [1/2]

QString GnssPositionInformation::qualityDescription;

---

property satInfoComplete [1/2]

bool GnssPositionInformation::satInfoComplete;

---

property satPrn [1/2]

QList<int> GnssPositionInformation::satPrn;

---

property satellitesInView [1/2]

QList<QgsSatelliteInfo> GnssPositionInformation::satellitesInView;

---

property satellitesUsed [1/2]

int GnssPositionInformation::satellitesUsed;

---

property sourceName [1/2]

QString GnssPositionInformation::sourceName;

---

property speed [1/2]

double GnssPositionInformation::speed;

---

property speedValid [1/2]

bool GnssPositionInformation::speedValid;

---

property status [1/2]

QChar GnssPositionInformation::status;

---

property utcDateTime [1/2]

QDateTime GnssPositionInformation::utcDateTime;

---

property vacc [1/2]

double GnssPositionInformation::vacc;

---

property vaccValid [1/2]

bool GnssPositionInformation::vaccValid;

---

property vdop [1/2]

double GnssPositionInformation::vdop;

---

property verticalSpeed [1/2]

double GnssPositionInformation::verticalSpeed;

---

Public Functions Documentation

function GnssPositionInformation

GnssPositionInformation::GnssPositionInformation (
    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 GnssPositionInformation::accuracyQuality () const

---

function averagedCount [2/2]

inline int GnssPositionInformation::averagedCount () const

---

function direction [2/2]

inline double GnssPositionInformation::direction () const

---

function directionValid [2/2]

inline bool GnssPositionInformation::directionValid () const

---

function elevation [2/2]

inline double GnssPositionInformation::elevation () const

---

function elevationValid [2/2]

inline bool GnssPositionInformation::elevationValid () const

---

function fixMode [2/2]

inline QChar GnssPositionInformation::fixMode () const

---

function fixStatus [2/2]

FixStatus GnssPositionInformation::fixStatus () const

Returns the fix status

---

function fixStatusDescription [2/2]

QString GnssPositionInformation::fixStatusDescription () const

Returns the fix status as string

---

function fixType [2/2]

inline int GnssPositionInformation::fixType () const

---

function hacc [2/2]

inline double GnssPositionInformation::hacc () const

---

function haccValid [2/2]

inline bool GnssPositionInformation::haccValid () const

---

function hdop [2/2]

inline double GnssPositionInformation::hdop () const

---

function hvacc [2/2]

inline double GnssPositionInformation::hvacc () const

---

function hvaccValid [2/2]

inline bool GnssPositionInformation::hvaccValid () const

---

function imuCorrection [2/2]

inline bool GnssPositionInformation::imuCorrection () const

---

function imuHeading [2/2]

inline double GnssPositionInformation::imuHeading () const

---

function imuHeadingValid [2/2]

inline bool GnssPositionInformation::imuHeadingValid () const

---

function imuPitch [2/2]

inline double GnssPositionInformation::imuPitch () const

---

function imuPitchValid [2/2]

inline bool GnssPositionInformation::imuPitchValid () const

---

function imuRoll [2/2]

inline double GnssPositionInformation::imuRoll () const

---

function imuRollValid [2/2]

inline bool GnssPositionInformation::imuRollValid () const

---

function imuSteering [2/2]

inline double GnssPositionInformation::imuSteering () const

---

function imuSteeringValid [2/2]

inline bool GnssPositionInformation::imuSteeringValid () const

---

function isValid [2/2]

bool GnssPositionInformation::isValid () const

Returns whether the connection information is valid

---

function latitude [2/2]

inline double GnssPositionInformation::latitude () const

---

function latitudeValid [2/2]

inline bool GnssPositionInformation::latitudeValid () const

---

function longitude [2/2]

inline double GnssPositionInformation::longitude () const

---

function longitudeValid [2/2]

inline bool GnssPositionInformation::longitudeValid () const

---

function magneticVariation [2/2]

inline double GnssPositionInformation::magneticVariation () const

---

function operator!=

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

---

function operator==

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

---

function orientation [2/2]

inline double GnssPositionInformation::orientation () const

---

function orientationValid [2/2]

inline bool GnssPositionInformation::orientationValid () const

---

function pdop [2/2]

inline double GnssPositionInformation::pdop () const

---

function quality [2/2]

inline int GnssPositionInformation::quality () const

---

function qualityDescription [2/2]

QString GnssPositionInformation::qualityDescription () const

Returns a descriptive string for the signal quality

---

function satInfoComplete [2/2]

inline bool GnssPositionInformation::satInfoComplete () const

---

function satPrn [2/2]

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

---

function satellitesInView [2/2]

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

---

function satellitesUsed [2/2]

inline int GnssPositionInformation::satellitesUsed () const

---

function setAccuracyQuality

inline void GnssPositionInformation::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 GnssPositionInformation::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 GnssPositionInformation::setDirection (
    double direction
) 

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

---

function setElevation

inline void GnssPositionInformation::setElevation (
    double elevation
) 

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

---

function setFixMode

inline void GnssPositionInformation::setFixMode (
    QChar fixMode
) 

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

---

function setFixType

inline void GnssPositionInformation::setFixType (
    int fixType
) 

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

---

function setHVacc

inline void GnssPositionInformation::setHVacc (
    double hvacc
) 

3D accuracy in meters 3DRMS

---

function setHacc

inline void GnssPositionInformation::setHacc (
    double hacc
) 

Horizontal accuracy in meters. RMS

---

function setHdop

inline void GnssPositionInformation::setHdop (
    double hdop
) 

Horizontal dilution of precision.

---

function setImuCorrection

inline void GnssPositionInformation::setImuCorrection (
    bool imuCorrection
) 

Returns TRUE when IMU correction is active

---

function setImuHeading

inline void GnssPositionInformation::setImuHeading (
    double heading
) 

IMU heading

---

function setImuPitch

inline void GnssPositionInformation::setImuPitch (
    double pitch
) 

IMU pitch

---

function setImuRoll

inline void GnssPositionInformation::setImuRoll (
    double roll
) 

IMU roll

---

function setImuSteering

inline void GnssPositionInformation::setImuSteering (
    double steering
) 

IMU steering

---

function setLatitude

inline void GnssPositionInformation::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 GnssPositionInformation::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 GnssPositionInformation::setMagneticVaritation (
    double magneticVariation
) 

magnetic variation in degrees

---

function setOrientation

inline void GnssPositionInformation::setOrientation (
    double orientation
) 

Orientation (in degrees)

---

function setPdop

inline void GnssPositionInformation::setPdop (
    double pdop
) 

Dilution of precision.

---

function setQuality

inline void GnssPositionInformation::setQuality (
    int quality
) 

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

---

function setSatInfoComplete

inline void GnssPositionInformation::setSatInfoComplete (
    bool satInfoComplete
) 

TRUE if satellite information is complete.

---

function setSatPrn

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

IDs of satellites used in the position fix.

---

function setSatellitesInView

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

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

---

function setSatellitesUsed

inline void GnssPositionInformation::setSatellitesUsed (
    int satellitesUsed
) 

Count of satellites used in obtaining the fix.

---

function setSourceName

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

source name (used by QtPositioning)

---

function setSpeed

inline void GnssPositionInformation::setSpeed (
    double speed
) 

Ground speed, in km/h.

---

function setStatus

inline void GnssPositionInformation::setStatus (
    QChar status
) 

Status (A = active or V = void)

---

function setUtcDateTime

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

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

---

function setVacc

inline void GnssPositionInformation::setVacc (
    double vacc
) 

Vertical accuracy in meters VRMS

---

function setVdop

inline void GnssPositionInformation::setVdop (
    double vdop
) 

Vertical dilution of precision.

---

function setVerticalSpeed

inline void GnssPositionInformation::setVerticalSpeed (
    double verticalSpeed
) 

Vertical speed, in km/h.

---

function sourceName [2/2]

inline QString GnssPositionInformation::sourceName () const

---

function speed [2/2]

inline double GnssPositionInformation::speed () const

---

function speedValid [2/2]

inline bool GnssPositionInformation::speedValid () const

---

function status [2/2]

inline QChar GnssPositionInformation::status () const

---

function utcDateTime [2/2]

inline QDateTime GnssPositionInformation::utcDateTime () const

---

function vacc [2/2]

inline double GnssPositionInformation::vacc () const

---

function vaccValid [2/2]

inline bool GnssPositionInformation::vaccValid () const

---

function vdop [2/2]

inline double GnssPositionInformation::vdop () const

---

function verticalSpeed [2/2]

inline double GnssPositionInformation::verticalSpeed () const

---

---

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