Skip to content

Class QfPositioningSource

ClassList > QfPositioningSource

More...

  • #include <qfpositioningsource.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 QfGnssPositionDetails 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 QfNtripSettings ntripSettings
property NtripState ntripState
property double orientation
property QfGnssPositionInformation 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
QfPositioningSource (QObject * parent=nullptr)
bool active () const
double antennaHeight () const
bool backgroundMode () const
QfAbstractGnssReceiver * device () const
double deviceBatteryLevel () const
int deviceCapabilities () const
QfGnssPositionDetails deviceDetails () const
QString deviceId () const
QString deviceLastError () const
QAbstractSocket::SocketState deviceSocketState () const
QString deviceSocketStateString () const
ElevationCorrectionMode elevationCorrectionMode () const
bool enableNtrip () const
Q_INVOKABLE QList< QfGnssPositionInformation > getBackgroundPositionInformation () const
bool logging () const
QString loggingPath () const
qint64 ntripBytesReceived () const
qint64 ntripBytesSent () const
QDateTime ntripLastBytesReceivedUtcDateTime () const
QString ntripLastError () const
QfNtripSettings ntripSettings () const
NtripState ntripState () const
double orientation () const
QfGnssPositionInformation 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 QfNtripSettings & ntripSettings)
void setValid (bool valid)
bool valid () const
virtual ~QfPositioningSource () = default

Detailed Description

This class connects to GNSS devices (internal or bluetooth NMEA) and provides positioning details.

Public Types Documentation

enum ElevationCorrectionMode

enum QfPositioningSource::ElevationCorrectionMode {
    None,
    OrthometricFromDevice,
    OrthometricFromGeoidFile
};

Elevation correction modes

enum NtripState

enum QfPositioningSource::NtripState {
    Disconnected,
    Connecting,
    Connected
};

NTRIP client connection states

Public Static Attributes Documentation

variable backgroundFilePath

QString QfPositioningSource::backgroundFilePath;

Public Properties Documentation

property active [1/2]

bool QfPositioningSource::active;

property antennaHeight [1/2]

double QfPositioningSource::antennaHeight;

property backgroundMode [1/2]

bool QfPositioningSource::backgroundMode;

property deviceBatteryLevel [1/2]

double QfPositioningSource::deviceBatteryLevel;

property deviceCapabilities [1/2]

int QfPositioningSource::deviceCapabilities;

property deviceDetails [1/2]

QfGnssPositionDetails QfPositioningSource::deviceDetails;

property deviceId [1/2]

QString QfPositioningSource::deviceId;

property deviceLastError [1/2]

QString QfPositioningSource::deviceLastError;

property deviceSocketState [1/2]

QAbstractSocket::SocketState QfPositioningSource::deviceSocketState;

property deviceSocketStateString [1/2]

QString QfPositioningSource::deviceSocketStateString;

property elevationCorrectionMode [1/2]

ElevationCorrectionMode QfPositioningSource::elevationCorrectionMode;

property enableNtrip [1/2]

bool QfPositioningSource::enableNtrip;

property logging [1/2]

bool QfPositioningSource::logging;

property loggingPath [1/2]

QString QfPositioningSource::loggingPath;

property ntripBytesReceived [1/2]

qint64 QfPositioningSource::ntripBytesReceived;

property ntripBytesSent [1/2]

qint64 QfPositioningSource::ntripBytesSent;

property ntripLastBytesReceivedUtcDateTime [1/2]

QDateTime QfPositioningSource::ntripLastBytesReceivedUtcDateTime;

property ntripLastError [1/2]

QString QfPositioningSource::ntripLastError;

property ntripSettings [1/2]

QfNtripSettings QfPositioningSource::ntripSettings;

property ntripState [1/2]

NtripState QfPositioningSource::ntripState;

property orientation [1/2]

double QfPositioningSource::orientation;

property positionInformation [1/2]

QfGnssPositionInformation QfPositioningSource::positionInformation;

property valid [1/2]

bool QfPositioningSource::valid;

Public Slots Documentation

slot triggerConnectDevice

void QfPositioningSource::triggerConnectDevice;

slot triggerDisconnectDevice

void QfPositioningSource::triggerDisconnectDevice;

Public Signals Documentation

signal activeChanged

void QfPositioningSource::activeChanged;

signal antennaHeightChanged

void QfPositioningSource::antennaHeightChanged;

signal backgroundModeChanged

void QfPositioningSource::backgroundModeChanged;

signal deviceBatteryLevelChanged

void QfPositioningSource::deviceBatteryLevelChanged;

signal deviceChanged

void QfPositioningSource::deviceChanged;

signal deviceIdChanged

void QfPositioningSource::deviceIdChanged;

signal deviceLastErrorChanged

void QfPositioningSource::deviceLastErrorChanged;

signal deviceSocketStateChanged

void QfPositioningSource::deviceSocketStateChanged;

signal deviceSocketStateStringChanged

void QfPositioningSource::deviceSocketStateStringChanged;

signal elevationCorrectionModeChanged

void QfPositioningSource::elevationCorrectionModeChanged;

signal enableNtripChanged

void QfPositioningSource::enableNtripChanged;

signal loggingChanged

void QfPositioningSource::loggingChanged;

