Downloadable_Abstract.h

/***************************************************************************
 *   Copyright (C) 2022--2026 by Stefan Kebekus                            *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   This program 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.                                   *
 *                                                                         *
 *   This program 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 this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QGeoRectangle>
#include <QProperty>
#include <QQmlEngine>
#include <QTimer>
 
#include "units/ByteSize.h"
 
 
namespace DataManagement {

 
class Downloadable_Abstract : public QObject {
    Q_OBJECT
    QML_ELEMENT
    QML_UNCREATABLE("")
 
public:
    enum ContentType : quint8 {
        VAC,            
        AviationMap,    
        BaseMapVector,  
        BaseMapRaster,  
        Data,           
        MapSet,         
        TerrainMap,     
        VACCollection   
    };
    Q_ENUM(ContentType)
 
    
    explicit Downloadable_Abstract(QObject* parent = nullptr);
 
    // standard destructor
    ~Downloadable_Abstract() override;
 
 
 
    //
    // PROPERTIES
    //

    Q_PROPERTY(QGeoRectangle boundingBox READ boundingBox WRITE setBoundingBox BINDABLE bindableBoundingBox NOTIFY boundingBoxChanged)
    [[nodiscard]] QGeoRectangle boundingBox() const {return m_boundingBox.value();}
    [[nodiscard]] QBindable<QGeoRectangle> bindableBoundingBox() {return &m_boundingBox;}
    void setBoundingBox(const QGeoRectangle& boundingBox) {m_boundingBox = boundingBox;}

    Q_PROPERTY(DataManagement::Downloadable_Abstract::ContentType contentType READ contentType WRITE setContentType NOTIFY contentTypeChanged)
 
    
    Q_PROPERTY(QString description READ description NOTIFY descriptionChanged)

    Q_PROPERTY(bool downloading READ downloading NOTIFY downloadingChanged)

    Q_PROPERTY(QStringList files READ files NOTIFY filesChanged)

    Q_PROPERTY(bool hasFile READ hasFile BINDABLE bindableHasFile NOTIFY hasFileChanged)

    Q_PROPERTY(QString infoText READ infoText NOTIFY infoTextChanged)

    Q_PROPERTY(qint64 remoteFileSize READ remoteFileSize NOTIFY remoteFileSizeChanged)

    Q_PROPERTY(QString section READ section WRITE setSection BINDABLE bindableSection NOTIFY sectionChanged)

    Q_PROPERTY(Units::ByteSize updateSize READ updateSize NOTIFY updateSizeChanged)

    Q_PROPERTY(QString updateSizeString READ updateSizeString NOTIFY updateSizeChanged)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] DataManagement::Downloadable_Abstract::ContentType contentType() const {return m_contentType;}

    [[nodiscard]] virtual auto description() -> QString = 0;

    [[nodiscard]] virtual auto downloading() -> bool = 0;

    [[nodiscard]] virtual auto files() -> QStringList = 0;

    [[nodiscard]] bool hasFile() const {return m_hasFile.value();}

    [[nodiscard]] QBindable<bool> bindableHasFile() const {return &m_hasFile;}

    [[nodiscard]] virtual auto infoText() -> QString = 0;

    [[nodiscard]] virtual auto remoteFileSize() -> qint64 = 0;

    [[nodiscard]] QString section() const { return m_section.value(); }

    [[nodiscard]] QBindable<QString> bindableSection() const { return &m_section; }

    [[nodiscard]] QString sectionUnmasked() const { return m_sectionBuffer.value(); }

    [[nodiscard]] virtual auto updateSize() -> Units::ByteSize = 0;

    [[nodiscard]] virtual auto updateSizeString() -> QString;
 
 
 
    //
    // Setter Methods
    //

    void setContentType(DataManagement::Downloadable_Abstract::ContentType contentType);

    void setSection(const QString& sectionName) {m_sectionBuffer = sectionName;}
 
 
 
    //
    // Methods
    //

    Q_INVOKABLE virtual void deleteFiles() = 0;

    Q_INVOKABLE void killFileContentChanged_delayed()
    {
        emitFileContentChanged_delayedTimer.stop();
    }

    Q_INVOKABLE virtual void startDownload() = 0;

    Q_INVOKABLE virtual void stopDownload() = 0;

    Q_INVOKABLE virtual void update() = 0;
 
signals:
    void boundingBoxChanged();

    void contentTypeChanged();

    void descriptionChanged();

    void downloadingChanged();

    void error(QString objectName, QString message);

    void fileContentChanged();

    void fileContentChanged_delayed();

    void filesChanged();

    void hasFileChanged();

    void infoTextChanged();

    void remoteFileSizeChanged();

    void sectionChanged();

    void updateSizeChanged();
 
protected:
    Q_OBJECT_BINDABLE_PROPERTY(DataManagement::Downloadable_Abstract, bool, m_hasFile, &DataManagement::Downloadable_Abstract::hasFileChanged);
 
 
private:
    Q_DISABLE_COPY_MOVE(Downloadable_Abstract)
 
    Q_OBJECT_BINDABLE_PROPERTY(DataManagement::Downloadable_Abstract, QGeoRectangle, m_boundingBox, &DataManagement::Downloadable_Abstract::boundingBoxChanged);
 
    // Property contentType
    ContentType m_contentType {Data};
 
    // Property section
    Q_OBJECT_BINDABLE_PROPERTY(DataManagement::Downloadable_Abstract, QString, m_section, &DataManagement::Downloadable_Abstract::sectionChanged);
    QProperty<QString> m_sectionBuffer;
 
    // Provisions to provide the signal localFileContentChanged_delayed
    void emitFileContentChanged_delayed();
    QTimer emitFileContentChanged_delayedTimer;
};
 
} // namespace DataManagement