GPSReceiverDescriptor.h

Go to the documentation of this file.

#pragma once
 
#include <optional>
#include <span>
 
#include <QtCore/QLatin1StringView>
#include <QtCore/QObject>
#include <QtCore/QString>
 
#include "GPSType.h"
 
struct GPSReceiverCapabilities
{
    bool recognized = false;
    bool rtkBase = false;
    bool surveyIn = false;
    bool receiverAveraging = false;
    bool passive = false;
    bool persistentConfiguration = false;
    bool compactObservations = false;
};
 
inline constexpr int GPS_AUTOMATIC_MANUFACTURER = 0;
 
struct GPSReceiverDescriptor
{
    enum class SurveyAccuracy
    {
        Unavailable,
        PositionAccuracy,
        ObservationFilter,
    };
 
    enum class SurveyDuration
    {
        Unavailable,
        ElapsedTime,
        AcceptedObservations,
    };
 
    GPSType type;
    QLatin1StringView name;
    int manufacturerId;
    QLatin1StringView protocol = {};
    GPSReceiverCapabilities capabilities;
    SurveyAccuracy surveyAccuracy = SurveyAccuracy::Unavailable;
    SurveyDuration surveyDuration = SurveyDuration::Unavailable;
    bool configurableSurveyDuration = false;
    bool fixedBaseAccuracy = false;
    bool restartOnConnect = false;
    bool surveyMaySavePosition = false;
};
 
[[nodiscard]] std::span<const GPSReceiverDescriptor> gpsReceiverDescriptors();
[[nodiscard]] const GPSReceiverDescriptor* gpsReceiverDescriptor(GPSType type);
[[nodiscard]] const GPSReceiverDescriptor* gpsReceiverDescriptorForManufacturer(int manufacturer);
 
[[nodiscard]] std::optional<GPSType> gpsReceiverTypeForManufacturer(int manufacturer);
[[nodiscard]] int gpsReceiverManufacturerForType(GPSType type);
 
[[nodiscard]] GPSReceiverCapabilities gpsReceiverCapabilities(GPSType type);
 
[[nodiscard]] QString gpsReceiverName(GPSType type);
 
[[nodiscard]] QString gpsInputProtocolName(GPSType type);
 
struct GPSReceiverPresentation
{
    Q_GADGET
    Q_PROPERTY(bool specificReceiver MEMBER specificReceiver FINAL)
    Q_PROPERTY(bool automatic MEMBER automatic FINAL)
    Q_PROPERTY(bool rtkBase MEMBER rtkBase FINAL)
    Q_PROPERTY(bool surveyIn MEMBER surveyIn FINAL)
    Q_PROPERTY(bool receiverAveraging MEMBER receiverAveraging FINAL)
    Q_PROPERTY(bool compactObservations MEMBER compactObservations FINAL)
    Q_PROPERTY(bool passive MEMBER passive FINAL)
    Q_PROPERTY(bool surveyAccuracy MEMBER surveyAccuracy FINAL)
    Q_PROPERTY(bool surveyDuration MEMBER surveyDuration FINAL)
    Q_PROPERTY(bool fixedBaseAccuracy MEMBER fixedBaseAccuracy FINAL)
    Q_PROPERTY(bool observationAccuracyFilter MEMBER observationAccuracyFilter FINAL)
    Q_PROPERTY(bool acceptedObservationTime MEMBER acceptedObservationTime FINAL)
    Q_PROPERTY(bool reportsSurveyDuration MEMBER reportsSurveyDuration FINAL)
    Q_PROPERTY(bool persistentConfiguration MEMBER persistentConfiguration FINAL)
    Q_PROPERTY(bool restartOnConnect MEMBER restartOnConnect FINAL)
    Q_PROPERTY(bool surveyMaySavePosition MEMBER surveyMaySavePosition FINAL)
 
public:
    bool specificReceiver = false;
    bool automatic = false;
    bool rtkBase = false;
    bool surveyIn = false;
    bool receiverAveraging = false;
    bool compactObservations = false;
    bool passive = false;
    bool surveyAccuracy = false;
    bool surveyDuration = false;
    bool fixedBaseAccuracy = false;
    bool observationAccuracyFilter = false;
    bool acceptedObservationTime = false;
    bool reportsSurveyDuration = false;
    bool persistentConfiguration = false;
    bool restartOnConnect = false;
    bool surveyMaySavePosition = false;
 
    bool operator==(const GPSReceiverPresentation&) const = default;
};
 
[[nodiscard]] const GPSReceiverPresentation& gpsReceiverPresentation(int manufacturer);