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 <QDateTime>
#include "qgis.h"
#include <QObject>
#include <QString>
 
#include "qgis_core.h"
 
class QIODevice;
 
#ifdef SIP_RUN
% ModuleHeaderCode
#include "qgsgpsconnection.h"
% End
#endif
 
class CORE_EXPORT QgsSatelliteInfo
{
  public:
 
    int id = 0;
 
    bool inUse = false;
 
#ifndef SIP_RUN
 
    double elevation = std::numeric_limits< double >::quiet_NaN();
#else
 
    double elevation;
#endif
 
#ifndef SIP_RUN
 
    double azimuth = std::numeric_limits< double >::quiet_NaN();
#else
 
    double azimuth;
#endif
 
    int signal = -1;
 
    bool operator==( const QgsSatelliteInfo &other ) const
    {
      return id == other.id &&
             inUse == other.inUse &&
             elevation == other.elevation &&
             azimuth == other.azimuth &&
             signal == other.signal;
    }
 
    bool operator!=( const QgsSatelliteInfo &other ) const
    {
      return !operator==( other );
    }
};
 
class CORE_EXPORT QgsGpsInformation
{
  public:
 
    enum FixStatus
    {
      NoData,
      NoFix,
      Fix2D,
      Fix3D
    };
 
    double latitude = 0;
 
    double longitude = 0;
 
    double elevation = 0;
 
    double elevation_diff = 0;
 
    double speed = 0;
 
#ifndef SIP_RUN
 
    double direction = std::numeric_limits< double >::quiet_NaN();
#else
 
    double direction;
#endif
 
    QList<QgsSatelliteInfo> satellitesInView;
 
    double pdop = 0;
 
    double hdop = 0;
 
    double vdop = 0;
 
#ifndef SIP_RUN
    double hacc = std::numeric_limits< double >::quiet_NaN();
    double vacc = std::numeric_limits< double >::quiet_NaN();
 
    double hvacc = std::numeric_limits< double >::quiet_NaN();
#else
    double hacc;
    double vacc;
 
    double hvacc;
#endif
 
    QDateTime utcDateTime;
 
    QChar fixMode;
 
    int fixType = 0;
 
    int quality = -1;
 
    Qgis::GpsQualityIndicator qualityIndicator = Qgis::GpsQualityIndicator::Unknown;
 
    int satellitesUsed = 0;
 
    QChar status;
 
    QList<int> satPrn;
 
    bool satInfoComplete = false;
 
    bool isValid() const;
 
    FixStatus fixStatus() const;
 
    QString qualityDescription() const;
};
 
class CORE_EXPORT QgsGpsConnection : public QObject
{
#ifdef SIP_RUN
#include <qgsgpsdconnection.h>
#include <qgsnmeaconnection.h>
#endif
 
 
#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
 
    Q_OBJECT
  public:
 
    enum Status
    {
      NotConnected,
      Connected,
      DataReceived,
      GPSDataReceived
    };
 
    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; }
 
  signals:
    void stateChanged( const QgsGpsInformation &info );
    void nmeaSentenceReceived( const QString &substring ); // added to capture 'raw' data
 
  protected:
    std::unique_ptr< QIODevice > mSource;
    QgsGpsInformation mLastGPSInformation;
    Status mStatus = NotConnected;
 
  private:
    void cleanupSource();
    void clearLastGPSInformation();
 
  protected slots:
    virtual void parseData() = 0;
};
 
#endif // QGSGPSCONNECTION_H