MissionItem.h 11.9 KB
Newer Older
pixhawk's avatar
pixhawk committed
1
/*=====================================================================
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 
 QGroundControl Open Source Ground Control Station
 
 (c) 2009 - 2014 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 
 This file is part of the QGROUNDCONTROL project
 
 QGROUNDCONTROL 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 3 of the License, or
 (at your option) any later version.
 
 QGROUNDCONTROL is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
 
 ======================================================================*/
pixhawk's avatar
pixhawk committed
23

24 25
#ifndef MissionItem_H
#define MissionItem_H
pixhawk's avatar
pixhawk committed
26 27 28

#include <QObject>
#include <QString>
29
#include <QtQml>
30
#include <QTextStream>
31 32
#include <QGeoCoordinate>

lm's avatar
lm committed
33
#include "QGCMAVLink.h"
lm's avatar
lm committed
34
#include "QGC.h"
35
#include "MavlinkQmlSingleton.h"
Don Gagne's avatar
Don Gagne committed
36 37
#include "QmlObjectListModel.h"
#include "Fact.h"
Don Gagne's avatar
Don Gagne committed
38
#include "QGCLoggingCategory.h"
Don Gagne's avatar
Don Gagne committed
39
#include "QmlObjectListModel.h"
Don Gagne's avatar
Don Gagne committed
40 41

Q_DECLARE_LOGGING_CATEGORY(MissionItemLog)
pixhawk's avatar
pixhawk committed
42

