MissionCommandUIInfo.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QLoggingCategory>
#include <QtCore/QString>
#include <QtCore/QVariant>
 
#include "QGCMAVLink.h"
 
Q_DECLARE_LOGGING_CATEGORY(MissionCommandsLog)
 
class MissionCommandTree;
class MissionCommandUIInfo;
#ifdef QGC_UNITTEST_BUILD
class MissionCommandTreeTest;
#endif
 
 
class MissionCmdParamInfo : public QObject {
 
    Q_OBJECT
 
public:
    MissionCmdParamInfo(QObject* parent = nullptr);
 
    MissionCmdParamInfo(const MissionCmdParamInfo& other, QObject* parent = nullptr);
    const MissionCmdParamInfo& operator=(const MissionCmdParamInfo& other);
 
    Q_PROPERTY(int          decimalPlaces   READ decimalPlaces  CONSTANT)
    Q_PROPERTY(double       defaultValue    READ defaultValue   CONSTANT)
    Q_PROPERTY(QStringList  enumStrings     READ enumStrings    CONSTANT)
    Q_PROPERTY(QVariantList enumValues      READ enumValues     CONSTANT)
    Q_PROPERTY(QString      label           READ label          CONSTANT)
    Q_PROPERTY(int          param           READ param          CONSTANT)
    Q_PROPERTY(QString      units           READ units          CONSTANT)
    Q_PROPERTY(bool         nanUnchanged    READ nanUnchanged   CONSTANT)
    Q_PROPERTY(double       min             READ min            CONSTANT)
    Q_PROPERTY(double       max             READ max            CONSTANT)
    Q_PROPERTY(double       userMin         READ userMin        CONSTANT)
    Q_PROPERTY(double       userMax         READ userMax        CONSTANT)
    Q_PROPERTY(bool         advanced        READ advanced       CONSTANT)
 
    int             decimalPlaces   (void) const { return _decimalPlaces; }
    double          defaultValue    (void) const { return _defaultValue; }
    QStringList     enumStrings     (void) const { return _enumStrings; }
    QVariantList    enumValues      (void) const { return _enumValues; }
    QString         label           (void) const { return _label; }
    int             param           (void) const { return _param; }
    QString         units           (void) const { return _units; }
    bool            nanUnchanged    (void) const { return _nanUnchanged; }
    double          min             (void) const { return _min; }
    double          max             (void) const { return _max; }
    double          userMin         (void) const { return _userMin; }
    double          userMax         (void) const { return _userMax; }
    bool            advanced        (void) const { return _advanced; }
 
private:
    int             _decimalPlaces;
    double          _defaultValue;
    QStringList     _enumStrings;
    QVariantList    _enumValues;
    QString         _label;
    int             _param;
    QString         _units;
    bool            _nanUnchanged;
    bool            _advanced;
    double          _min;
    double          _max;
    double          _userMin;
    double          _userMax;
 
    friend class MissionCommandTree;
    friend class MissionCommandUIInfo;
};
 
class MissionCommandUIInfo : public QObject {
    Q_OBJECT
 
public:
    MissionCommandUIInfo(QObject* parent = nullptr);
 
    MissionCommandUIInfo(const MissionCommandUIInfo& other, QObject* parent = nullptr);
    const MissionCommandUIInfo& operator=(const MissionCommandUIInfo& other);
 
    Q_PROPERTY(QString  category                READ category               CONSTANT)
    Q_PROPERTY(QString  description             READ description            CONSTANT)
    Q_PROPERTY(bool     friendlyEdit            READ friendlyEdit           CONSTANT)
    Q_PROPERTY(QString  friendlyName            READ friendlyName           CONSTANT)
    Q_PROPERTY(QString  rawName                 READ rawName                CONSTANT)
    Q_PROPERTY(bool     isStandaloneCoordinate  READ isStandaloneCoordinate CONSTANT)
    Q_PROPERTY(bool     specifiesCoordinate     READ specifiesCoordinate    CONSTANT)
    Q_PROPERTY(bool     specifiesAltitudeOnly   READ specifiesAltitudeOnly  CONSTANT)
    Q_PROPERTY(bool     isLandCommand           READ isLandCommand          CONSTANT)
    Q_PROPERTY(bool     isTakeoffCommand        READ isTakeoffCommand       CONSTANT)
    Q_PROPERTY(bool     isLoiterCommand         READ isLoiterCommand        CONSTANT)
    Q_PROPERTY(int      command                 READ intCommand             CONSTANT)
 
