qgsgpslogger.h

Go to the documentation of this file.

/***************************************************************************
  qgsgpslogger.h
   -------------------
  begin                : November 2022
  copyright            : (C) 2022 by Nyall Dawson
  email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSGPSLOGGER_H
#define QGSGPSLOGGER_H
 
#include "info.h"
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscoordinatereferencesystem.h"
#include "qgscoordinatetransformcontext.h"
#include "qgsdistancearea.h"
#include "qgswkbtypes.h"
 
#include <QDateTime>
#include <QObject>
#include <QPointer>
 
class QgsSettingsEntryBool;
class QgsSettingsEntryDouble;
class QgsSettingsEntryInteger;
class QgsSettingsEntryString;
template<class T> class QgsSettingsEntryEnumFlag;
 
 
class QgsGpsConnection;
class QgsGpsInformation;
 
class QTimer;
 

class CORE_EXPORT QgsGpsLogger : public QObject
{
    Q_OBJECT
 
  public:
    static const QgsSettingsEntryBool *settingsApplyLeapSeconds SIP_SKIP;
 
    static const QgsSettingsEntryString *settingsTimestampTimeZone SIP_SKIP;
 
    static const QgsSettingsEntryInteger *settingsTimeStampFormat SIP_SKIP;
 
    static const QgsSettingsEntryInteger *settingsLeapSecondsCorrection SIP_SKIP;
 
    static const QgsSettingsEntryInteger *settingsAcquisitionInterval SIP_SKIP;
 
    static const QgsSettingsEntryDouble *settingsDistanceThreshold SIP_SKIP;
 
#ifndef SIP_RUN
    static const QgsSettingsEntryBool *settingsGpsStoreAttributeInMValues;

    static const QgsSettingsEntryEnumFlag<Qgis::GpsInformationComponent> *settingsGpsMValueComponent;
#endif

    QgsGpsLogger( QgsGpsConnection *connection, QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsGpsLogger() override;

    QgsGpsConnection *connection();

    void setConnection( QgsGpsConnection *connection );

    void setEllipsoid( const QString &ellipsoid );

    virtual void setTransformContext( const QgsCoordinateTransformContext &context );

    QgsCoordinateTransformContext transformContext() const;

    const QgsDistanceArea &distanceArea() const;

    QVector<QgsPoint> currentTrack() const;

    QgsGeometry currentGeometry( Qgis::WkbType type, QString &error SIP_OUT ) const;

    QgsPointXY lastPosition() const;

    QDateTime lastTimestamp() const;

    QDateTime trackStartTime() const;

    double lastElevation() const;

    double lastMValue() const;

    void resetTrack();

    bool automaticallyAddTrackVertices() const;

    void setAutomaticallyAddTrackVertices( bool enabled );

    void updateGpsSettings();

    double totalTrackLength() const;

    double trackDistanceFromStart() const;

    QVariant componentValue( Qgis::GpsInformationComponent component ) const;
 
  signals:

    void trackIsEmptyChanged( bool isEmpty );

    void trackReset();

    void trackVertexAdded( const QgsPoint &vertex );

    void stateChanged( const QgsGpsInformation &info );

    void distanceAreaChanged();
 
  protected:
    QgsCoordinateReferenceSystem mWgs84CRS;

    mutable int mBlockGpsStateChanged = 0;

    void addTrackVertex();
 
  private slots:
 
    void switchAcquisition();
    void gpsStateChanged( const QgsGpsInformation &info );
 
  private:
    QPointer< QgsGpsConnection > mConnection;
 
    QgsDistanceArea mDistanceCalculator;
 
    QgsCoordinateTransformContext mTransformContext;
 
    QgsPointXY mLastGpsPositionWgs84;
    double mLastElevation = 0.0;
 
    nmeaPOS mLastNmeaPosition;
    QDateTime mLastTime;
 
    QDateTime mPreviousTrackPointTime;
    QgsPointXY mPreviousTrackPoint;
 
    QDateTime mTrackStartTime;
 
    QVector<QgsPoint> mCaptureListWgs84;
 
    std::unique_ptr<QTimer> mAcquisitionTimer;
    bool mAcquisitionEnabled = true;
    int mAcquisitionInterval = 0;
    double mDistanceThreshold = 0;
 
    bool mApplyLeapSettings = false;
    int mLeapSeconds = 0;
    Qt::TimeSpec mTimeStampSpec = Qt::TimeSpec::LocalTime;
    QString mTimeZone;
    int mOffsetFromUtc = 0;
 
    bool mAutomaticallyAddTrackVertices = true;
    bool mStoreAttributeInMValues = false;
    Qgis::GpsInformationComponent mMValueComponent = Qgis::GpsInformationComponent::Timestamp;
    double mLastMValue = std::numeric_limits<double>::quiet_NaN();
 
    friend class TestQgsGpsIntegration;
};
 
 
#endif // QGSGPSLOGGER_H