43
class MissionItem : public QObject
pixhawk's avatar
pixhawk committed
44 45
{
    Q_OBJECT
46
    
pixhawk's avatar
pixhawk committed
47
public:
Don Gagne's avatar
Don Gagne committed
48 49 50
    MissionItem(QObject         *parent = 0,
                int             sequenceNumber = 0,
                QGeoCoordinate  coordiante = QGeoCoordinate(),
Don Gagne's avatar
Don Gagne committed
51
                int             action = MAV_CMD_NAV_WAYPOINT,
Don Gagne's avatar
Don Gagne committed
52
                double          param1 = 0.0,
53 54 55
                double          param2 = defaultAcceptanceRadius,
                double          param3 = defaultLoiterOrbitRadius,
                double          param4 = defaultHeading,
Don Gagne's avatar
Don Gagne committed
56 57
                bool            autocontinue = true,
                bool            isCurrentItem = false,
Don Gagne's avatar
Don Gagne committed
58
                int             frame = MAV_FRAME_GLOBAL_RELATIVE_ALT);
59

Don Gagne's avatar
Don Gagne committed
60
    MissionItem(const MissionItem& other, QObject* parent = NULL);
61
    ~MissionItem();
pixhawk's avatar
pixhawk committed
62

63 64
    const MissionItem& operator=(const MissionItem& other);
    
Don Gagne's avatar
Don Gagne committed
65 66 67
    /// Returns true if the item has been modified since the last time dirty was false
    Q_PROPERTY(bool                 dirty               READ dirty                  WRITE setDirty          NOTIFY dirtyChanged)
    
Don Gagne's avatar
Don Gagne committed
68 69
    Q_PROPERTY(int                  sequenceNumber      READ sequenceNumber         WRITE setSequenceNumber NOTIFY sequenceNumberChanged)
    Q_PROPERTY(bool                 isCurrentItem       READ isCurrentItem          WRITE setIsCurrentItem  NOTIFY isCurrentItemChanged)
70

71
    Q_PROPERTY(bool                 specifiesCoordinate READ specifiesCoordinate                            NOTIFY commandChanged)
Don Gagne's avatar
Don Gagne committed
72
    Q_PROPERTY(QGeoCoordinate       coordinate          READ coordinate             WRITE setCoordinate     NOTIFY coordinateChanged)
73 74 75 76

    Q_PROPERTY(bool                 specifiesHeading    READ specifiesHeading                               NOTIFY commandChanged)
    Q_PROPERTY(double               heading             READ headingDegrees         WRITE setHeadingDegrees NOTIFY headingDegreesChanged)

Don Gagne's avatar
Don Gagne committed
77 78
    Q_PROPERTY(QStringList          commandNames        READ commandNames                                   CONSTANT)
    Q_PROPERTY(QString              commandName         READ commandName                                    NOTIFY commandChanged)
79
    Q_PROPERTY(QString              commandDescription  READ commandDescription                             NOTIFY commandChanged)
Don Gagne's avatar
Don Gagne committed
80 81 82
    Q_PROPERTY(QStringList          valueLabels         READ valueLabels                                    NOTIFY commandChanged)
    Q_PROPERTY(QStringList          valueStrings        READ valueStrings                                   NOTIFY valueStringsChanged)
    Q_PROPERTY(int                  commandByIndex      READ commandByIndex         WRITE setCommandByIndex NOTIFY commandChanged)
83 84
    Q_PROPERTY(QmlObjectListModel*  textFieldFacts      READ textFieldFacts                                 NOTIFY commandChanged)
    Q_PROPERTY(QmlObjectListModel*  checkboxFacts       READ checkboxFacts                                  NOTIFY commandChanged)
Don Gagne's avatar
Don Gagne committed
85
    Q_PROPERTY(MavlinkQmlSingleton::Qml_MAV_CMD command READ command                WRITE setCommand        NOTIFY commandChanged)
Don Gagne's avatar
Don Gagne committed
86
    Q_PROPERTY(QmlObjectListModel*  childItems          READ childItems                                     CONSTANT)
87 88 89

    /// true: this item is being used as a home position indicator
    Q_PROPERTY(bool                 homePosition        MEMBER _homePositionSpecialCase                     CONSTANT)
Don Gagne's avatar
Don Gagne committed
90
    
91 92 93
    /// true: home position should be shown
    Q_PROPERTY(bool                 homePositionValid   READ homePositionValid      WRITE setHomePositionValid NOTIFY homePositionValidChanged)

Don Gagne's avatar
Don Gagne committed
94 95 96 97 98 99 100
    // Property accesors
    
    int sequenceNumber(void) const { return _sequenceNumber; }
    void setSequenceNumber(int sequenceNumber);
    
    bool isCurrentItem(void) const { return _isCurrentItem; }
    void setIsCurrentItem(bool isCurrentItem);
101
    
Don Gagne's avatar
Don Gagne committed
102
    bool specifiesCoordinate(void) const;
103
    QGeoCoordinate coordinate(void) const;
Don Gagne's avatar
Don Gagne committed
104 105
    void setCoordinate(const QGeoCoordinate& coordinate);
    
106 107 108 109
    bool specifiesHeading(void) const;
    double headingDegrees(void) const;
    void setHeadingDegrees(double headingDegrees);

Don Gagne's avatar
Don Gagne committed
110 111 112
    // This is public for unit testing
    double _yawRadians(void) const;

Don Gagne's avatar
Don Gagne committed
113 114
    QStringList commandNames(void);
    QString commandName(void);
115
    QString commandDescription(void);
116

Don Gagne's avatar
Don Gagne committed
117 118 119
    int commandByIndex(void);
    void setCommandByIndex(int index);
    
Don Gagne's avatar
Don Gagne committed
120
    MavlinkQmlSingleton::Qml_MAV_CMD command(void) { return (MavlinkQmlSingleton::Qml_MAV_CMD)_command; };
Don Gagne's avatar
Don Gagne committed
121 122 123 124 125
    void setCommand(MavlinkQmlSingleton::Qml_MAV_CMD command) { setAction(command); }
    
    QStringList valueLabels(void);
    QStringList valueStrings(void);
    
126 127
    QmlObjectListModel* textFieldFacts(void);
    QmlObjectListModel* checkboxFacts(void);
Don Gagne's avatar
Don Gagne committed
128
    
Don Gagne's avatar
Don Gagne committed
129 130 131
    bool dirty(void) { return _dirty; }
    void setDirty(bool dirty);
    
Don Gagne's avatar
Don Gagne committed
132
    QmlObjectListModel* childItems(void) { return &_childItems; }
133 134 135

    bool homePositionValid(void) { return _homePositionValid; }
    void setHomePositionValid(bool homePositionValid);
Don Gagne's avatar
Don Gagne committed
136
    
Don Gagne's avatar
Don Gagne committed
137
    // C++ only methods
Don Gagne's avatar
Don Gagne committed
138 139 140
    
    /// Returns true if this item can be edited in the ui
    bool canEdit(void);
141

142 143 144
    double latitude(void)  const { return _latitudeFact->value().toDouble(); }
    double longitude(void) const { return _longitudeFact->value().toDouble(); }
    double altitude(void)  const { return _altitudeFact->value().toDouble(); }
Don Gagne's avatar
Don Gagne committed
145 146 147 148 149 150 151 152 153 154 155 156 157
    
    void setLatitude(double latitude);
    void setLongitude(double longitude);
    void setAltitude(double altitude);
    
    double x(void) const { return latitude(); }
    double y(void) const { return longitude(); }
    double z(void) const { return altitude(); }
    
    void setX(double x);
    void setY(double y);
    void setZ(double z);
    
Don Gagne's avatar
Don Gagne committed
158
    bool autoContinue() const {
159
        return _autocontinue;
160
    }
Don Gagne's avatar
Don Gagne committed
161 162
    double loiterOrbitRadius() const {
        return _loiterOrbitRadiusFact->value().toDouble();
163
    }
Don Gagne's avatar
Don Gagne committed
164 165
    double acceptanceRadius() const {
        return param2();
166
    }
Don Gagne's avatar
Don Gagne committed
167 168
    double holdTime() const {
        return param1();
169
    }
Don Gagne's avatar
Don Gagne committed
170
    double param1() const {
Don Gagne's avatar
Don Gagne committed
171
        return _param1Fact->value().toDouble();
172
    }
Don Gagne's avatar
Don Gagne committed
173
    double param2() const {
Don Gagne's avatar
Don Gagne committed
174
        return _param2Fact->value().toDouble();
175
    }
Don Gagne's avatar
Don Gagne committed
176
    double param3() const {
Don Gagne's avatar
Don Gagne committed
177
        return loiterOrbitRadius();
178
    }
Don Gagne's avatar
Don Gagne committed
179
    double param4() const {
180
        return _yawRadians();
181
    }
Don Gagne's avatar
Don Gagne committed
182
    double param5() const {
Don Gagne's avatar
Don Gagne committed
183
        return latitude();
184
    }
Don Gagne's avatar
Don Gagne committed
185
    double param6() const {
Don Gagne's avatar
Don Gagne committed
186
        return longitude();
187
    }
Don Gagne's avatar
Don Gagne committed
188
    double param7() const {
Don Gagne's avatar
Don Gagne committed
189
        return altitude();
190
    }
191
    // MAV_FRAME
192 193
    int frame() const;
    
194
    // MAV_CMD
Don Gagne's avatar
Don Gagne committed
195 196
    int command() const {
        return _command;
197
    }
lm's avatar
lm committed
198 199
    /** @brief Returns true if x, y, z contain reasonable navigation data */
    bool isNavigationType();
200

201
    /** @brief Get the time this waypoint was reached */
Don Gagne's avatar
Don Gagne committed
202
    quint64 reachedTime() const { return _reachedTime; }
203

204 205
    void save(QTextStream &saveStream);
    bool load(QTextStream &loadStream);
206
    
Don Gagne's avatar
Don Gagne committed
207
    void setHomePositionSpecialCase(bool homePositionSpecialCase) { _homePositionSpecialCase = homePositionSpecialCase; }
208 209 210 211 212 213 214 215

    static const double defaultPitch;
    static const double defaultHeading;
    static const double defaultAltitude;
    static const double defaultAcceptanceRadius;
    static const double defaultLoiterOrbitRadius;
    static const double defaultLoiterTurns;

Don Gagne's avatar
Don Gagne committed
216 217 218 219
signals:
    void sequenceNumberChanged(int sequenceNumber);
    void isCurrentItemChanged(bool isCurrentItem);
    void coordinateChanged(const QGeoCoordinate& coordinate);
220
    void headingDegreesChanged(double heading);
Don Gagne's avatar
Don Gagne committed
221
    void dirtyChanged(bool dirty);
222
    void homePositionValidChanged(bool homePostionValid);
Don Gagne's avatar
Don Gagne committed
223 224 225

    /** @brief Announces a change to the waypoint data */
    void changed(MissionItem* wp);
226

227
    
Don Gagne's avatar
Don Gagne committed
228 229 230 231
    void commandNameChanged(QString type);
    void commandChanged(MavlinkQmlSingleton::Qml_MAV_CMD command);
    void valueLabelsChanged(QStringList valueLabels);
    void valueStringsChanged(QStringList valueStrings);
232
    
233
public:
234
    /** @brief Set the waypoint action */
235 236
    void setAction      (int _action);
    void setFrame       (int _frame);
pixhawk's avatar
pixhawk committed
237
    void setAutocontinue(bool autoContinue);
238
    void setCurrent     (bool _current);
Don Gagne's avatar
Don Gagne committed
239
    void setLoiterOrbitRadius (double radius);
240 241 242 243 244 245 246
    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);
