VehicleComponent.h 3.15 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*=====================================================================
 
 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/>.
 
 ======================================================================*/

Don Gagne's avatar
Don Gagne committed
24 25 26
/// @file
///     @author Don Gagne <don@thegagnes.com>

27 28 29 30
#ifndef VEHICLECOMPONENT_H
#define VEHICLECOMPONENT_H

#include <QObject>
31 32
#include <QQmlContext>
#include <QQuickItem>
33

34
#include "Vehicle.h"
35

Don Gagne's avatar
Don Gagne committed
36 37 38 39
class AutoPilotPlugin;

/// A vehicle component is an object which abstracts the physical portion of a vehicle into a set of
/// configurable values and user interface.
40 41 42 43

class VehicleComponent : public QObject
{
    Q_OBJECT
44
    
45 46 47 48
    Q_PROPERTY(QString name READ name CONSTANT)
    Q_PROPERTY(QString description READ description CONSTANT)
    Q_PROPERTY(bool requiresSetup READ requiresSetup CONSTANT)
    Q_PROPERTY(bool setupComplete READ setupComplete STORED false NOTIFY setupCompleteChanged)
49
    Q_PROPERTY(QString iconResource READ iconResource CONSTANT)
50
    Q_PROPERTY(QUrl setupSource READ setupSource CONSTANT)
Nate Weibley's avatar
Nate Weibley committed
51
    Q_PROPERTY(QUrl summaryQmlSource READ summaryQmlSource CONSTANT)
52
    Q_PROPERTY(QString prerequisiteSetup READ prerequisiteSetup)
53 54
    
public:
55
    VehicleComponent(Vehicle* vehicle, AutoPilotPlugin* autopilot, QObject* parent = NULL);
56 57 58 59
    ~VehicleComponent();
    
    virtual QString name(void) const = 0;
    virtual QString description(void) const = 0;
60
    virtual QString iconResource(void) const = 0;
61 62
    virtual bool requiresSetup(void) const = 0;
    virtual bool setupComplete(void) const = 0;
63
    virtual QUrl setupSource(void) const = 0;
64
    virtual QUrl summaryQmlSource(void) const = 0;
65
    virtual QString prerequisiteSetup(void) const = 0;
66 67
    
    virtual void addSummaryQmlComponent(QQmlContext* context, QQuickItem* parent);
68
    
69 70 71 72 73 74 75 76
    /// @brief Returns an list of parameter names for which a change should cause the setupCompleteChanged
    ///         signal to be emitted. Last element is signalled by NULL.
    virtual QStringList setupCompleteChangedTriggerList(void) const = 0;

    /// Should be called after the component is created (but not in constructor) to setup the
    /// signals which are used to track parameter changes which affect setupComplete state.
    virtual void setupTriggerSignals(void);

77
signals:
78
    void setupCompleteChanged(bool setupComplete);
79 80 81 82

protected slots:
    void _triggerUpdated(QVariant value);

83
protected:
84 85
    Vehicle*            _vehicle;
    AutoPilotPlugin*    _autopilot;
86 87 88
};

#endif