GPSDriver.h

Go to the documentation of this file.

#pragma once
 
#include <chrono>
#include <cstdint>
#include <functional>
#include <memory>
#include <vector>
 
#include <QtCore/QByteArray>
#include <QtCore/QString>
 
#include "GPSClock.h"
#include "GPSCommand.h"
#include "GPSProtocolEvent.h"
#include "GPSReceiverConfig.h"
#include "GPSReceiverReports.h"
#include "GPSType.h"
 
class GPSTransport;
struct GPSConfig;
struct GPSReceiverFamily;
struct GPSRuntimeIO;
struct GPSRuntimeObserver;
 
struct GPSDriverSinks
{
    std::function<void(const GPSPositionReport&)> onPosition;
    std::function<void(const GPSSatelliteReport&)> onSatelliteInfo;
    std::function<void(const QByteArray&)> onRTCM;
    std::function<void(const GPSSurveyReport&)> onSurveyIn;
    std::function<void(GPSType)> onReceiverDetected;
};
 
enum class GPSReceiveLiveness
{
    Idle,
    Activity,
    Data,
};
 
struct [[nodiscard]] GPSReceiveResult
{
    GPSProtocolError error = GPSProtocolError::None;
    GPSReceiveLiveness liveness = GPSReceiveLiveness::Idle;
    GPSReceiveUpdates updates = {};
    QString detail = {};
 
    [[nodiscard]] bool terminal() const
    {
        return error != GPSProtocolError::None && error != GPSProtocolError::Cancelled;
    }
};
 
class GPSDriver
{
public:
    GPSDriver(GPSType type, GPSTransport& transport, const GPSReceiverConfig& config, GPSDriverSinks sinks,
              GPSClock clock = {});
    ~GPSDriver();
 
    Q_DISABLE_COPY(GPSDriver)
 
    
    bool configure();
 
    [[nodiscard]] GPSReceiveResult receiveOutcome(std::chrono::milliseconds timeout);
 
    [[nodiscard]] const std::vector<GPSConfigurationEvidence>& configurationEvidence() const;
 
    [[nodiscard]] const QString& configurationError() const;
 
    [[nodiscard]] bool configurationNeedsConsent() const;
 
    [[nodiscard]] QString receiverIdentity() const;
 
private:
    bool _configureDetected(GPSRuntimeIO io, GPSRuntimeObserver observer, unsigned baudrate);
    bool _configureFamily(const GPSReceiverFamily& family, GPSRuntimeIO io, GPSRuntimeObserver observer,
                          const GPSConfig& config, unsigned baudrate, const QString& detected);
    void _publish(const GPSEventBatch& batch);
    void _handle(const GPSIntegrityReport& report);
    void _handle(const GPSDecodedPosition& report);
    void _handle(const GPSDecodedSatellites& report);
    void _handle(const GPSDecodedSatelliteUsage& report);
    void _handle(const GPSSurveyReport& report);
    void _handle(const GPSRTCMFrame& report);
    void _handle(const GPSInputProtocol& report);
    void _handleSatellites(const GPSSatelliteReport& report);
    void _publishExpiredSatellites();
    void _publishSatellites(const GPSSatelliteReport& report);
 
    GPSType _type;
    GPSTransport& _transport;
    GPSReceiverConfig _config;
    GPSDriverSinks _sinks;
    GPSClock _clock;
 
    struct State;
    std::unique_ptr<State> _state;
};