247
    void setAcceptanceRadius(double radius);
248 249
    void setHoldTime    (int holdTime);
    void setHoldTime    (double holdTime);
lm's avatar
lm committed
250
    /** @brief Set waypoint as reached */
251
    void setReached     () { _reachedTime = QGC::groundTimeMilliseconds(); }
lm's avatar
lm committed
252
    /** @brief Wether this waypoint has been reached yet */
253 254
    bool isReached      () { return (_reachedTime > 0); }

255 256 257
    void setChanged() {
        emit changed(this);
    }
Don Gagne's avatar
Don Gagne committed
258 259 260
    
private slots:
    void _factValueChanged(QVariant value);
261
    void _coordinateFactChanged(QVariant value);
262
    void _headingDegreesFactChanged(QVariant value);
263

264 265
private:
    QString _oneDecimalString(double value);
266 267
    void _connectSignals(void);
    void _setYawRadians(double yawRadians);
Don Gagne's avatar
Don Gagne committed
268 269 270 271 272 273 274

private:
    typedef struct {
        MAV_CMD     command;
        const char* name;
    } MavCmd2Name_t;
    
Don Gagne's avatar
Don Gagne committed
275 276 277 278 279 280
    int                                 _sequenceNumber;
    int                                 _frame;
    MavlinkQmlSingleton::Qml_MAV_CMD    _command;
    bool                                _autocontinue;
    bool                                _isCurrentItem;
    quint64                             _reachedTime;
