VehicleComponent.h 2.85 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 35

#include "UASInterface.h"

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 49
    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)
    Q_PROPERTY(QString setupStateDescription READ setupStateDescription STORED false)
50
    Q_PROPERTY(QString iconResource READ iconResource CONSTANT)
51
    Q_PROPERTY(QUrl setupSource READ setupSource CONSTANT)
Nate Weibley's avatar
Nate Weibley committed
52
    Q_PROPERTY(QUrl summaryQmlSource READ summaryQmlSource CONSTANT)
53
    Q_PROPERTY(QString prerequisiteSetup READ prerequisiteSetup)
54 55
    
public:
Don Gagne's avatar
Don Gagne committed
56
    VehicleComponent(UASInterface* uas, AutoPilotPlugin* autopilot, QObject* parent = NULL);
57 58 59 60
    ~VehicleComponent();
    
    virtual QString name(void) const = 0;
    virtual QString description(void) const = 0;
61
    virtual QString iconResource(void) const = 0;
62 63 64
    virtual bool requiresSetup(void) const = 0;
    virtual bool setupComplete(void) const = 0;
    virtual QString setupStateDescription(void) const = 0;
65
    virtual QUrl setupSource(void) const = 0;
66
    virtual QStringList paramFilterList(void) const = 0;
67
    virtual QUrl summaryQmlSource(void) const = 0;
68
    virtual QString prerequisiteSetup(void) const = 0;
69 70
    
    virtual void addSummaryQmlComponent(QQmlContext* context, QQuickItem* parent);
71 72
    
signals:
73
    void setupCompleteChanged(bool setupComplete);
74 75 76
    
protected:
    UASInterface*                   _uas;
Don Gagne's avatar
Don Gagne committed
77
    AutoPilotPlugin*                _autopilot;
78 79 80
};

#endif