QGIS API Documentation  2.17.0-Master (dfeb663)
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsVectorLayerImport Class Reference

A convenience class for writing vector files to disk. More...

#include <qgsvectorlayerimport.h>

Public Types

enum  ImportError {
  NoError = 0, ErrDriverNotFound, ErrCreateDataSource, ErrCreateLayer,
  ErrAttributeTypeUnsupported, ErrAttributeCreationFailed, ErrProjection, ErrFeatureWriteFailed,
  ErrInvalidLayer, ErrInvalidProvider, ErrProviderUnsupportedFeature, ErrConnectionFailed,
  ErrUserCancelled
}
 

Public Member Functions

 QgsVectorLayerImport (const QString &uri, const QString &provider, const QgsFields &fields, QGis::WkbType geometryType, const QgsCoordinateReferenceSystem *crs, bool overwrite=false, const QMap< QString, QVariant > *options=nullptr, QProgressDialog *progress=nullptr)
 Create a empty layer and add fields to it. More...
 
 ~QgsVectorLayerImport ()
 Close the new created layer. More...
 
bool addFeature (QgsFeature &feature)
 Add feature to the new created layer. More...
 
int errorCount () const
 
QString errorMessage ()
 Retrieves error message. More...
 
ImportError hasError ()
 Checks whether there were any errors. More...
 

Static Public Member Functions

static ImportError importLayer (QgsVectorLayer *layer, const QString &uri, const QString &providerKey, const QgsCoordinateReferenceSystem *destCRS, bool onlySelected=false, QString *errorMessage=nullptr, bool skipAttributeCreation=false, QMap< QString, QVariant > *options=nullptr, QProgressDialog *progress=nullptr)
 Write contents of vector layer to a different datasource. More...
 

Protected Member Functions

bool createSpatialIndex ()
 Create index. More...
 
bool flushBuffer ()
 Flush the buffer writing the features to the new layer. More...
 

Protected Attributes

int mAttributeCount
 
ImportError mError
 Contains error value. More...
 
int mErrorCount
 
QString mErrorMessage
 
QgsFeatureList mFeatureBuffer
 
QMap< int, int > mOldToNewAttrIdx
 Map attribute indexes to new field indexes. More...
 
QProgressDialogmProgress
 
QgsVectorDataProvidermProvider
 

Detailed Description

A convenience class for writing vector files to disk.

There are two possibilities how to use this class:

  1. static call to QgsVectorFileWriter::writeAsShapefile(...) which saves the whole vector layer
  2. create an instance of the class and issue calls to addFeature(...)

Definition at line 33 of file qgsvectorlayerimport.h.

Member Enumeration Documentation

§ ImportError

Enumerator
NoError 
ErrDriverNotFound 
ErrCreateDataSource 
ErrCreateLayer 
ErrAttributeTypeUnsupported 
ErrAttributeCreationFailed 
ErrProjection 
ErrFeatureWriteFailed 
ErrInvalidLayer 
ErrInvalidProvider 
ErrProviderUnsupportedFeature 
ErrConnectionFailed 
ErrUserCancelled 

User cancelled the import

Definition at line 37 of file qgsvectorlayerimport.h.

Constructor & Destructor Documentation

§ QgsVectorLayerImport()

QgsVectorLayerImport::QgsVectorLayerImport ( const QString uri,
const QString provider,
const QgsFields fields,
QGis::WkbType  geometryType,
const QgsCoordinateReferenceSystem crs,
bool  overwrite = false,
const QMap< QString, QVariant > *  options = nullptr,
QProgressDialog progress = nullptr 
)

Create a empty layer and add fields to it.

Definition at line 45 of file qgsvectorlayerimport.cpp.

§ ~QgsVectorLayerImport()

QgsVectorLayerImport::~QgsVectorLayerImport ( )

Close the new created layer.

Definition at line 116 of file qgsvectorlayerimport.cpp.

Member Function Documentation

§ addFeature()

bool QgsVectorLayerImport::addFeature ( QgsFeature feature)

Add feature to the new created layer.

Definition at line 134 of file qgsvectorlayerimport.cpp.

§ createSpatialIndex()

bool QgsVectorLayerImport::createSpatialIndex ( )
protected

Create index.

Definition at line 193 of file qgsvectorlayerimport.cpp.

§ errorCount()

int QgsVectorLayerImport::errorCount ( ) const
inline

Definition at line 83 of file qgsvectorlayerimport.h.

§ errorMessage()

QString QgsVectorLayerImport::errorMessage ( )

Retrieves error message.

Definition at line 129 of file qgsvectorlayerimport.cpp.

§ flushBuffer()

bool QgsVectorLayerImport::flushBuffer ( )
protected

Flush the buffer writing the features to the new layer.

Definition at line 166 of file qgsvectorlayerimport.cpp.

§ hasError()

QgsVectorLayerImport::ImportError QgsVectorLayerImport::hasError ( )

Checks whether there were any errors.

Definition at line 124 of file qgsvectorlayerimport.cpp.

§ importLayer()

QgsVectorLayerImport::ImportError QgsVectorLayerImport::importLayer ( QgsVectorLayer layer,
const QString uri,
const QString providerKey,
const QgsCoordinateReferenceSystem destCRS,
bool  onlySelected = false,
QString errorMessage = nullptr,
bool  skipAttributeCreation = false,
QMap< QString, QVariant > *  options = nullptr,
QProgressDialog progress = nullptr 
)
static

Write contents of vector layer to a different datasource.

Definition at line 206 of file qgsvectorlayerimport.cpp.

Member Data Documentation

§ mAttributeCount

int QgsVectorLayerImport::mAttributeCount
protected

Definition at line 108 of file qgsvectorlayerimport.h.

§ mError

ImportError QgsVectorLayerImport::mError
protected

Contains error value.

Definition at line 99 of file qgsvectorlayerimport.h.

§ mErrorCount

int QgsVectorLayerImport::mErrorCount
protected

Definition at line 102 of file qgsvectorlayerimport.h.

§ mErrorMessage

QString QgsVectorLayerImport::mErrorMessage
protected

Definition at line 100 of file qgsvectorlayerimport.h.

§ mFeatureBuffer

QgsFeatureList QgsVectorLayerImport::mFeatureBuffer
protected

Definition at line 110 of file qgsvectorlayerimport.h.

§ mOldToNewAttrIdx

QMap<int, int> QgsVectorLayerImport::mOldToNewAttrIdx
protected

Map attribute indexes to new field indexes.

Definition at line 107 of file qgsvectorlayerimport.h.

§ mProgress

QProgressDialog* QgsVectorLayerImport::mProgress
protected

Definition at line 111 of file qgsvectorlayerimport.h.

§ mProvider

QgsVectorDataProvider* QgsVectorLayerImport::mProvider
protected

Definition at line 104 of file qgsvectorlayerimport.h.


The documentation for this class was generated from the following files: