IProgress.hpp

Go to the documentation of this file.

 
#pragma once
#include <QObject>
#include <QString>
#include <QUuid>
 
#define OPENSWMM_PROGRESS_IID "io.opensimulator.openswmm.IProgress/1.0"
 
namespace OpenSWMM::Sdk
{
enum class ProgressOutcome {
    Succeeded, 
    Failed,    
    Cancelled  
};
 
class IProgress
{
public:
    virtual ~IProgress() = default;
    virtual QUuid beginProgress(const QString &title, QObject *context) = 0;
    virtual bool updateProgress(const QUuid &operationId, double fraction,
                                const QString &stage) = 0;
    virtual bool finishProgress(const QUuid &operationId, ProgressOutcome outcome,
                                const QString &detail = {}) = 0;
};
}
Q_DECLARE_INTERFACE(OpenSWMM::Sdk::IProgress, OPENSWMM_PROGRESS_IID)
Q_DECLARE_METATYPE(OpenSWMM::Sdk::ProgressOutcome)