QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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>

Collaboration diagram for QgsVectorLayerImport:
Collaboration graph
[legend]

Public Types

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

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=0, QProgressDialog *progress=0)
 create a empty layer and add fields to it More...
 
ImportError hasError ()
 checks whether there were any errors More...
 
QString errorMessage ()
 retrieves error message More...
 
int errorCount () const
 
bool addFeature (QgsFeature &feature)
 add feature to the new created layer More...
 
 ~QgsVectorLayerImport ()
 close the new created layer More...
 

Static Public Member Functions

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

Protected Member Functions

bool flushBuffer ()
 flush the buffer writing the features to the new layer More...
 
bool createSpatialIndex ()
 create index More...
 

Protected Attributes

ImportError mError
 contains error value More...
 
QString mErrorMessage
 
int mErrorCount
 
QgsVectorDataProvidermProvider
 
QMap< int, int > mOldToNewAttrIdx
 map attribute indexes to new field indexes More...
 
int mAttributeCount
 
QgsFeatureList mFeatureBuffer
 
QProgressDialog * mProgress
 

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(...)

Currently supports only writing to shapefiles, but shouldn't be a problem to add capability to support other OGR-writable formats.

Definition at line 36 of file qgsvectorlayerimport.h.

Member Enumeration Documentation

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

Definition at line 40 of file qgsvectorlayerimport.h.

Constructor & Destructor Documentation

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 = 0,
QProgressDialog *  progress = 0 
)
QgsVectorLayerImport::~QgsVectorLayerImport ( )

close the new created layer

Definition at line 116 of file qgsvectorlayerimport.cpp.

References flushBuffer(), and mProvider.

Member Function Documentation

bool QgsVectorLayerImport::addFeature ( QgsFeature feature)
bool QgsVectorLayerImport::createSpatialIndex ( )
protected
int QgsVectorLayerImport::errorCount ( ) const
inline

Definition at line 85 of file qgsvectorlayerimport.h.

Referenced by importLayer().

QString QgsVectorLayerImport::errorMessage ( )

retrieves error message

Definition at line 129 of file qgsvectorlayerimport.cpp.

References mErrorMessage.

Referenced by importLayer().

bool QgsVectorLayerImport::flushBuffer ( )
protected
QgsVectorLayerImport::ImportError QgsVectorLayerImport::hasError ( )

checks whether there were any errors

Definition at line 124 of file qgsvectorlayerimport.cpp.

References mError.

Referenced by importLayer(), and QgsVectorLayerImport().

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

Member Data Documentation

int QgsVectorLayerImport::mAttributeCount
protected

Definition at line 110 of file qgsvectorlayerimport.h.

Referenced by addFeature(), and QgsVectorLayerImport().

ImportError QgsVectorLayerImport::mError
protected

contains error value

Definition at line 101 of file qgsvectorlayerimport.h.

Referenced by flushBuffer(), hasError(), and QgsVectorLayerImport().

int QgsVectorLayerImport::mErrorCount
protected

Definition at line 104 of file qgsvectorlayerimport.h.

Referenced by flushBuffer().

QString QgsVectorLayerImport::mErrorMessage
protected

Definition at line 102 of file qgsvectorlayerimport.h.

Referenced by errorMessage(), flushBuffer(), and QgsVectorLayerImport().

QgsFeatureList QgsVectorLayerImport::mFeatureBuffer
protected

Definition at line 112 of file qgsvectorlayerimport.h.

Referenced by addFeature(), and flushBuffer().

QMap<int, int> QgsVectorLayerImport::mOldToNewAttrIdx
protected

map attribute indexes to new field indexes

Definition at line 109 of file qgsvectorlayerimport.h.

Referenced by addFeature(), and QgsVectorLayerImport().

QProgressDialog* QgsVectorLayerImport::mProgress
protected

Definition at line 113 of file qgsvectorlayerimport.h.

QgsVectorDataProvider* QgsVectorLayerImport::mProvider
protected

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