qgsgpsconnection.h

Go to the documentation of this file.

/***************************************************************************
                          qgsgpsconnection.h  -  description
                          -------------------
    begin                : November 30th, 2009
    copyright            : (C) 2009 by Marco Hugentobler
    email                : marco at hugis dot net
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSGPSCONNECTION_H
#define QGSGPSCONNECTION_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsgpsinformation.h"
#include "qgspoint.h"
 
#include <QDateTime>
#include <QObject>
#include <QString>
 
class QIODevice;
 
class QgsSettingsEntryBool;
class QgsSettingsEntryDouble;
class QgsSettingsEntryInteger;
class QgsSettingsEntryString;
template<class T> class QgsSettingsEntryEnumFlag;
 
 
#ifdef SIP_RUN
// clang-format off
% ModuleHeaderCode
#include "qgsgpsconnection.h"
% End
// clang-format on
#endif

  class CORE_EXPORT QgsGpsConnection : public QObject
{
    //SIP_TYPEHEADER_INCLUDE( "qgsgpsdconnection.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsnmeaconnection.h" );
 
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( sipCpp->inherits( "QgsGpsdConnection" ) )
      sipType = sipType_QgsGpsdConnection;
    else if ( sipCpp->inherits( "QgsNmeaConnection" ) )
      sipType = sipType_QgsNmeaConnection;
    else
      sipType = NULL;
    SIP_END
#endif
 
    // clang-format off
  Q_OBJECT
 
  public:
 
    enum Status
    {
      // clang-format on
      NotConnected,
      Connected,
      DataReceived,
      GPSDataReceived
    };
 
#ifndef SIP_RUN
    static const QgsSettingsEntryEnumFlag<Qgis::GpsConnectionType> *settingsGpsConnectionType;

    static const QgsSettingsEntryString *settingsGpsdHostName;

    static const QgsSettingsEntryInteger *settingsGpsdPortNumber;

    static const QgsSettingsEntryString *settingsGpsdDeviceName;

    static const QgsSettingsEntryString *settingsGpsSerialDevice;

    static const QgsSettingsEntryInteger *settingGpsAcquisitionInterval;

    static const QgsSettingsEntryDouble *settingGpsDistanceThreshold;

    static const QgsSettingsEntryBool *settingGpsBearingFromTravelDirection;

    static const QgsSettingsEntryBool *settingGpsApplyLeapSecondsCorrection;

    static const QgsSettingsEntryInteger *settingGpsLeapSeconds;

    static const QgsSettingsEntryEnumFlag<Qt::TimeSpec> *settingsGpsTimeStampSpecification;

    static const QgsSettingsEntryString *settingsGpsTimeStampTimeZone;

    static const QgsSettingsEntryInteger *settingsGpsTimeStampOffsetFromUtc;
#endif

    QgsGpsConnection( QIODevice *dev SIP_TRANSFER );
    ~QgsGpsConnection() override;
    bool connect();
    bool close();

    void setSource( QIODevice *source SIP_TRANSFER );

    Status status() const { return mStatus; }

    QgsGpsInformation currentGPSInformation() const { return mLastGPSInformation; }

    QgsPoint lastValidLocation() const { return mLastLocation; }
 
  signals:

    void stateChanged( const QgsGpsInformation &info );
 
    // TODO QGIS 5.0 -- move to QgsNmeaConnection, it makes no sense in the base class

    void nmeaSentenceReceived( const QString &substring );

    void fixStatusChanged( Qgis::GpsFixStatus status );

    void positionChanged( const QgsPoint &point );
 
  protected:
    std::unique_ptr< QIODevice > mSource;
    QgsGpsInformation mLastGPSInformation;
    Status mStatus = NotConnected;
 
  private slots:
 
    void onStateChanged( const QgsGpsInformation &info );
 
  private:
    void cleanupSource();
    void clearLastGPSInformation();
 
  protected slots:
    virtual void parseData() = 0; // cppcheck-suppress pureVirtualCall
 
  private:
    Qgis::GpsFixStatus mLastFixStatus = Qgis::GpsFixStatus::NoData;

    QgsPoint mLastLocation;
};
 
#endif // QGSGPSCONNECTION_H