LinkConfiguration.h 5.98 KB
Newer Older
1 2 3 4
/*=====================================================================

QGroundControl Open Source Ground Control Station

5
(c) 2009, 2015 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

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/>.

======================================================================*/

#ifndef LINKCONFIGURATION_H
#define LINKCONFIGURATION_H

#include <QSettings>

class LinkInterface;

/// Interface holding link specific settings.

class LinkConfiguration
{
public:
    LinkConfiguration(const QString& name);
    LinkConfiguration(LinkConfiguration* copy);
    virtual ~LinkConfiguration() {}

    ///  The link types supported by QGC
    enum {
dogmaphobic's avatar
dogmaphobic committed
42
#ifndef __ios__
43
        TypeSerial,     ///< Serial Link
dogmaphobic's avatar
dogmaphobic committed
44
#endif
45
        TypeUdp,        ///< UDP Link
46
        TypeTcp,        ///< TCP Link
47 48 49 50 51
        // TODO Below is not yet implemented
#if 0
        TypeForwarding, ///< Forwarding Link
        TypeXbee,       ///< XBee Proprietary Link
        TypeOpal,       ///< Opal-RT Link
52 53
#endif
        TypeMock,       ///< Mock Link for Unitesting
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
        TypeLast        // Last type value (type >= TypeLast == invalid)
    };

    /*!
     * @brief Get configuration name
     *
     * This is the user friendly name shown in the connection drop down box and the name used to save the configuration in the settings.
     * @return The name of this link.
     */
    const QString name()  { return _name; }

    /*!
     * @brief Set the name of this link configuration.
     *
     * This is the user friendly name shown in the connection drop down box and the name used to save the configuration in the settings.
     * @param[in] name The configuration name
     */
    void setName(const QString name)  {_name = name; }

    /*!
     * @brief Set the link this configuration is currently attched to.
     *
     * @param[in] link The pointer to the current LinkInterface instance (if any)
     */
    void setLink(LinkInterface* link) { _link = link; }

    /*!
     * @brief Get the link this configuration is currently attched to.
     *
     * @return The pointer to the current LinkInterface instance (if any)
     */
    LinkInterface* getLink() { return _link; }

    /*!
     *
     * Is this a preferred configuration? (decided at runtime)
     * @return True if this is a known configuration (PX4, etc.)
     */
    bool isPreferred() { return _preferred; }

    /*!
     * Set if this is this a preferred configuration. (decided at runtime)
    */
    void setPreferred(bool preferred = true) { _preferred = preferred; }

dogmaphobic's avatar
dogmaphobic committed
99 100 101 102 103 104 105 106 107 108 109 110
    /*!
     *
     * Is this a dynamic configuration? (non persistent)
     * @return True if this is an automatically added configuration.
     */
    bool isDynamic() { return _dynamic; }

    /*!
     * Set if this is this a dynamic configuration. (decided at runtime)
    */
    void setDynamic(bool dynamic = true) { _dynamic = dynamic; }

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 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
    /// Virtual Methods

    /*!
     * @brief Connection type
     *
     * Pure virtual method returning one of the -TypeXxx types above.
     * @return The type of links these settings belong to.
     */
    virtual int type() = 0;

    /*!
     * @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;

    /*!
     * @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);

protected:
    LinkInterface* _link; ///< Link currently using this configuration (if any)
private:
    QString _name;
    bool    _preferred;  ///< Determined internally if this is a preferred connection. It comes up first in the drop down box.
dogmaphobic's avatar
dogmaphobic committed
185
    bool    _dynamic;    ///< A connection added automatically and not persistent (unless it's edited).
186 187 188
};

#endif // LINKCONFIGURATION_H