qgsprofileexporter.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprofileexporter.h
                         ---------------
    begin                : May 2023
    copyright            : (C) 2023 by Nyall Dawson
    email                : nyall dot dawson at gmail dot 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSPROFILEEXPORTER_H
#define QGSPROFILEEXPORTER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractprofilegenerator.h"
#include "qgsprofilerequest.h"
#include "qgstaskmanager.h"
 
class QgsAbstractProfileSource;
class QgsAbstractProfileGenerator;

class CORE_EXPORT QgsProfileExporter
{
  public:
    QgsProfileExporter( const QList< QgsAbstractProfileSource * > &sources, const QgsProfileRequest &request, Qgis::ProfileExportType type );
 
    QgsProfileExporter( const QgsProfileExporter &other ) = delete;
    QgsProfileExporter &operator=( const QgsProfileExporter &other ) = delete;
 
    ~QgsProfileExporter();

    void run( QgsFeedback *feedback = nullptr );

    QList< QgsVectorLayer * > toLayers() SIP_FACTORY;
 
  private:
#ifdef SIP_RUN
    QgsProfileExporter( const QgsProfileExporter &other );
#endif
 
    Qgis::ProfileExportType mType = Qgis::ProfileExportType::Features3D;
    QgsProfileRequest mRequest;
    std::vector< std::unique_ptr< QgsAbstractProfileGenerator > > mGenerators;
    QVector< QgsAbstractProfileResults::Feature > mFeatures;
};

class CORE_EXPORT QgsProfileExporterTask : public QgsTask
{
    Q_OBJECT
 
  public:
    enum class ExportResult
    {
      Success,           
      Empty,             
      DeviceError,       
      DxfExportFailed,   
      LayerExportFailed, 
      Canceled,          
    };
    Q_ENUM( ExportResult );

    QgsProfileExporterTask(
      const QList< QgsAbstractProfileSource * > &sources, const QgsProfileRequest &request, Qgis::ProfileExportType type, const QString &destination, const QgsCoordinateTransformContext &transformContext
    );
 
    bool run() override;
    void cancel() override;

    QList< QgsVectorLayer * > takeLayers() SIP_FACTORY;

    QgsProfileExporterTask::ExportResult result() const;

    QStringList createdFiles() const { return mCreatedFiles; }

    QString error() const { return mError; }
 
  private:
    std::unique_ptr< QgsProfileExporter > mExporter;
    QList< QgsVectorLayer * > mLayers;
 
    std::unique_ptr< QgsFeedback > mFeedback;
    QString mDestination;
    QgsCoordinateTransformContext mTransformContext;
    ExportResult mResult = ExportResult::Success;
    QString mError;
    QStringList mCreatedFiles;
};
 
 
#endif // QGSPROFILEEXPORTER_H