MissionItem.h 5.67 KB
Newer Older
1 2 3 4 5 6 7 8 9
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

10 11 12 13 14 15 16 17

#ifndef MissionItem_H
#define MissionItem_H

#include <QObject>
#include <QString>
#include <QtQml>
#include <QTextStream>
18
#include <QJsonObject>
19 20 21 22 23 24 25 26 27
#include <QGeoCoordinate>

#include "QGCMAVLink.h"
#include "QGC.h"
#include "QmlObjectListModel.h"
#include "Fact.h"
#include "QGCLoggingCategory.h"
#include "QmlObjectListModel.h"

28
class SurveyComplexItem;
29 30 31 32 33 34 35
class SimpleMissionItem;
class MissionController;
#ifdef UNITTEST_BUILD
    class MissionItemTest;
#endif

// Represents a Mavlink mission command.
36 37 38 39 40
class MissionItem : public QObject
{
    Q_OBJECT
    
public:
41
    MissionItem(QObject* parent = nullptr);
42

43
    MissionItem(int             sequenceNumber,
44 45 46 47 48 49 50 51 52 53 54
                MAV_CMD         command,
                MAV_FRAME       frame,
                double          param1,
                double          param2,
                double          param3,
                double          param4,
                double          param5,
                double          param6,
                double          param7,
                bool            autoContinue,
                bool            isCurrentItem,
55
                QObject*        parent = nullptr);
56

57
    MissionItem(const MissionItem& other, QObject* parent = nullptr);
58 59 60 61 62

    ~MissionItem();

    const MissionItem& operator=(const MissionItem& other);
    
63 64 65 66 67 68 69 70 71 72 73 74 75
    MAV_CMD         command         (void) const { return (MAV_CMD)_commandFact.rawValue().toInt(); }
    bool            isCurrentItem   (void) const { return _isCurrentItem; }
    int             sequenceNumber  (void) const { return _sequenceNumber; }
    MAV_FRAME       frame           (void) const { return (MAV_FRAME)_frameFact.rawValue().toInt(); }
    bool            autoContinue    (void) const { return _autoContinueFact.rawValue().toBool(); }
    double          param1          (void) const { return _param1Fact.rawValue().toDouble(); }
    double          param2          (void) const { return _param2Fact.rawValue().toDouble(); }
    double          param3          (void) const { return _param3Fact.rawValue().toDouble(); }
    double          param4          (void) const { return _param4Fact.rawValue().toDouble(); }
    double          param5          (void) const { return _param5Fact.rawValue().toDouble(); }
    double          param6          (void) const { return _param6Fact.rawValue().toDouble(); }
    double          param7          (void) const { return _param7Fact.rawValue().toDouble(); }
    QGeoCoordinate  coordinate      (void) const;
Don Gagne's avatar
Don Gagne committed
76
    int             doJumpId        (void) const { return _doJumpId; }
77

78
    /// @return Flight speed change value if this item supports it. If not it returns NaN.
DonLakeFlyer's avatar
DonLakeFlyer committed
79 80 81 82
    double specifiedFlightSpeed(void) const;

    /// @return Flight gimbal yaw change value if this item supports it. If not it returns NaN.
    double specifiedGimbalYaw(void) const;
83

84 85 86
    /// @return Flight gimbal pitch change value if this item supports it. If not it returns NaN.
    double specifiedGimbalPitch(void) const;

87 88 89 90 91 92 93 94 95 96 97 98
    void setCommand         (MAV_CMD command);
    void setSequenceNumber  (int sequenceNumber);
    void setIsCurrentItem   (bool isCurrentItem);
    void setFrame           (MAV_FRAME frame);
    void setAutoContinue    (bool autoContinue);
    void setParam1          (double param1);
    void setParam2          (double param2);
    void setParam3          (double param3);
    void setParam4          (double param4);
    void setParam5          (double param5);
    void setParam6          (double param6);
    void setParam7          (double param7);
99
    
100
    void save(QJsonObject& json) const;
101
    bool load(QTextStream &loadStream);
Don Gagne's avatar
Don Gagne committed
102
    bool load(const QJsonObject& json, int sequenceNumber, QString& errorString);
103

104
    bool relativeAltitude(void) const { return frame() == MAV_FRAME_GLOBAL_RELATIVE_ALT; }
Don Gagne's avatar
Don Gagne committed
105

106
signals:
DonLakeFlyer's avatar
DonLakeFlyer committed
107 108 109 110
    void isCurrentItemChanged       (bool isCurrentItem);
    void sequenceNumberChanged      (int sequenceNumber);
    void specifiedFlightSpeedChanged(double flightSpeed);
    void specifiedGimbalYawChanged  (double gimbalYaw);
111
    void specifiedGimbalPitchChanged(double gimbalPitch);
112 113

private slots:
114 115 116
    void _param1Changed(QVariant value);
    void _param2Changed(QVariant value);
    void _param3Changed(QVariant value);
DonLakeFlyer's avatar
DonLakeFlyer committed
117

118
private:
Don Gagne's avatar
Don Gagne committed
119
    bool _convertJsonV1ToV2(const QJsonObject& json, QJsonObject& v2Json, QString& errorString);
120
    bool _convertJsonV2ToV3(QJsonObject& json, QString& errorString);
Don Gagne's avatar
Don Gagne committed
121 122 123 124

    int     _sequenceNumber;
    int     _doJumpId;
    bool    _isCurrentItem;
125 126 127 128 129 130 131 132 133 134 135 136

    Fact    _autoContinueFact;
    Fact    _commandFact;
    Fact    _frameFact;
    Fact    _param1Fact;
    Fact    _param2Fact;
    Fact    _param3Fact;
    Fact    _param4Fact;
    Fact    _param5Fact;
    Fact    _param6Fact;
    Fact    _param7Fact;
    
137
    // Keys for Json save
138 139
    static const char*  _jsonFrameKey;
    static const char*  _jsonCommandKey;
Don Gagne's avatar
Don Gagne committed
140 141 142 143
    static const char*  _jsonAutoContinueKey;
    static const char*  _jsonParamsKey;
    static const char*  _jsonDoJumpIdKey;

144 145 146
    // Deprecated V2 format keys
    static const char*  _jsonCoordinateKey;

Don Gagne's avatar
Don Gagne committed
147
    // Deprecated V1 format keys
148 149 150 151
    static const char*  _jsonParam1Key;
    static const char*  _jsonParam2Key;
    static const char*  _jsonParam3Key;
    static const char*  _jsonParam4Key;
152

153
    friend class SurveyComplexItem;
154 155 156 157 158
    friend class SimpleMissionItem;
    friend class MissionController;
#ifdef UNITTEST_BUILD
    friend class MissionItemTest;
#endif
159 160 161
};

#endif