VehicleComponent.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QObject>
#include <QtCore/QStringList>
#include <QtCore/QUrl>
#include <QtCore/QVariant>
#include <QtQmlIntegration/QtQmlIntegration>
 
#include "AutoPilotPlugin.h"
 
class Vehicle;
class QQuickItem;
class QQmlContext;
 
 
class VehicleComponent : public QObject
{
    Q_OBJECT
    QML_ELEMENT
    QML_UNCREATABLE("")
 
    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  iconResource                                        READ iconResource           CONSTANT)
    Q_PROPERTY(QUrl     setupSource                                         READ setupSource            NOTIFY setupSourceChanged)
    Q_PROPERTY(QUrl     summaryQmlSource                                    READ summaryQmlSource       CONSTANT)
    Q_PROPERTY(bool     allowSetupWhileArmed                                READ allowSetupWhileArmed   CONSTANT)
    Q_PROPERTY(bool     allowSetupWhileFlying                               READ allowSetupWhileFlying  CONSTANT)
    Q_PROPERTY(AutoPilotPlugin::KnownVehicleComponent KnownVehicleComponent READ KnownVehicleComponent  CONSTANT)
    Q_PROPERTY(QStringList sections                                         READ sections               NOTIFY sectionsChanged)
    Q_PROPERTY(QVariantMap sectionKeywords                                   READ sectionKeywords        NOTIFY sectionsChanged)
    Q_PROPERTY(QString  vehicleConfigJson                                   READ vehicleConfigJson      CONSTANT)
    Q_PROPERTY(bool     showFirstSectionOnRootClick                         READ showFirstSectionOnRootClick CONSTANT)
 
public:
    explicit VehicleComponent(Vehicle *vehicle, AutoPilotPlugin *autopilot, AutoPilotPlugin::KnownVehicleComponent KnownVehicleComponent, QObject *parent = nullptr);
    virtual ~VehicleComponent();
 
    virtual QString name() const = 0;
    virtual QString description() const { return QString(); }
    virtual QString iconResource() const = 0;
    virtual bool requiresSetup() const = 0;
    virtual bool setupComplete() const = 0;
    virtual QUrl setupSource() const = 0;
    virtual QUrl summaryQmlSource() const = 0;
 
    virtual QString vehicleConfigJson() const { return QString(); }
 
    virtual QStringList sections() const;
 
    QVariantMap sectionKeywords() const;
 
    virtual bool showFirstSectionOnRootClick() const { return false; }
 
    Q_INVOKABLE virtual bool sectionSetupComplete(const QString &sectionName) const { Q_UNUSED(sectionName); return true; }
 
    // @return true: Setup panel can be shown while vehicle is armed
    virtual bool allowSetupWhileArmed() const { return false; }
 
    // @return true: Setup panel can be shown while vehicle is flying (and armed)
    virtual bool allowSetupWhileFlying() const { return false; }
 
    virtual void addSummaryQmlComponent(QQmlContext* context, QQuickItem* parent);
 
    virtual QStringList setupCompleteChangedTriggerList() const = 0;
 
    virtual void setupTriggerSignals();
 
    AutoPilotPlugin::KnownVehicleComponent KnownVehicleComponent() const { return _KnownVehicleComponent; }
 
signals:
    void setupCompleteChanged();
    void setupSourceChanged();
    void sectionsChanged();
 
protected slots:
    void _triggerUpdated(QVariant /*value*/) { emit setupCompleteChanged(); }
 
protected:
    Vehicle *_vehicle = nullptr;
    AutoPilotPlugin *_autopilot = nullptr;
    AutoPilotPlugin::KnownVehicleComponent _KnownVehicleComponent;
 
private:
    void _ensureSectionsCached() const;
 
    struct RepeatFilter {
        QStringList sectionNames;   
        QStringList paramNames;     
        int         disabledValue = 0;
        QString     disabledHeading; 
    };
 
    mutable QStringList            _expandedSections;  
    mutable QVector<RepeatFilter>  _repeatFilters;     
    mutable QMap<QString, QStringList> _sectionKeywords;  
    mutable bool                   _sectionsCached = false;
};