NmeaLocation Class

Member Function Documentation

NmeaLocation::NmeaLocation()

Default constructor.

[override virtual noexcept] NmeaLocation::~NmeaLocation()

Destructor.

Esri::ArcGISRuntime::NmeaAccuracyType NmeaLocation::accuracyType() const

Returns the accuracy type of the location.

double NmeaLocation::dgpsAge() const

Returns the DGPS age of the location in seconds.

The DGPSAge shows the age of the differential data (in seconds) and the time elapsed since the last valid differential correction was received. Because the validity of a differential correction depends on the difference between the time the differential signal is calculated and the time it is used by the receiver, smaller values are better.

This property will return NaN when the object is empty.

Esri::ArcGISRuntime::NmeaFixType NmeaLocation::fixType() const

Returns the fix type of the location.

This property will return Invalid when the object is empty.

See also NmeaFixType.

double NmeaLocation::geoidalSeparation() const

Returns the geoidal separation in meters.

This property will return NaN when the object is empty.

double NmeaLocation::hdop() const

Returns the HDOP (horizontal dilution of precision) of the location, 0.5 through 99.9.

This property will return NaN when the object is empty.

double NmeaLocation::heightAboveGeoid() const

Returns the height above the geoid surface in meters.

This property will return NaN when the object is empty.

[since Esri::ArcGISRuntime 200.7] double NmeaLocation::latitudeError() const

Returns standard deviation of latitude error in meters, or NaN if not available or empty.

This function was introduced in Esri::ArcGISRuntime 200.7.

[since Esri::ArcGISRuntime 200.7] double NmeaLocation::longitudeError() const

Returns standard deviation of longitude error in meters, or NaN if not available or empty.

This function was introduced in Esri::ArcGISRuntime 200.7.

[since Esri::ArcGISRuntime 200.7] double NmeaLocation::magneticVariation() const

Returns magnetic variation in degrees, or NaN if not available or empty.

Positive values (easterly variation) subtract from the true course and negative values (westerly variation) add to the true course. For example, when an easterly/positive variation occurs, the compass needle points east of true north due to the difference between magnetic north and true north.

This function was introduced in Esri::ArcGISRuntime 200.7.

double NmeaLocation::pdop() const

Returns the PDOP (positional dilution of precision) of the location 0.5 through 99.9.

This property will return NaN when the object is empty.

Esri::ArcGISRuntime::Point NmeaLocation::receivedPosition() const

Returns the position originally returned by the receiver.

If the incoming data was projected, this position may differ from the position.

This property will return a default constructed Point when the object is empty.

int NmeaLocation::referenceStationId() const

Returns the reference station ID of the location.

In the case of an empty NmeaLocation type, -1 will be returned.

This property will return -1 when the object is empty.

[since Esri::ArcGISRuntime 200.7] QList<Esri::ArcGISRuntime::NmeaSatelliteInfo> NmeaLocation::satellites() const

Returns the satellites info of the location.

This function was introduced in Esri::ArcGISRuntime 200.7.

double NmeaLocation::vdop() const

Returns the VDOP (vertical dilution of precision) of the location, 0.5 through 99.9.

This property will return NaN when the object is empty.