    MAV_CMD command(void) const { return _command; }
    int     intCommand(void) const { return (int)_command; }
 
    QString category                (void) const;
    QString description             (void) const;
    bool    friendlyEdit            (void) const;
    QString friendlyName            (void) const;
    QString rawName                 (void) const;
    bool    isStandaloneCoordinate  (void) const;
    bool    specifiesCoordinate     (void) const;
    bool    specifiesAltitudeOnly   (void) const;
    bool    isLandCommand           (void) const;
    bool    isTakeoffCommand        (void) const;
    bool    isLoiterCommand         (void) const;
 
    bool loadJsonInfo(const QJsonObject& jsonObject, bool requireFullObject, QString& errorString);
 
    const MissionCmdParamInfo* getParamInfo(int index, bool& showUI) const;
 
private:
    QString _loadErrorString(const QString& errorString) const;
 
    bool _infoAvailable(const QString& key) const { return _infoMap.contains(key); }
 
    const QVariant _infoValue(const QString& key) const { return _infoMap[key]; }
 
    void _setInfoValue(const QString& key, const QVariant& value) { _infoMap[key] = value; }
 
    void _overrideInfo(MissionCommandUIInfo* uiInfo);
 
    MAV_CMD                         _command;
    QMap<QString, QVariant>         _infoMap;
    QMap<int, MissionCmdParamInfo*> _paramInfoMap;
    QList<int>                      _paramRemoveList;
 
    static constexpr const char* _categoryJsonKey              = "category";
    static constexpr const char* _decimalPlacesJsonKey         = "decimalPlaces";
    static constexpr const char* _defaultJsonKey               = "default";
    static constexpr const char* _descriptionJsonKey           = "description";
    static constexpr const char* _enumStringsJsonKey           = "enumStrings";
    static constexpr const char* _enumValuesJsonKey            = "enumValues";
    static constexpr const char* _nanUnchangedJsonKey          = "nanUnchanged";
    static constexpr const char* _advancedJsonKey              = "advanced";
    static constexpr const char* _friendlyEditJsonKey          = "friendlyEdit";
    static constexpr const char* _friendlyNameJsonKey          = "friendlyName";
    static constexpr const char* _idJsonKey                    = "id";
    static constexpr const char* _labelJsonKey                 = "label";
    static constexpr const char* _mavCmdInfoJsonKey            = "mavCmdInfo";
    static constexpr const char* _maxJsonKey                   = "max";
    static constexpr const char* _minJsonKey                   = "min";
    static constexpr const char* _userMaxJsonKey               = "userMax";
    static constexpr const char* _userMinJsonKey               = "userMin";
    static constexpr const char* _param1JsonKey                = "param1";
    static constexpr const char* _param2JsonKey                = "param2";
    static constexpr const char* _param3JsonKey                = "param3";
    static constexpr const char* _param4JsonKey                = "param4";
    static constexpr const char* _param5JsonKey                = "param5";
    static constexpr const char* _param6JsonKey                = "param6";
    static constexpr const char* _param7JsonKey                = "param7";
    static constexpr const char* _paramJsonKeyFormat           = "param%1";
    static constexpr const char* _paramRemoveJsonKey           = "paramRemove";
    static constexpr const char* _rawNameJsonKey               = "rawName";
    static constexpr const char* _standaloneCoordinateJsonKey  = "standaloneCoordinate";
    static constexpr const char* _specifiesCoordinateJsonKey   = "specifiesCoordinate";
    static constexpr const char* _specifiesAltitudeOnlyJsonKey = "specifiesAltitudeOnly";
    static constexpr const char* _isLandCommandJsonKey         = "isLandCommand";
    static constexpr const char* _isTakeoffCommandJsonKey      = "isTakeoffCommand";
    static constexpr const char* _isLoiterCommandJsonKey       = "isLoiterCommand";
    static constexpr const char* _unitsJsonKey                 = "units";
    static constexpr const char* _commentJsonKey               = "comment";
    static constexpr const char* _advancedCategory             = "Advanced";
 
    friend class MissionCommandTree;
#ifdef QGC_UNITTEST_BUILD
    friend class MissionCommandTreeTest;
#endif
};