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

10
#pragma once
11 12 13 14 15 16 17

#include <QSettings>

class LinkInterface;

/// Interface holding link specific settings.

Don Gagne's avatar
Don Gagne committed
18
class LinkConfiguration : public QObject
19
{
Don Gagne's avatar
Don Gagne committed
20 21
    Q_OBJECT

22 23 24 25 26
public:
    LinkConfiguration(const QString& name);
    LinkConfiguration(LinkConfiguration* copy);
    virtual ~LinkConfiguration() {}

27
    Q_PROPERTY(QString          name                READ name           WRITE setName           NOTIFY nameChanged)
28
    Q_PROPERTY(LinkInterface*   link                READ link           WRITE setLink           NOTIFY linkChanged)
29
    Q_PROPERTY(LinkType         linkType            READ type                                   CONSTANT)
30 31 32
    Q_PROPERTY(bool             dynamic             READ isDynamic      WRITE setDynamic        NOTIFY dynamicChanged)
    Q_PROPERTY(bool             autoConnect         READ isAutoConnect  WRITE setAutoConnect    NOTIFY autoConnectChanged)
    Q_PROPERTY(bool             autoConnectAllowed  READ isAutoConnectAllowed                   CONSTANT)
33
    Q_PROPERTY(QString          settingsURL         READ settingsURL                            CONSTANT)
34
    Q_PROPERTY(QString          settingsTitle       READ settingsTitle                          CONSTANT)
35 36
    Q_PROPERTY(bool             highLatency         READ isHighLatency  WRITE setHighLatency    NOTIFY highLatencyChanged)
    Q_PROPERTY(bool             highLatencyAllowed  READ isHighLatencyAllowed                   CONSTANT)
Don Gagne's avatar
Don Gagne committed
37 38 39

    // Property accessors

40
    QString         name(void) const { return _name; }
Don Gagne's avatar
Don Gagne committed
41 42 43 44 45
    LinkInterface*  link(void)  { return _link; }

    void            setName(const QString name);
    void            setLink(LinkInterface* link);

46
    ///  The link types supported by QGC
dogmaphobic's avatar
dogmaphobic committed
47
    ///  Any changes here MUST be reflected in LinkManager::linkTypeStrings()
48
    enum LinkType {
Gus Grubba's avatar
Gus Grubba committed
49
#ifndef NO_SERIAL_LINK
50
        TypeSerial,     ///< Serial Link
dogmaphobic's avatar
dogmaphobic committed
51
#endif
52
        TypeUdp,        ///< UDP Link
53
        TypeTcp,        ///< TCP Link
dogmaphobic's avatar
dogmaphobic committed
54
#ifdef QGC_ENABLE_BLUETOOTH
dogmaphobic's avatar
dogmaphobic committed
55 56
        TypeBluetooth,  ///< Bluetooth Link
#endif
dogmaphobic's avatar
dogmaphobic committed
57
#ifdef QT_DEBUG
58
        TypeMock,       ///< Mock Link for Unitesting
dogmaphobic's avatar
dogmaphobic committed
59
#endif
Don Gagne's avatar
Don Gagne committed
60
        TypeLogReplay,
61 62
        TypeLast        // Last type value (type >= TypeLast == invalid)
    };
63
    Q_ENUM(LinkType)
64

dogmaphobic's avatar
dogmaphobic committed
65 66 67 68 69 70 71
    /*!
     *
     * Is this a dynamic configuration? (non persistent)
     * @return True if this is an automatically added configuration.
     */
    bool isDynamic() { return _dynamic; }

72 73 74 75 76 77 78
    /*!
     *
     * Is this an Auto Connect configuration?
     * @return True if this is an Auto Connect configuration (connects automatically at boot time).
     */
    bool isAutoConnect() { return _autoConnect; }

79 80 81 82 83 84 85
    /*!
     *
     * Is this a High Latency configuration?
     * @return True if this is an High Latency configuration (link with large delays).
     */
    bool isHighLatency() { return _highLatency; }

dogmaphobic's avatar
dogmaphobic committed
86 87 88
    /*!
     * Set if this is this a dynamic configuration. (decided at runtime)
    */
89 90 91 92 93 94
    void setDynamic(bool dynamic = true) { _dynamic = dynamic; emit dynamicChanged(); }

    /*!
     * Set if this is this an Auto Connect configuration.
    */
    void setAutoConnect(bool autoc = true) { _autoConnect = autoc; emit autoConnectChanged(); }
dogmaphobic's avatar
dogmaphobic committed
95

96 97 98 99 100
    /*!
     * Set if this is this an High Latency configuration.
    */
    void setHighLatency(bool hl = false) { _highLatency = hl; emit highLatencyChanged(); }

101 102
    /// Virtual Methods

103 104 105 106 107
    /*!
     *
     * Is Auto Connect allowed for this type?
     * @return True if this type can be set as an Auto Connect configuration
     */
108
    virtual bool isAutoConnectAllowed() { return false; }
109

110 111 112 113 114 115 116
    /*!
     *
     * Is High Latency allowed for this type?
     * @return True if this type can be set as an High Latency configuration
     */
    virtual bool isHighLatencyAllowed() { return false; }

117 118 119 120 121 122
    /*!
     * @brief Connection type
     *
     * Pure virtual method returning one of the -TypeXxx types above.
     * @return The type of links these settings belong to.
     */
123
    virtual LinkType type() = 0;
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142

    /*!
     * @brief Load settings
     *
     * Pure virtual method telling the instance to load its configuration.
     * @param[in] settings The QSettings instance to use
     * @param[in] root The root path of the setting.
     */
    virtual void loadSettings(QSettings& settings, const QString& root) = 0;

    /*!
     * @brief Save settings
     *
     * Pure virtual method telling the instance to save its configuration.
     * @param[in] settings The QSettings instance to use
     * @param[in] root The root path of the setting.
     */
    virtual void saveSettings(QSettings& settings, const QString& root) = 0;

143 144 145 146 147
    /*!
     * @brief Settings URL
     *
     * Pure virtual method providing the URL for the (QML) settings dialog
     */
148 149 150 151 152 153 154 155
    virtual QString settingsURL     () = 0;

    /*!
     * @brief Settings Title
     *
     * Pure virtual method providing the Title for the (QML) settings dialog
     */
    virtual QString settingsTitle   () = 0;
156

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
    /*!
     * @brief Update settings
     *
     * After editing the settings, use this method to tell the connected link (if any) to reload its configuration.
     */
    virtual void updateSettings() {}

    /*!
     * @brief Copy instance data
     *
     * When manipulating data, you create a copy of the configuration using the copy constructor,
     * edit it and then transfer its content to the original using this method.
     * @param[in] source The source instance (the edited copy)
     */
    virtual void copyFrom(LinkConfiguration* source);

    /// Helper static methods

    /*!
     * @brief Root path for QSettings
     *
     * @return The root path of the settings.
     */
    static const QString settingsRoot();

    /*!
     * @brief Create new link configuration instance
     *
     * Configuration Factory. Creates an appropriate configuration instance based on the given type.
     * @return A new instance of the given type
     */
    static LinkConfiguration* createSettings(int type, const QString& name);

    /*!
     * @brief Duplicate configuration instance
     *
     * Helper method to create a new instance copy for editing.
     * @return A new copy of the given settings instance
     */
    static LinkConfiguration* duplicateSettings(LinkConfiguration *source);

Don Gagne's avatar
Don Gagne committed
198
signals:
199 200 201
    void nameChanged        (const QString& name);
    void dynamicChanged     ();
    void autoConnectChanged ();
202
    void linkChanged        (LinkInterface* link);
203
    void highLatencyChanged ();
Don Gagne's avatar
Don Gagne committed
204

205 206 207 208
protected:
    LinkInterface* _link; ///< Link currently using this configuration (if any)
private:
    QString _name;
209 210
    bool    _dynamic;       ///< A connection added automatically and not persistent (unless it's edited).
    bool    _autoConnect;   ///< This connection is started automatically at boot
211
    bool    _highLatency;
212 213
};

214 215
typedef QSharedPointer<LinkConfiguration> SharedLinkConfigurationPointer;