PlanElementController.h

/****************************************************************************
 *
 * (c) 2009-2020 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

#ifndef PlanElementController_H
#define PlanElementController_H

#include <QObject>

#include "Vehicle.h"
#include "MultiVehicleManager.h"

class PlanMasterController;

/// This is the abstract base clas for Plan Element controllers.
/// Examples of plan elements are: missions (MissionController), geofence (GeoFenceController)
class PlanElementController : public QObject
{
    Q_OBJECT
    
public:
    PlanElementController(PlanMasterController* masterController, QObject* parent = nullptr);
    ~PlanElementController();
    
    Q_PROPERTY(PlanMasterController*    masterController    READ masterController               CONSTANT)
    Q_PROPERTY(bool                     supported           READ supported                      NOTIFY supportedChanged)        ///< true: Element is supported by Vehicle
    Q_PROPERTY(bool                     containsItems       READ containsItems                  NOTIFY containsItemsChanged)    ///< true: Elemement is non-empty
    Q_PROPERTY(bool                     syncInProgress      READ syncInProgress                 NOTIFY syncInProgressChanged)   ///< true: information is currently being saved/sent, false: no active save/send in progress
    Q_PROPERTY(bool                     dirty               READ dirty          WRITE setDirty  NOTIFY dirtyChanged)            ///< true: unsaved/sent changes are present, false: no changes since last save/send

    PlanMasterController* masterController(void) { return _masterController; }

    /// Should be called immediately upon Component.onCompleted.
    virtual void start(bool flyView);

    virtual void save                       (QJsonObject& json) = 0;
    virtual bool load                       (const QJsonObject& json, QString& errorString) = 0;
    virtual void loadFromVehicle            (void) = 0;
    virtual void removeAll                  (void) = 0;     ///< Removes all from controller only
    virtual bool showPlanFromManagerVehicle (void) = 0;     /// true: controller is waiting for the current load to complete

    virtual bool    supported       (void) const = 0;
    virtual bool    containsItems   (void) const = 0;
    virtual bool    syncInProgress  (void) const = 0;
    virtual bool    dirty           (void) const = 0;
    virtual void    setDirty        (bool dirty) = 0;

    /// Sends the current plan element to the vehicle
    ///     Signals sendComplete when done
    virtual void sendToVehicle(void) = 0;

    /// Removes all from vehicle and controller
    ///     Signals removeAllComplete when done
    virtual void removeAllFromVehicle(void) = 0;

signals:
    void supportedChanged       (bool supported);
    void containsItemsChanged   (bool containsItems);
    void syncInProgressChanged  (bool syncInProgress);
    void dirtyChanged           (bool dirty);
    void sendComplete           (void);
    void removeAllComplete      (void);

protected:
    PlanMasterController*   _masterController;
    bool                    _flyView;
};

#endif