Class PositioningSource
#include <positioningsource.h>
Inherits the following classes: QObject
Public Types
| Type | Name |
|---|---|
| enum | ElevationCorrectionMode |
| enum | NtripState |
Public Static Attributes
| Type | Name |
|---|---|
| QString | backgroundFilePath = QStringLiteral( "%1/positioning.background" ).arg( QStandardPaths::writableLocation( QStandardPaths::AppDataLocation ) ) |
Public Slots
| Type | Name |
|---|---|
| slot void | triggerConnectDevice |
| slot void | triggerDisconnectDevice |
Public Properties
| Type | Name |
|---|---|
| property bool | active |
| property double | antennaHeight |
| property bool | backgroundMode |
| property double | deviceBatteryLevel |
| property int | deviceCapabilities |
| property GnssPositionDetails | deviceDetails |
| property QString | deviceId |
| property QString | deviceLastError |
| property QAbstractSocket::SocketState | deviceSocketState |
| property QString | deviceSocketStateString |
| property ElevationCorrectionMode | elevationCorrectionMode |
| property bool | enableNtrip |
| property bool | logging |
| property QString | loggingPath |
| property qint64 | ntripBytesReceived |
| property qint64 | ntripBytesSent |
| property QDateTime | ntripLastBytesReceivedUtcDateTime |
| property QString | ntripLastError |
| property NtripSettings | ntripSettings |
| property NtripState | ntripState |
| property double | orientation |
| property GnssPositionInformation | positionInformation |
| property bool | valid |
Public Signals
| Type | Name |
|---|---|
| signal void | activeChanged |
| signal void | antennaHeightChanged |
| signal void | backgroundModeChanged |
| signal void | deviceBatteryLevelChanged |
| signal void | deviceChanged |
| signal void | deviceIdChanged |
| signal void | deviceLastErrorChanged |
| signal void | deviceSocketStateChanged |
| signal void | deviceSocketStateStringChanged |
| signal void | elevationCorrectionModeChanged |
| signal void | enableNtripChanged |
| signal void | loggingChanged |
| signal void | loggingPathChanged |
| signal void | ntripBytesReceivedChanged |
| signal void | ntripBytesSentChanged |
| signal void | ntripLastBytesReceivedUtcDateTimeChanged |
| signal void | ntripLastErrorChanged |
| signal void | ntripSettingsChanged |
| signal void | ntripStateChanged |
| signal void | orientationChanged |
| signal void | positionInformationChanged |
| signal void | validChanged |
Public Functions
| Type | Name |
|---|---|
| PositioningSource (QObject * parent=nullptr) |
|
| bool | active () const |
| double | antennaHeight () const |
| bool | backgroundMode () const |
| AbstractGnssReceiver * | device () const |
| double | deviceBatteryLevel () const |
| int | deviceCapabilities () const |
| GnssPositionDetails | deviceDetails () const |
| QString | deviceId () const |
| QString | deviceLastError () const |
| QAbstractSocket::SocketState | deviceSocketState () const |
| QString | deviceSocketStateString () const |
| ElevationCorrectionMode | elevationCorrectionMode () const |
| bool | enableNtrip () const |
| Q_INVOKABLE QList< GnssPositionInformation > | getBackgroundPositionInformation () const |
| bool | logging () const |
| QString | loggingPath () const |
| qint64 | ntripBytesReceived () const |
| qint64 | ntripBytesSent () const |
| QDateTime | ntripLastBytesReceivedUtcDateTime () const |
| QString | ntripLastError () const |
| NtripSettings | ntripSettings () const |
| NtripState | ntripState () const |
| double | orientation () const |
| GnssPositionInformation | positionInformation () const |
| void | setActive (bool active) |
| void | setAntennaHeight (double antennaHeight) |
| void | setBackgroundMode (bool backgroundMode) |
| void | setDeviceId (const QString & id) |
| void | setElevationCorrectionMode (ElevationCorrectionMode elevationCorrectionMode) |
| void | setEnableNtrip (bool enableNtrip) |
| void | setLogging (bool logging) |
| void | setLoggingPath (const QString & path) |
| void | setNtripSettings (const NtripSettings & ntripSettings) |
| void | setValid (bool valid) |
| bool | valid () const |
| virtual | ~PositioningSource () = default |
Detailed Description
This class connects to GNSS devices (internal or bluetooth NMEA) and provides positioning details.
Public Types Documentation
enum ElevationCorrectionMode
enum PositioningSource::ElevationCorrectionMode {
None,
OrthometricFromDevice,
OrthometricFromGeoidFile
};
Elevation correction modes
enum NtripState
enum PositioningSource::NtripState {
Disconnected,
Connecting,
Connected
};
NTRIP client connection states
Public Static Attributes Documentation
variable backgroundFilePath
QString PositioningSource::backgroundFilePath;
Public Properties Documentation
property active [1/2]
bool PositioningSource::active;
property antennaHeight [1/2]
double PositioningSource::antennaHeight;
property backgroundMode [1/2]
bool PositioningSource::backgroundMode;
property deviceBatteryLevel [1/2]
double PositioningSource::deviceBatteryLevel;
property deviceCapabilities [1/2]
int PositioningSource::deviceCapabilities;
property deviceDetails [1/2]
GnssPositionDetails PositioningSource::deviceDetails;
property deviceId [1/2]
QString PositioningSource::deviceId;
property deviceLastError [1/2]
QString PositioningSource::deviceLastError;
property deviceSocketState [1/2]
QAbstractSocket::SocketState PositioningSource::deviceSocketState;
property deviceSocketStateString [1/2]
QString PositioningSource::deviceSocketStateString;
property elevationCorrectionMode [1/2]
ElevationCorrectionMode PositioningSource::elevationCorrectionMode;
property enableNtrip [1/2]
bool PositioningSource::enableNtrip;
property logging [1/2]
bool PositioningSource::logging;
property loggingPath [1/2]
QString PositioningSource::loggingPath;
property ntripBytesReceived [1/2]
qint64 PositioningSource::ntripBytesReceived;
property ntripBytesSent [1/2]
qint64 PositioningSource::ntripBytesSent;
property ntripLastBytesReceivedUtcDateTime [1/2]
QDateTime PositioningSource::ntripLastBytesReceivedUtcDateTime;
property ntripLastError [1/2]
QString PositioningSource::ntripLastError;
property ntripSettings [1/2]
NtripSettings PositioningSource::ntripSettings;
property ntripState [1/2]
NtripState PositioningSource::ntripState;
property orientation [1/2]
double PositioningSource::orientation;
property positionInformation [1/2]
GnssPositionInformation PositioningSource::positionInformation;
property valid [1/2]
bool PositioningSource::valid;
Public Slots Documentation
slot triggerConnectDevice
void PositioningSource::triggerConnectDevice;
slot triggerDisconnectDevice
void PositioningSource::triggerDisconnectDevice;
Public Signals Documentation
signal activeChanged
void PositioningSource::activeChanged;
signal antennaHeightChanged
void PositioningSource::antennaHeightChanged;
signal backgroundModeChanged
void PositioningSource::backgroundModeChanged;
signal deviceBatteryLevelChanged
void PositioningSource::deviceBatteryLevelChanged;
signal deviceChanged
void PositioningSource::deviceChanged;
signal deviceIdChanged
void PositioningSource::deviceIdChanged;
signal deviceLastErrorChanged
void PositioningSource::deviceLastErrorChanged;
signal deviceSocketStateChanged
void PositioningSource::deviceSocketStateChanged;
signal deviceSocketStateStringChanged
void PositioningSource::deviceSocketStateStringChanged;
signal elevationCorrectionModeChanged
void PositioningSource::elevationCorrectionModeChanged;
signal enableNtripChanged
void PositioningSource::enableNtripChanged;
signal loggingChanged
void PositioningSource::loggingChanged;
signal loggingPathChanged
void PositioningSource::loggingPathChanged;
signal ntripBytesReceivedChanged
void PositioningSource::ntripBytesReceivedChanged;
signal ntripBytesSentChanged
void PositioningSource::ntripBytesSentChanged;
signal ntripLastBytesReceivedUtcDateTimeChanged
void PositioningSource::ntripLastBytesReceivedUtcDateTimeChanged;
signal ntripLastErrorChanged
void PositioningSource::ntripLastErrorChanged;
signal ntripSettingsChanged
void PositioningSource::ntripSettingsChanged;
signal ntripStateChanged
void PositioningSource::ntripStateChanged;
signal orientationChanged
void PositioningSource::orientationChanged;
signal positionInformationChanged
void PositioningSource::positionInformationChanged;
signal validChanged
void PositioningSource::validChanged;
Public Functions Documentation
function PositioningSource
explicit PositioningSource::PositioningSource (
QObject * parent=nullptr
)
function active [2/2]
inline bool PositioningSource::active () const
Returns TRUE when positioning is active.
See also: setActive
function antennaHeight [2/2]
inline double PositioningSource::antennaHeight () const
Sets the GNSS device antenna height. This should be the pole height + sensore phase height.
Note:
When IMU is active this value is ignored as the device does the correction internally.
function backgroundMode [2/2]
inline bool PositioningSource::backgroundMode () const
Returns TRUE if the background mode is active. When activated, position information details will not be signaled but instead saved to disk until deactivated.
See also: getBackgroundPositionInformation()
function device
inline AbstractGnssReceiver * PositioningSource::device () const
Returns the current positioning device.
See also: deviceId
function deviceBatteryLevel [2/2]
inline double PositioningSource::deviceBatteryLevel () const
Returns the device current battery level as a 0.0 to 1.0 double range.
function deviceCapabilities [2/2]
int PositioningSource::deviceCapabilities () const
Returns device capabiities.
Note:
Due to Qt Remote Object issues with flags, we use an int property.
function deviceDetails [2/2]
inline GnssPositionDetails PositioningSource::deviceDetails () const
Returns extra details (such as hdop, vdop, pdop) provided by the positioning device.
function deviceId [2/2]
inline QString PositioningSource::deviceId () const
Returns the current positioning device id used to fetch position information.
See also: setDevice
function deviceLastError [2/2]
inline QString PositioningSource::deviceLastError () const
Returns positioning device's last error string.
function deviceSocketState [2/2]
inline QAbstractSocket::SocketState PositioningSource::deviceSocketState () const
Returns positioning device's socket state.
See also: deviceSocketStateString
function deviceSocketStateString [2/2]
inline QString PositioningSource::deviceSocketStateString () const
Returns a string representation of the positioning device's socket state.
See also: deviceSocketState
function elevationCorrectionMode [2/2]
inline ElevationCorrectionMode PositioningSource::elevationCorrectionMode () const
Returns the current elevation correction mode.
Note:
Some modes depends on device capabilities.
function enableNtrip [2/2]
inline bool PositioningSource::enableNtrip () const
Returns TRUE if the NTRIP client is enabled.
function getBackgroundPositionInformation
Q_INVOKABLE QList< GnssPositionInformation > PositioningSource::getBackgroundPositionInformation () const
Returns a list of position information collected while background mode is active.
See also: backgroundMode()
See also: setBackgroundMode()
function logging [2/2]
inline bool PositioningSource::logging () const
Returns whether GNSS devices will log their incoming position stream into a logfile.
Note:
Requires a device type with logging capability
function loggingPath [2/2]
inline QString PositioningSource::loggingPath () const
Returns the path where GNSS devices will log their incoming position stream into logfiles.
Note:
Requires a device type with logging capability
function ntripBytesReceived [2/2]
inline qint64 PositioningSource::ntripBytesReceived () const
Returns the number of bytes received via NTRIP.
function ntripBytesSent [2/2]
inline qint64 PositioningSource::ntripBytesSent () const
Returns the number of bytes sent via NTRIP.
function ntripLastBytesReceivedUtcDateTime [2/2]
inline QDateTime PositioningSource::ntripLastBytesReceivedUtcDateTime () const
Returns the last received bytes time in UTC.
function ntripLastError [2/2]
inline QString PositioningSource::ntripLastError () const
Returns the last NTRIP error string.
function ntripSettings [2/2]
inline NtripSettings PositioningSource::ntripSettings () const
Returns the NTRIP settings.
function ntripState [2/2]
inline NtripState PositioningSource::ntripState () const
Returns the current NTRIP connection state.
function orientation [2/2]
inline double PositioningSource::orientation () const
Returns the current device orientation
function positionInformation [2/2]
inline GnssPositionInformation PositioningSource::positionInformation () const
Returns a GnssPositionInformation position information object.
function setActive
void PositioningSource::setActive (
bool active
)
Sets the positioning active status.
See also: active
function setAntennaHeight
void PositioningSource::setAntennaHeight (
double antennaHeight
)
Returns the GNSS device antenna height. This should be the pole height + sensore phase height.
Note:
When IMU is active this value is ignored as the device does the correction internally.
function setBackgroundMode
void PositioningSource::setBackgroundMode (
bool backgroundMode
)
Sets whether the background mode is active. When activated, position information details will not be signaled but instead saved to disk until deactivated.
See also: getBackgroundPositionInformation()
function setDeviceId
void PositioningSource::setDeviceId (
const QString & id
)
Sets the positioning device id used to fetch position information.
Note:
A blank string will connect the internal positioning device; bluetooth addresses will trigger an NMEA connection to external devices.
function setElevationCorrectionMode
void PositioningSource::setElevationCorrectionMode (
ElevationCorrectionMode elevationCorrectionMode
)
Sets the current elevation correction mode.
Note:
Some modes depends on device capabilities.
function setEnableNtrip
void PositioningSource::setEnableNtrip (
bool enableNtrip
)
Sets whether the NTRIP client is enabled.
function setLogging
void PositioningSource::setLogging (
bool logging
)
Sets whether GNSS devices will log their incoming position stream into a logfile.
Note:
Requires a device type with logging capability
function setLoggingPath
void PositioningSource::setLoggingPath (
const QString & path
)
Sets the path where GNSS devices will log their incoming position stream into logfiles.
Note:
Requires a device type with logging capability
function setNtripSettings
void PositioningSource::setNtripSettings (
const NtripSettings & ntripSettings
)
Sets the NTRIP settings.
function setValid
void PositioningSource::setValid (
bool valid
)
Sets whether the positioning device is valid.
function valid [2/2]
inline bool PositioningSource::valid () const
Returns TRUE when the positioning device is valid.
function ~PositioningSource
virtual PositioningSource::~PositioningSource () = default
The documentation for this class was generated from the following file src/core/positioning/positioningsource.h