QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)
|
Abstract base class for connection to a GPS device. More...
#include <qgsgpsconnection.h>
Public Types | |
enum | Status { NotConnected , Connected , DataReceived , GPSDataReceived } |
Signals | |
void | fixStatusChanged (Qgis::GpsFixStatus status) |
Emitted when the GPS device fix status is changed. | |
void | nmeaSentenceReceived (const QString &substring) |
Emitted whenever the GPS device receives a raw NMEA sentence. | |
void | positionChanged (const QgsPoint &point) |
Emitted when the GPS position changes. | |
void | stateChanged (const QgsGpsInformation &info) |
Emitted whenever the GPS state is changed. | |
Public Member Functions | |
QgsGpsConnection (QIODevice *dev) | |
Constructor. | |
~QgsGpsConnection () override | |
bool | close () |
Closes connection to device. | |
bool | connect () |
Opens connection to device. | |
QgsGpsInformation | currentGPSInformation () const |
Returns the current gps information (lat, lon, etc.) | |
QgsPoint | lastValidLocation () const |
Returns the last valid location obtained by the device. | |
void | setSource (QIODevice *source) |
Sets the GPS source. The class takes ownership of the device class. | |
Status | status () const |
Returns the status. Possible state are not connected, connected, data received. | |
Static Public Attributes | |
static const QgsSettingsEntryInteger * | settingGpsAcquisitionInterval = new QgsSettingsEntryInteger( QStringLiteral( "acquisition-interval" ), QgsSettingsTree::sTreeGps, 0, QStringLiteral( "GPS track point acquisition interval" ) ) |
Settings entry GPS track point acquisition interval. | |
static const QgsSettingsEntryBool * | settingGpsApplyLeapSecondsCorrection = new QgsSettingsEntryBool( QStringLiteral( "apply-leap-seconds-correction" ), QgsSettingsTree::sTreeGps, true, QStringLiteral( "Whether leap seconds corrections should be applied to GPS timestamps" ) ) |
Settings entry GPS apply leap seconds correction. | |
static const QgsSettingsEntryBool * | settingGpsBearingFromTravelDirection = new QgsSettingsEntryBool( QStringLiteral( "calculate-bearing-from-travel" ), QgsSettingsTree::sTreeGps, false, QStringLiteral( "Calculate GPS bearing from travel direction" ) ) |
Settings entry GPS calculate bearing from travel direction. | |
static const QgsSettingsEntryDouble * | settingGpsDistanceThreshold = new QgsSettingsEntryDouble( QStringLiteral( "distance-threshold" ), QgsSettingsTree::sTreeGps, 0, QStringLiteral( "GPS track point distance threshold" ) ) |
Settings entry GPS track point distance threshold. | |
static const QgsSettingsEntryInteger * | settingGpsLeapSeconds = new QgsSettingsEntryInteger( QStringLiteral( "leap-seconds" ), QgsSettingsTree::sTreeGps, 18, QStringLiteral( "Leap seconds correction amount (in seconds)" ) ) |
Settings entry GPS leap seconds correction amount (in seconds) | |
static const QgsSettingsEntryEnumFlag< Qgis::GpsConnectionType > * | settingsGpsConnectionType = new QgsSettingsEntryEnumFlag<Qgis::GpsConnectionType>( QStringLiteral( "gps-connection-type" ), QgsSettingsTree::sTreeGps, Qgis::GpsConnectionType::Automatic, QStringLiteral( "GPS connection type" ) ) |
Settings entry GPS connection type. | |
static const QgsSettingsEntryString * | settingsGpsdDeviceName = new QgsSettingsEntryString( QStringLiteral( "gpsd-device-name" ), QgsSettingsTree::sTreeGps, QString(), QStringLiteral( "GPSD connection device name" ) ) |
Settings entry GPSD device name. | |
static const QgsSettingsEntryString * | settingsGpsdHostName = new QgsSettingsEntryString( QStringLiteral( "gpsd-host-name" ), QgsSettingsTree::sTreeGps, QString(), QStringLiteral( "GPSD connection host name" ) ) |
Settings entry GPSD host name. | |
static const QgsSettingsEntryInteger * | settingsGpsdPortNumber = new QgsSettingsEntryInteger( QStringLiteral( "gpsd-port" ), QgsSettingsTree::sTreeGps, 2947, QStringLiteral( "GPSD port number" ) ) |
Settings entry GPSD port number. | |
static const QgsSettingsEntryString * | settingsGpsSerialDevice = new QgsSettingsEntryString( QStringLiteral( "gpsd-serial-device" ), QgsSettingsTree::sTreeGps, QString(), QStringLiteral( "GPS serial device name" ) ) |
Settings entry GPS serial device name. | |
static const QgsSettingsEntryInteger * | settingsGpsTimeStampOffsetFromUtc = new QgsSettingsEntryInteger( QStringLiteral( "timestamp-offset-from-utc" ), QgsSettingsTree::sTreeGps, 0, QStringLiteral( "GPS time stamp offset from UTC (in seconds)" ) ) |
Settings entry GPS time offset from UTC in seconds. | |
static const QgsSettingsEntryEnumFlag< Qt::TimeSpec > * | settingsGpsTimeStampSpecification = new QgsSettingsEntryEnumFlag<Qt::TimeSpec>( QStringLiteral( "timestamp-time-spec" ), QgsSettingsTree::sTreeGps, Qt::TimeSpec::LocalTime, QStringLiteral( "GPS time stamp specification" ) ) |
Settings entry time specification for GPS time stamps. | |
static const QgsSettingsEntryString * | settingsGpsTimeStampTimeZone = new QgsSettingsEntryString( QStringLiteral( "timestamp-time-zone" ), QgsSettingsTree::sTreeGps, QString(), QStringLiteral( "GPS time stamp time zone" ) ) |
Settings entry GPS time stamp time zone. | |
Protected Slots | |
virtual void | parseData ()=0 |
Parse available data source content. | |
Protected Attributes | |
QgsGpsInformation | mLastGPSInformation |
Last state of the gps related variables (e.g. position, time, ...) | |
std::unique_ptr< QIODevice > | mSource |
Data source (e.g. serial device, socket, file,...) | |
Status | mStatus = NotConnected |
Connection status. | |
Abstract base class for connection to a GPS device.
Definition at line 49 of file qgsgpsconnection.h.
Enumerator | |
---|---|
NotConnected | |
Connected | |
DataReceived | |
GPSDataReceived |
Definition at line 71 of file qgsgpsconnection.h.
QgsGpsConnection::QgsGpsConnection | ( | QIODevice * | dev | ) |
Constructor.
dev | input device for the connection (e.g. serial device). The class takes ownership of the object |
Definition at line 53 of file qgsgpsconnection.cpp.
|
override |
Definition at line 63 of file qgsgpsconnection.cpp.
bool QgsGpsConnection::close | ( | ) |
Closes connection to device.
Definition at line 83 of file qgsgpsconnection.cpp.
bool QgsGpsConnection::connect | ( | ) |
Opens connection to device.
Definition at line 68 of file qgsgpsconnection.cpp.
|
inline |
Returns the current gps information (lat, lon, etc.)
Definition at line 138 of file qgsgpsconnection.h.
|
signal |
Emitted when the GPS device fix status is changed.
|
inline |
Returns the last valid location obtained by the device.
Definition at line 145 of file qgsgpsconnection.h.
|
signal |
Emitted whenever the GPS device receives a raw NMEA sentence.
|
protectedpure virtualslot |
Parse available data source content.
|
signal |
Emitted when the GPS position changes.
This signal is only emitted when the new GPS location is considered valid (see QgsGpsInformation::isValid()).
void QgsGpsConnection::setSource | ( | QIODevice * | source | ) |
Sets the GPS source. The class takes ownership of the device class.
Definition at line 116 of file qgsgpsconnection.cpp.
|
signal |
Emitted whenever the GPS state is changed.
|
inline |
Returns the status. Possible state are not connected, connected, data received.
Definition at line 135 of file qgsgpsconnection.h.
|
protected |
Last state of the gps related variables (e.g. position, time, ...)
Definition at line 181 of file qgsgpsconnection.h.
|
protected |
Data source (e.g. serial device, socket, file,...)
Definition at line 179 of file qgsgpsconnection.h.
|
protected |
Connection status.
Definition at line 183 of file qgsgpsconnection.h.
|
static |
Settings entry GPS track point acquisition interval.
Definition at line 96 of file qgsgpsconnection.h.
|
static |
Settings entry GPS apply leap seconds correction.
Definition at line 105 of file qgsgpsconnection.h.
|
static |
Settings entry GPS calculate bearing from travel direction.
Definition at line 102 of file qgsgpsconnection.h.
|
static |
Settings entry GPS track point distance threshold.
Definition at line 99 of file qgsgpsconnection.h.
|
static |
Settings entry GPS leap seconds correction amount (in seconds)
Definition at line 108 of file qgsgpsconnection.h.
|
static |
Settings entry GPS connection type.
Definition at line 81 of file qgsgpsconnection.h.
|
static |
Settings entry GPSD device name.
Definition at line 90 of file qgsgpsconnection.h.
|
static |
Settings entry GPSD host name.
Definition at line 84 of file qgsgpsconnection.h.
|
static |
Settings entry GPSD port number.
Definition at line 87 of file qgsgpsconnection.h.
|
static |
Settings entry GPS serial device name.
Definition at line 93 of file qgsgpsconnection.h.
|
static |
Settings entry GPS time offset from UTC in seconds.
Definition at line 117 of file qgsgpsconnection.h.
|
static |
Settings entry time specification for GPS time stamps.
Definition at line 111 of file qgsgpsconnection.h.
|
static |
Settings entry GPS time stamp time zone.
Definition at line 114 of file qgsgpsconnection.h.