QGIS API Documentation  3.8.0-Zanzibar (11aff65)
qgsvectorfilewritertask.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsvectorfilewritertask.h
3  -------------------------
4  begin : Feb 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSVECTORFILEWRITERTASK_H
19 #define QGSVECTORFILEWRITERTASK_H
20 
21 #include "qgis_core.h"
22 #include "qgsvectorfilewriter.h"
23 #include "qgstaskmanager.h"
24 
35 class CORE_EXPORT QgsVectorFileWriterTask : public QgsTask
36 {
37  Q_OBJECT
38 
39  public:
40 
46  const QString &fileName,
48 
49  void cancel() override;
50 
51  signals:
52 
58  void writeComplete( const QString &newFilename );
59 
65  void completed( const QString &newFilename, const QString &newLayer ) SIP_SKIP;
66 
71  void errorOccurred( int error, const QString &errorMessage );
72 
73  protected:
74 
75  bool run() override;
76  void finished( bool result ) override;
77 
78  private:
79 
80  QString mDestFileName;
81 
82  std::unique_ptr< QgsFeedback > mOwnedFeedback;
84 
85  QString mNewFilename;
86  QString mNewLayer;
87  QString mErrorMessage;
88 
90  QgsVectorFileWriter::PreparedWriterDetails mWriterDetails;
91  std::unique_ptr< QgsVectorFileWriter::FieldValueConverter > mFieldValueConverter;
92 };
93 
94 #endif
Options to pass to writeAsVectorFormat()
#define SIP_SKIP
Definition: qgis_sip.h:119
Abstract base class for long running background tasks.
virtual void cancel()
Notifies the task that it should terminate.
virtual void finished(bool result)
If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether ...
virtual bool run()=0
Performs the task&#39;s operation.
QgsTask task which performs a QgsVectorFileWriter layer saving operation as a background task...
Represents a vector layer which manages a vector based data sets.