signal loggingPathChanged

void QfPositioningSource::loggingPathChanged;

signal ntripBytesReceivedChanged

void QfPositioningSource::ntripBytesReceivedChanged;

signal ntripBytesSentChanged

void QfPositioningSource::ntripBytesSentChanged;

signal ntripLastBytesReceivedUtcDateTimeChanged

void QfPositioningSource::ntripLastBytesReceivedUtcDateTimeChanged;

signal ntripLastErrorChanged

void QfPositioningSource::ntripLastErrorChanged;

signal ntripSettingsChanged

void QfPositioningSource::ntripSettingsChanged;

signal ntripStateChanged

void QfPositioningSource::ntripStateChanged;

signal orientationChanged

void QfPositioningSource::orientationChanged;

signal positionInformationChanged

void QfPositioningSource::positionInformationChanged;

signal validChanged

void QfPositioningSource::validChanged;

Public Functions Documentation

function QfPositioningSource

explicit QfPositioningSource::QfPositioningSource (
    QObject * parent=nullptr
)

function active [2/2]

inline bool QfPositioningSource::active () const

Returns TRUE when positioning is active.

See also: setActive

function antennaHeight [2/2]

inline double QfPositioningSource::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 QfPositioningSource::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 QfAbstractGnssReceiver * QfPositioningSource::device () const

Returns the current positioning device.

See also: deviceId

function deviceBatteryLevel [2/2]

inline double QfPositioningSource::deviceBatteryLevel () const

Returns the device current battery level as a 0.0 to 1.0 double range.

function deviceCapabilities [2/2]

int QfPositioningSource::deviceCapabilities () const

Returns device capabiities.

Note:

Due to Qt Remote Object issues with flags, we use an int property.

function deviceDetails [2/2]

inline QfGnssPositionDetails QfPositioningSource::deviceDetails () const

Returns extra details (such as hdop, vdop, pdop) provided by the positioning device.

function deviceId [2/2]

inline QString QfPositioningSource::deviceId () const

Returns the current positioning device id used to fetch position information.

See also: setDevice

function deviceLastError [2/2]

inline QString QfPositioningSource::deviceLastError () const

Returns positioning device's last error string.

function deviceSocketState [2/2]

inline QAbstractSocket::SocketState QfPositioningSource::deviceSocketState () const

Returns positioning device's socket state.

See also: deviceSocketStateString

function deviceSocketStateString [2/2]

inline QString QfPositioningSource::deviceSocketStateString () const

Returns a string representation of the positioning device's socket state.

See also: deviceSocketState

function elevationCorrectionMode [2/2]

inline ElevationCorrectionMode QfPositioningSource::elevationCorrectionMode () const

Returns the current elevation correction mode.

Note:

Some modes depends on device capabilities.

function enableNtrip [2/2]

inline bool QfPositioningSource::enableNtrip () const

Returns TRUE if the NTRIP client is enabled.

function getBackgroundPositionInformation

Q_INVOKABLE QList< QfGnssPositionInformation > QfPositioningSource::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 QfPositioningSource::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 QfPositioningSource::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 QfPositioningSource::ntripBytesReceived () const

Returns the number of bytes received via NTRIP.

function ntripBytesSent [2/2]

inline qint64 QfPositioningSource::ntripBytesSent () const

Returns the number of bytes sent via NTRIP.

function ntripLastBytesReceivedUtcDateTime [2/2]

inline QDateTime QfPositioningSource::ntripLastBytesReceivedUtcDateTime () const

Returns the last received bytes time in UTC.

function ntripLastError [2/2]

inline QString QfPositioningSource::ntripLastError () const

Returns the last NTRIP error string.

function ntripSettings [2/2]

inline QfNtripSettings QfPositioningSource::ntripSettings () const

Returns the NTRIP settings.

function ntripState [2/2]

inline NtripState QfPositioningSource::ntripState () const

Returns the current NTRIP connection state.

function orientation [2/2]

inline double QfPositioningSource::orientation () const

Returns the current device orientation

function positionInformation [2/2]

inline QfGnssPositionInformation QfPositioningSource::positionInformation () const

Returns a QfGnssPositionInformation position information object.

function setActive

void QfPositioningSource::setActive (
    bool active
)

Sets the positioning active status.

See also: active

function setAntennaHeight

void QfPositioningSource::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 QfPositioningSource::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 QfPositioningSource::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 QfPositioningSource::setElevationCorrectionMode (
    ElevationCorrectionMode elevationCorrectionMode
)

Sets the current elevation correction mode.

Note:

Some modes depends on device capabilities.

function setEnableNtrip

void QfPositioningSource::setEnableNtrip (
    bool enableNtrip
)

Sets whether the NTRIP client is enabled.

function setLogging

void QfPositioningSource::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 QfPositioningSource::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 QfPositioningSource::setNtripSettings (
    const QfNtripSettings & ntripSettings
)

Sets the NTRIP settings.

function setValid

void QfPositioningSource::setValid (
    bool valid
)

Sets whether the positioning device is valid.

function valid [2/2]

inline bool QfPositioningSource::valid () const

Returns TRUE when the positioning device is valid.

function ~QfPositioningSource

virtual QfPositioningSource::~QfPositioningSource () = default

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