qgsgpsdetector.h

Go to the documentation of this file.

/***************************************************************************
                          qgsgpsdetector.h  -  description
                          -------------------
    begin                : January 13th, 2009
    copyright            : (C) 2009 by Juergen E. Fischer
    email                : jef at norbit dot de
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSGPSDETECTOR_H
#define QGSGPSDETECTOR_H
 
#include "qgsconfig.h"
 
#include <QList>
#include <QObject>
#include <QPair>
 
#if defined( HAVE_QTSERIALPORT )
#include <QSerialPort>
#endif
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#ifndef SIP_RUN
template<class T>
class QgsSettingsEntryEnumFlag;
#endif
 
class QgsGpsConnection;
class QgsGpsInformation;
class QTimer;

class CORE_EXPORT QgsGpsDetector : public QObject
{
    Q_OBJECT
  public:
 
    // TODO QGIS 4.0 -- remove useUnsafeSignals option

    QgsGpsDetector( const QString &portName = QString(), bool useUnsafeSignals = true );
 
#if defined( HAVE_QTSERIALPORT )
    static const QgsSettingsEntryEnumFlag<QSerialPort::StopBits> *settingsGpsStopBits SIP_SKIP;
    static const QgsSettingsEntryEnumFlag<QSerialPort::DataBits> *settingsGpsDataBits SIP_SKIP;
    static const QgsSettingsEntryEnumFlag<QSerialPort::Parity> *settingsGpsParity SIP_SKIP;
    static const QgsSettingsEntryEnumFlag<QSerialPort::FlowControl> *settingsGpsFlowControl SIP_SKIP;
#endif
 
    ~QgsGpsDetector() override;

    QgsGpsConnection *takeConnection() SIP_TRANSFERBACK;
 
    static QList< QPair<QString, QString> > availablePorts();
 
  public slots:
    void advance();
    void detected( const QgsGpsInformation & );
    void connDestroyed( QObject * );
 
  signals:

    void connectionDetected();

    Q_DECL_DEPRECATED void detected( QgsGpsConnection *connection ) SIP_DEPRECATED;

    void detectionFailed();
 
  private slots:
 
    void connectionTimeout();
 
  private:
    bool mUseUnsafeSignals = true;
    int mPortIndex = 0;
    int mBaudIndex = -1;
    QList< QPair< QString, QString > > mPortList;
    QList<qint32> mBaudList;
 
    std::unique_ptr< QgsGpsConnection > mConn;
    QTimer *mTimeoutTimer = nullptr;
};
 
#endif // QGSGPSDETECTOR_H