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

#include <qgsvectorlayerimport.h>

Collaboration diagram for QgsVectorLayerImport:

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
ImportError	hasError ()
	checks whether there were any errors
QString	errorMessage ()
	retrieves error message
int	errorCount () const
bool	addFeature (QgsFeature &feature)
	add feature to the new created layer
	~QgsVectorLayerImport ()
	close the new created layer

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.

Protected Member Functions
bool	flushBuffer ()
	flush the buffer writing the features to the new layer
bool	createSpatialIndex ()
	create index

Protected Attributes
ImportError	mError
	contains error value
QString	mErrorMessage
int	mErrorCount
QgsVectorDataProvider *	mProvider
QMap< int, int >	mOldToNewAttrIdx
	map attribute indexes to new field indexes
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:

static call to QgsVectorFileWriter::writeAsShapefile(...) which saves the whole vector layer
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

enum QgsVectorLayerImport::ImportError

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`
	)

create a empty layer and add fields to it

Definition at line 45 of file qgsvectorlayerimport.cpp.

References QgsVectorDataProvider::AddFeatures, QgsVectorDataProvider::capabilities(), cast_to_fptr, ErrInvalidLayer, ErrInvalidProvider, ErrProviderUnsupportedFeature, hasError(), QgsProviderRegistry::instance(), QgsDataProvider::isValid(), mAttributeCount, mError, mErrorMessage, mOldToNewAttrIdx, mProvider, NoError, QgsProviderRegistry::provider(), QgsProviderRegistry::providerLibrary(), QgsDebugMsg, and tr.

Referenced by importLayer().

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 )

add feature to the new created layer

Definition at line 134 of file qgsvectorlayerimport.cpp.

References QgsFeature::attributes(), FEATURE_BUFFER_SIZE, flushBuffer(), QgsFeature::geometry(), QgsFeature::initAttributes(), mAttributeCount, mFeatureBuffer, mOldToNewAttrIdx, QgsDebugMsgLevel, QgsFeature::setAttribute(), and QgsFeature::setGeometry().

Referenced by importLayer().

bool QgsVectorLayerImport::createSpatialIndex ( )

protected

create index

Definition at line 193 of file qgsvectorlayerimport.cpp.

References QgsVectorDataProvider::capabilities(), QgsVectorDataProvider::CreateSpatialIndex, QgsVectorDataProvider::createSpatialIndex(), and mProvider.

Referenced by importLayer().

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

flush the buffer writing the features to the new layer

Definition at line 166 of file qgsvectorlayerimport.cpp.

References QgsVectorDataProvider::addFeatures(), QgsVectorDataProvider::clearErrors(), ErrFeatureWriteFailed, QgsVectorDataProvider::errors(), mError, mErrorCount, mErrorMessage, mFeatureBuffer, mProvider, QgsDebugMsg, and tr.

Referenced by addFeature(), importLayer(), and ~QgsVectorLayerImport().

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`
	)