Don Gagne's avatar
Don Gagne committed
281
    
282 283 284
    Fact*           _latitudeFact;
    Fact*           _longitudeFact;
    Fact*           _altitudeFact;
285
    Fact*           _headingDegreesFact;
Don Gagne's avatar
Don Gagne committed
286
    Fact*           _loiterOrbitRadiusFact;
Don Gagne's avatar
Don Gagne committed
287 288
    Fact*           _param1Fact;
    Fact*           _param2Fact;
289
    Fact*           _altitudeRelativeToHomeFact;
Don Gagne's avatar
Don Gagne committed
290 291 292 293 294 295 296 297 298 299
    
    FactMetaData*   _pitchMetaData;
    FactMetaData*   _acceptanceRadiusMetaData;
    FactMetaData*   _holdTimeMetaData;
    FactMetaData*   _loiterTurnsMetaData;
    FactMetaData*   _loiterSecondsMetaData;
    FactMetaData*   _delaySecondsMetaData;
    FactMetaData*   _jumpSequenceMetaData;
    FactMetaData*   _jumpRepeatMetaData;
    
Don Gagne's avatar
Don Gagne committed
300 301
    bool _dirty;
    
Don Gagne's avatar
Don Gagne committed
302
    bool _homePositionSpecialCase;  ///< true: this item is being used as a ui home position indicator
303
    bool _homePositionValid;        ///< true: home psition should be displayed
Don Gagne's avatar
Don Gagne committed
304 305 306 307
    
    /// This is used to reference any subsequent mission items which do not specify a coordinate.
    QmlObjectListModel  _childItems;
    
Don Gagne's avatar
Don Gagne committed
308 309
    static const int            _cMavCmd2Name = 9;
    static const MavCmd2Name_t  _rgMavCmd2Name[_cMavCmd2Name];
pixhawk's avatar
pixhawk committed
310 311
};

312 313 314
QDebug operator<<(QDebug dbg, const MissionItem& missionItem);
QDebug operator<<(QDebug dbg, const MissionItem* missionItem);

315
#endif