40#include <QRegularExpression>
46 return compatibleMapLayers< QgsRasterLayer >( project, sort );
52 return QList<QgsVectorLayer *>();
54 QList<QgsVectorLayer *> layers;
58 if ( canUseLayer( l, geometryTypes ) )
66 return QString::localeAwareCompare( a->name(), b->name() ) < 0;
74 return compatibleMapLayers< QgsMeshLayer >( project, sort );
79 return compatibleMapLayers< QgsPluginLayer >( project, sort );
84 return compatibleMapLayers< QgsPointCloudLayer >( project, sort );
90 QList<QgsAnnotationLayer *> res = compatibleMapLayers< QgsAnnotationLayer >( project,
false );
98 return QString::localeAwareCompare( a->name(), b->name() ) < 0;
107 return compatibleMapLayers< QgsVectorTileLayer >( project, sort );
112 return compatibleMapLayers< QgsTiledSceneLayer >( project, sort );
115template<
typename T> QList<T *> QgsProcessingUtils::compatibleMapLayers(
QgsProject *project,
bool sort )
121 const auto projectLayers = project->
layers<T *>();
122 for ( T *l : projectLayers )
124 if ( canUseLayer( l ) )
130 std::sort( layers.begin(), layers.end(), [](
const T * a,
const T * b ) ->
bool
132 return QString::localeAwareCompare( a->name(), b->name() ) < 0;
141 return QList<QgsMapLayer *>();
143 QList<QgsMapLayer *> layers;
145 const auto rasterLayers = compatibleMapLayers< QgsRasterLayer >( project,
false );
153 const auto meshLayers = compatibleMapLayers< QgsMeshLayer >( project,
false );
157 const auto pointCloudLayers = compatibleMapLayers< QgsPointCloudLayer >( project,
false );
161 const auto annotationLayers = compatibleMapLayers< QgsAnnotationLayer >( project,
false );
166 const auto vectorTileLayers = compatibleMapLayers< QgsVectorTileLayer >( project,
false );
170 const auto tiledSceneLayers = compatibleMapLayers< QgsTiledSceneLayer >( project,
false );
174 const auto pluginLayers = compatibleMapLayers< QgsPluginLayer >( project,
false );
182 return QString::localeAwareCompare( a->name(), b->name() ) < 0;
190 return QStringLiteral(
"%1://%2" ).arg( providerKey, uri );
195 const thread_local QRegularExpression re( QStringLiteral(
"^(\\w+?):\\/\\/(.+)$" ) );
196 const QRegularExpressionMatch match = re.match(
string );
197 if ( !match.hasMatch() )
200 providerKey = match.captured( 1 );
201 uri = match.captured( 2 );
209 if ( !store ||
string.isEmpty() )
212 QList< QgsMapLayer * > layers = store->
mapLayers().values();
214 layers.erase( std::remove_if( layers.begin(), layers.end(), [](
QgsMapLayer * layer )
216 switch ( layer->type() )
218 case Qgis::LayerType::Vector:
219 return !canUseLayer( qobject_cast< QgsVectorLayer * >( layer ) );
220 case Qgis::LayerType::Raster:
221 return !canUseLayer( qobject_cast< QgsRasterLayer * >( layer ) );
222 case Qgis::LayerType::Plugin:
223 case Qgis::LayerType::Group:
225 case Qgis::LayerType::Mesh:
226 return !canUseLayer( qobject_cast< QgsMeshLayer * >( layer ) );
227 case Qgis::LayerType::VectorTile:
228 return !canUseLayer( qobject_cast< QgsVectorTileLayer * >( layer ) );
229 case Qgis::LayerType::TiledScene:
230 return !canUseLayer( qobject_cast< QgsTiledSceneLayer * >( layer ) );
231 case Qgis::LayerType::PointCloud:
232 return !canUseLayer( qobject_cast< QgsPointCloudLayer * >( layer ) );
233 case Qgis::LayerType::Annotation:
234 return !canUseLayer( qobject_cast< QgsAnnotationLayer * >( layer ) );
239 auto isCompatibleType = [typeHint](
QgsMapLayer * l ) ->
bool
243 case LayerHint::UnknownType:
246 case LayerHint::Vector:
249 case LayerHint::Raster:
252 case LayerHint::Mesh:
255 case LayerHint::PointCloud:
258 case LayerHint::Annotation:
261 case LayerHint::VectorTile:
264 case LayerHint::TiledScene:
272 if ( isCompatibleType( l ) && l->id() ==
string )
277 if ( isCompatibleType( l ) && l->name() ==
string )
282 if ( isCompatibleType( l ) && normalizeLayerSource( l->source() ) == normalizeLayerSource(
string ) )
298 if ( !useProvider || ( provider == QLatin1String(
"ogr" ) || provider == QLatin1String(
"gdal" ) || provider == QLatin1String(
"mdal" ) || provider == QLatin1String(
"pdal" ) || provider == QLatin1String(
"ept" ) || provider == QLatin1String(
"copc" ) ) )
300 QStringList components = uri.split(
'|' );
301 if ( components.isEmpty() )
305 if ( QFileInfo::exists( uri ) )
306 fi = QFileInfo( uri );
307 else if ( QFileInfo::exists( components.at( 0 ) ) )
308 fi = QFileInfo( components.at( 0 ) );
311 name = fi.baseName();
322 options.loadDefaultStyle =
false;
323 options.skipCrsValidation =
true;
325 std::unique_ptr< QgsVectorLayer > layer;
328 layer = std::make_unique<QgsVectorLayer>( uri, name, provider, options );
333 layer = std::make_unique<QgsVectorLayer>( uri, name, QStringLiteral(
"ogr" ), options );
335 if ( layer->isValid() )
337 return layer.release();
346 std::unique_ptr< QgsRasterLayer > rasterLayer;
349 rasterLayer = std::make_unique< QgsRasterLayer >( uri, name, provider, rasterOptions );
354 rasterLayer = std::make_unique< QgsRasterLayer >( uri, name, QStringLiteral(
"gdal" ), rasterOptions );
357 if ( rasterLayer->isValid() )
359 return rasterLayer.release();
367 std::unique_ptr< QgsMeshLayer > meshLayer;
370 meshLayer = std::make_unique< QgsMeshLayer >( uri, name, provider, meshOptions );
374 meshLayer = std::make_unique< QgsMeshLayer >( uri, name, QStringLiteral(
"mdal" ), meshOptions );
376 if ( meshLayer->isValid() )
378 return meshLayer.release();
391 std::unique_ptr< QgsPointCloudLayer > pointCloudLayer;
394 pointCloudLayer = std::make_unique< QgsPointCloudLayer >( uri, name, provider, pointCloudOptions );
399 if ( !preferredProviders.empty() )
401 pointCloudLayer = std::make_unique< QgsPointCloudLayer >( uri, name, preferredProviders.at( 0 ).metadata()->key(), pointCloudOptions );
404 if ( pointCloudLayer && pointCloudLayer->isValid() )
406 return pointCloudLayer.release();
412 dsUri.
setParam(
"type",
"mbtiles" );
415 std::unique_ptr< QgsVectorTileLayer > tileLayer;
416 tileLayer = std::make_unique< QgsVectorTileLayer >( dsUri.
encodedUri(), name );
418 if ( tileLayer->isValid() )
420 return tileLayer.release();
428 std::unique_ptr< QgsTiledSceneLayer > tiledSceneLayer;
431 tiledSceneLayer = std::make_unique< QgsTiledSceneLayer >( uri, name, provider, tiledSceneOptions );
436 if ( !preferredProviders.empty() )
438 tiledSceneLayer = std::make_unique< QgsTiledSceneLayer >( uri, name, preferredProviders.at( 0 ).metadata()->key(), tiledSceneOptions );
441 if ( tiledSceneLayer && tiledSceneLayer->isValid() )
443 return tiledSceneLayer.release();
451 if (
string.isEmpty() )
459 if (
auto *lProject = context.
project() )
461 QgsMapLayer *layer = mapLayerFromStore(
string, lProject->layerStore(), typeHint );
470 if ( !allowLoadingNewLayers )
473 layer = loadMapLayerFromString(
string, context.
transformContext(), typeHint, flags );
487 QVariant val = value;
488 bool selectedFeaturesOnly =
false;
489 long long featureLimit = -1;
490 QString filterExpression;
491 bool overrideGeometryCheck =
false;
493 if ( val.userType() == QMetaType::type(
"QgsProcessingFeatureSourceDefinition" ) )
504 else if ( val.userType() == QMetaType::type(
"QgsProcessingOutputLayerDefinition" ) )
511 if (
QgsVectorLayer *layer = qobject_cast< QgsVectorLayer * >( qvariant_cast<QObject *>( val ) ) )
513 std::unique_ptr< QgsProcessingFeatureSource> source = std::make_unique< QgsProcessingFeatureSource >( layer, context,
false, featureLimit, filterExpression );
514 if ( overrideGeometryCheck )
515 source->setInvalidGeometryCheck( geometryCheck );
516 return source.release();
520 if ( val.userType() == QMetaType::type(
"QgsProperty" ) )
524 else if ( !val.isValid() || val.toString().isEmpty() )
527 if (
QgsVectorLayer *layer = qobject_cast< QgsVectorLayer * >( qvariant_cast<QObject *>( fallbackValue ) ) )
529 std::unique_ptr< QgsProcessingFeatureSource> source = std::make_unique< QgsProcessingFeatureSource >( layer, context,
false, featureLimit, filterExpression );
530 if ( overrideGeometryCheck )
531 source->setInvalidGeometryCheck( geometryCheck );
532 return source.release();
535 layerRef = fallbackValue.toString();
539 layerRef = val.toString();
542 if ( layerRef.isEmpty() )
549 std::unique_ptr< QgsProcessingFeatureSource> source;
550 if ( selectedFeaturesOnly )
556 source = std::make_unique< QgsProcessingFeatureSource >( vl, context,
false, featureLimit, filterExpression );
559 if ( overrideGeometryCheck )
560 source->setInvalidGeometryCheck( geometryCheck );
561 return source.release();
566 QVariant val = value;
568 if ( val.userType() == QMetaType::type(
"QgsCoordinateReferenceSystem" ) )
573 else if ( val.userType() == QMetaType::type(
"QgsProcessingFeatureSourceDefinition" ) )
579 else if ( val.userType() == QMetaType::type(
"QgsProcessingOutputLayerDefinition" ) )
592 if (
QgsMapLayer *layer = qobject_cast< QgsMapLayer * >( qvariant_cast<QObject *>( val ) ) )
595 if ( val.userType() == QMetaType::type(
"QgsProperty" ) )
598 if ( !val.isValid() )
604 QString crsText = val.toString();
605 if ( crsText.isEmpty() )
606 crsText = fallbackValue.toString();
608 if ( crsText.isEmpty() )
612 if ( context.
project() && crsText.compare( QLatin1String(
"ProjectCrs" ), Qt::CaseInsensitive ) == 0 )
625bool QgsProcessingUtils::canUseLayer(
const QgsMeshLayer *layer )
630bool QgsProcessingUtils::canUseLayer(
const QgsPluginLayer *layer )
632 return layer && layer->
isValid();
637 return layer && layer->
isValid();
640bool QgsProcessingUtils::canUseLayer(
const QgsRasterLayer *layer )
642 return layer && layer->
isValid();
647 return layer && layer->
isValid();
652 return layer && layer->
isValid();
657 return layer && layer->
isValid();
660bool QgsProcessingUtils::canUseLayer(
const QgsVectorLayer *layer,
const QList<int> &sourceTypes )
662 return layer && layer->
isValid() &&
663 ( sourceTypes.isEmpty()
674 QString normalized = source;
675 normalized.replace(
'\\',
'/' );
676 return normalized.trimmed();
681 if ( !value.isValid() )
682 return QStringLiteral(
"None" );
684 if ( value.userType() == QMetaType::type(
"QgsProperty" ) )
685 return QStringLiteral(
"QgsProperty.fromExpression('%1')" ).arg( value.value<
QgsProperty >().
asExpression() );
686 else if ( value.userType() == QMetaType::type(
"QgsCoordinateReferenceSystem" ) )
689 return QStringLiteral(
"QgsCoordinateReferenceSystem()" );
693 else if ( value.userType() == QMetaType::type(
"QgsRectangle" ) )
701 else if ( value.userType() == QMetaType::type(
"QgsReferencedRectangle" ) )
709 else if ( value.userType() == QMetaType::type(
"QgsPointXY" ) )
715 else if ( value.userType() == QMetaType::type(
"QgsReferencedPointXY" ) )
723 switch ( value.type() )
726 return value.toBool() ? QStringLiteral(
"True" ) : QStringLiteral(
"False" );
728 case QVariant::Double:
729 return QString::number( value.toDouble() );
733 return QString::number( value.toInt() );
735 case QVariant::LongLong:
736 case QVariant::ULongLong:
737 return QString::number( value.toLongLong() );
742 const QVariantList vl = value.toList();
743 for (
const QVariant &v : vl )
747 return parts.join(
',' ).prepend(
'[' ).append(
']' );
752 const QVariantMap map = value.toMap();
754 parts.reserve( map.size() );
755 for (
auto it = map.constBegin(); it != map.constEnd(); ++it )
759 return parts.join(
',' ).prepend(
'{' ).append(
'}' );
762 case QVariant::DateTime:
764 const QDateTime dateTime = value.toDateTime();
765 return QStringLiteral(
"QDateTime(QDate(%1, %2, %3), QTime(%4, %5, %6))" )
766 .arg( dateTime.date().year() )
767 .arg( dateTime.date().month() )
768 .arg( dateTime.date().day() )
769 .arg( dateTime.time().hour() )
770 .arg( dateTime.time().minute() )
771 .arg( dateTime.time().second() );
784 s.replace(
'\\', QLatin1String(
"\\\\" ) );
785 s.replace(
'\n', QLatin1String(
"\\n" ) );
786 s.replace(
'\r', QLatin1String(
"\\r" ) );
787 s.replace(
'\t', QLatin1String(
"\\t" ) );
789 if ( s.contains(
'\'' ) && !s.contains(
'\"' ) )
791 s = s.prepend(
'"' ).append(
'"' );
795 s.replace(
'\'', QLatin1String(
"\\\'" ) );
796 s = s.prepend(
'\'' ).append(
'\'' );
801void QgsProcessingUtils::parseDestinationString( QString &destination, QString &providerKey, QString &uri, QString &layerName, QString &format, QMap<QString, QVariant> &options,
bool &useWriter, QString &extension )
808 const thread_local QRegularExpression splitRx( QStringLiteral(
"^(.{3,}?):(.*)$" ) );
809 QRegularExpressionMatch match = splitRx.match( destination );
810 if ( match.hasMatch() )
812 providerKey = match.captured( 1 );
813 uri = match.captured( 2 );
820 if ( providerKey == QLatin1String(
"postgis" ) )
822 providerKey = QStringLiteral(
"postgres" );
824 if ( providerKey == QLatin1String(
"ogr" ) )
829 if ( !dsUri.
table().isEmpty() )
831 layerName = dsUri.
table();
832 options.insert( QStringLiteral(
"layerName" ), layerName );
835 extension = QFileInfo( uri ).completeSuffix();
837 options.insert( QStringLiteral(
"driverName" ), format );
841 extension = QFileInfo( uri ).completeSuffix();
844 options.insert( QStringLiteral(
"update" ),
true );
851 providerKey = QStringLiteral(
"ogr" );
853 const thread_local QRegularExpression splitRx( QStringLiteral(
"^(.*)\\.(.*?)$" ) );
854 QRegularExpressionMatch match = splitRx.match( destination );
855 if ( match.hasMatch() )
857 extension = match.captured( 2 );
861 if ( format.isEmpty() )
863 format = QStringLiteral(
"GPKG" );
864 destination = destination + QStringLiteral(
".gpkg" );
867 options.insert( QStringLiteral(
"driverName" ), format );
874 QVariantMap options = createOptions;
875 if ( !options.contains( QStringLiteral(
"fileEncoding" ) ) )
881 if ( destination.isEmpty() || destination.startsWith( QLatin1String(
"memory:" ) ) )
884 if ( destination.startsWith( QLatin1String(
"memory:" ) ) )
885 destination = destination.mid( 7 );
887 if ( destination.isEmpty() )
888 destination = QStringLiteral(
"output" );
892 if ( !layer || !layer->isValid() )
899 for (
const QgsField &field : fields )
902 if ( !field.alias().isEmpty() )
903 feedback->pushWarning( QObject::tr(
"%1: Aliases are not compatible with scratch layers" ).arg( field.name() ) );
904 if ( !field.alias().isEmpty() )
905 feedback->pushWarning( QObject::tr(
"%1: Comments are not compatible with scratch layers" ).arg( field.name() ) );
912 destination = layer->id();
915 std::unique_ptr< QgsProcessingFeatureSink > sink(
new QgsProcessingFeatureSink( layer->dataProvider(), destination, context ) );
918 return sink.release();
927 bool useWriter =
false;
928 parseDestinationString( destination, providerKey, uri, layerName, format, options, useWriter, extension );
931 if ( useWriter && providerKey == QLatin1String(
"ogr" ) )
935 QString finalFileName;
936 QString finalLayerName;
938 saveOptions.
fileEncoding = options.value( QStringLiteral(
"fileEncoding" ) ).toString();
939 saveOptions.
layerName = !layerName.isEmpty() ? layerName : options.value( QStringLiteral(
"layerName" ) ).toString();
944 if ( remappingDefinition )
948 std::unique_ptr< QgsVectorLayer > vl = std::make_unique< QgsVectorLayer >( destination );
953 newFields = vl->fields();
963 if ( writer->hasError() )
965 throw QgsProcessingException( QObject::tr(
"Could not create layer %1: %2" ).arg( destination, writer->errorMessage() ) );
970 for (
const QgsField &field : fields )
973 feedback->pushWarning( QObject::tr(
"%1: Aliases are not supported by %2" ).arg( field.name(), writer->driverLongName() ) );
975 feedback->pushWarning( QObject::tr(
"%1: Comments are not supported by %2" ).arg( field.name(), writer->driverLongName() ) );
979 destination = finalFileName;
980 if ( !saveOptions.
layerName.isEmpty() && !finalLayerName.isEmpty() )
981 destination += QStringLiteral(
"|layername=%1" ).arg( finalLayerName );
983 if ( remappingDefinition )
985 std::unique_ptr< QgsRemappingProxyFeatureSink > remapSink = std::make_unique< QgsRemappingProxyFeatureSink >( *remappingDefinition, writer.release(),
true );
996 if ( remappingDefinition )
1001 if ( !layerName.isEmpty() )
1004 parts.insert( QStringLiteral(
"layerName" ), layerName );
1008 std::unique_ptr< QgsVectorLayer > layer = std::make_unique<QgsVectorLayer>( uri, destination, providerKey, layerOptions );
1010 destination = layer->id();
1011 if ( layer->isValid() )
1020 const Qgis::VectorDataProviderAttributeEditCapabilities capabilities = layer->dataProvider() ? layer->dataProvider()->attributeEditCapabilities() : Qgis::VectorDataProviderAttributeEditCapabilities();
1021 for (
const QgsField &field : fields )
1024 feedback->pushWarning( QObject::tr(
"%1: Aliases are not supported by the %2 provider" ).arg( field.name(), providerKey ) );
1026 feedback->pushWarning( QObject::tr(
"%1: Comments are not supported by the %2 provider" ).arg( field.name(), providerKey ) );
1030 std::unique_ptr< QgsRemappingProxyFeatureSink > remapSink = std::make_unique< QgsRemappingProxyFeatureSink >( *remappingDefinition, layer->dataProvider(),
false );
1040 std::unique_ptr< QgsVectorLayerExporter > exporter = std::make_unique<QgsVectorLayerExporter>( uri, providerKey, newFields, geometryType,
crs,
true, options, sinkFlags );
1043 throw QgsProcessingException( QObject::tr(
"Could not create layer %1: %2" ).arg( destination, exporter->errorMessage() ) );
1047 if ( !layerName.isEmpty() )
1049 uri += QStringLiteral(
"|layername=%1" ).arg( layerName );
1056 for (
const QgsField &field : fields )
1059 feedback->pushWarning( QObject::tr(
"%1: Aliases are not supported by the %2 provider" ).arg( field.name(), providerKey ) );
1061 feedback->pushWarning( QObject::tr(
"%1: Comments are not supported by the %2 provider" ).arg( field.name(), providerKey ) );
1119 if ( !input.isValid() )
1120 return QStringLiteral(
"memory:%1" ).arg(
id.toString() );
1122 if ( input.userType() == QMetaType::type(
"QgsProcessingOutputLayerDefinition" ) )
1129 else if ( input.userType() == QMetaType::type(
"QgsProperty" ) )
1136 QString res = input.toString();
1142 else if ( res.startsWith( QLatin1String(
"memory:" ) ) )
1144 return QString( res +
'_' +
id.toString() );
1150 int lastIndex = res.lastIndexOf(
'.' );
1151 return lastIndex >= 0 ? QString( res.left( lastIndex ) +
'_' +
id.toString() + res.mid( lastIndex ) ) : QString( res +
'_' +
id.toString() );
1162 static std::vector< std::unique_ptr< QTemporaryDir > > sTempFolders;
1163 static QString sFolder;
1164 static QMutex sMutex;
1165 QMutexLocker locker( &sMutex );
1170 if ( basePath.isEmpty() )
1173 if ( basePath.isEmpty() )
1176 if ( sTempFolders.empty() )
1178 const QString templatePath = QStringLiteral(
"%1/processing_XXXXXX" ).arg( QDir::tempPath() );
1179 std::unique_ptr< QTemporaryDir >
tempFolder = std::make_unique< QTemporaryDir >( templatePath );
1181 sTempFolders.emplace_back( std::move(
tempFolder ) );
1184 else if ( sFolder.isEmpty() || !sFolder.startsWith( basePath ) || sTempFolders.empty() )
1186 if ( !QDir().exists( basePath ) )
1187 QDir().mkpath( basePath );
1189 const QString templatePath = QStringLiteral(
"%1/processing_XXXXXX" ).arg( basePath );
1190 std::unique_ptr< QTemporaryDir >
tempFolder = std::make_unique< QTemporaryDir >( templatePath );
1192 sTempFolders.emplace_back( std::move(
tempFolder ) );
1199 QString subPath = QUuid::createUuid().toString().remove(
'-' ).remove(
'{' ).remove(
'}' );
1200 QString path =
tempFolder( context ) +
'/' + subPath;
1201 if ( !QDir( path ).exists() )
1204 tmpDir.mkdir( path );
1211 auto getText = [map](
const QString & key )->QString
1213 if ( map.contains( key ) )
1214 return map.value( key ).toString();
1219 s += QStringLiteral(
"<html><body><p>" ) + getText( QStringLiteral(
"ALG_DESC" ) ) + QStringLiteral(
"</p>\n" );
1228 if ( !getText( def->name() ).isEmpty() )
1230 inputs += QStringLiteral(
"<h3>" ) + def->description() + QStringLiteral(
"</h3>\n" );
1231 inputs += QStringLiteral(
"<p>" ) + getText( def->name() ) + QStringLiteral(
"</p>\n" );
1234 if ( !inputs.isEmpty() )
1235 s += QStringLiteral(
"<h2>" ) + QObject::tr(
"Input parameters" ) + QStringLiteral(
"</h2>\n" ) + inputs;
1241 if ( !getText( def->name() ).isEmpty() )
1243 outputs += QStringLiteral(
"<h3>" ) + def->description() + QStringLiteral(
"</h3>\n" );
1244 outputs += QStringLiteral(
"<p>" ) + getText( def->name() ) + QStringLiteral(
"</p>\n" );
1247 if ( !outputs.isEmpty() )
1248 s += QStringLiteral(
"<h2>" ) + QObject::tr(
"Outputs" ) + QStringLiteral(
"</h2>\n" ) + outputs;
1250 if ( !map.value( QStringLiteral(
"EXAMPLES" ) ).toString().isEmpty() )
1251 s += QStringLiteral(
"<h2>%1</h2>\n<p>%2</p>" ).arg( QObject::tr(
"Examples" ), getText( QStringLiteral(
"EXAMPLES" ) ) );
1253 s += QLatin1String(
"<br>" );
1254 if ( !map.value( QStringLiteral(
"ALG_CREATOR" ) ).toString().isEmpty() )
1255 s += QStringLiteral(
"<p align=\"right\">" ) + QObject::tr(
"Algorithm author:" ) + QStringLiteral(
" " ) + getText( QStringLiteral(
"ALG_CREATOR" ) ) + QStringLiteral(
"</p>" );
1256 if ( !map.value( QStringLiteral(
"ALG_HELP_CREATOR" ) ).toString().isEmpty() )
1257 s += QStringLiteral(
"<p align=\"right\">" ) + QObject::tr(
"Help author:" ) + QStringLiteral(
" " ) + getText( QStringLiteral(
"ALG_HELP_CREATOR" ) ) + QStringLiteral(
"</p>" );
1258 if ( !map.value( QStringLiteral(
"ALG_VERSION" ) ).toString().isEmpty() )
1259 s += QStringLiteral(
"<p align=\"right\">" ) + QObject::tr(
"Algorithm version:" ) + QStringLiteral(
" " ) + getText( QStringLiteral(
"ALG_VERSION" ) ) + QStringLiteral(
"</p>" );
1261 s += QLatin1String(
"</body></html>" );
1266 long long featureLimit,
const QString &filterExpression )
1268 bool requiresTranslation =
false;
1272 requiresTranslation = requiresTranslation || selectedFeaturesOnly;
1275 requiresTranslation = requiresTranslation || featureLimit != -1 || !filterExpression.isEmpty();
1280 requiresTranslation = requiresTranslation || vl->
providerType() != QLatin1String(
"ogr" );
1284 requiresTranslation = requiresTranslation || !vl->
subsetString().isEmpty();
1288 requiresTranslation = requiresTranslation || vl->
source().startsWith( QLatin1String(
"/vsi" ) );
1292 if ( !requiresTranslation )
1295 if ( parts.contains( QStringLiteral(
"path" ) ) )
1297 diskPath = parts.value( QStringLiteral(
"path" ) ).toString();
1298 QFileInfo fi( diskPath );
1299 requiresTranslation = !compatibleFormats.contains( fi.suffix(), Qt::CaseInsensitive );
1303 const QString srcLayerName = parts.value( QStringLiteral(
"layerName" ) ).toString();
1307 *layerName = srcLayerName;
1312 requiresTranslation = requiresTranslation || ( !srcLayerName.isEmpty() && srcLayerName != fi.baseName() );
1317 requiresTranslation =
true;
1321 if ( requiresTranslation )
1332 if ( featureLimit != -1 )
1336 if ( !filterExpression.isEmpty() )
1341 if ( selectedFeaturesOnly )
1362 return convertToCompatibleFormatInternal( vl, selectedFeaturesOnly, baseName, compatibleFormats, preferredFormat, context, feedback,
nullptr, featureLimit, filterExpression );
1368 return convertToCompatibleFormatInternal( layer, selectedFeaturesOnly, baseName, compatibleFormats, preferredFormat, context, feedback, &layerName, featureLimit, filterExpression );
1374 QSet< QString > usedNames;
1375 for (
const QgsField &f : fieldsA )
1377 usedNames.insert( f.name().toLower() );
1380 for (
const QgsField &f : fieldsB )
1383 newField.
setName( fieldsBPrefix + f.name() );
1384 if ( usedNames.contains( newField.
name().toLower() ) )
1387 QString newName = newField.
name() +
'_' + QString::number( idx );
1388 while ( usedNames.contains( newName.toLower() ) || fieldsB.
indexOf( newName ) != -1 )
1391 newName = newField.
name() +
'_' + QString::number( idx );
1394 outFields.
append( newField );
1398 outFields.
append( newField );
1400 usedNames.insert( newField.
name() );
1410 if ( !fieldNames.isEmpty() )
1412 indices.reserve( fieldNames.count() );
1413 for (
const QString &f : fieldNames )
1417 indices.append( idx );
1422 indices.reserve( fields.
count() );
1423 for (
int i = 0; i < fields.
count(); ++i )
1424 indices.append( i );
1433 for (
int i : indices )
1434 fieldsSubset.
append( fields.
at( i ) );
1435 return fieldsSubset;
1441 if ( setting == -1 )
1442 return QStringLiteral(
"gpkg" );
1449 if ( setting == -1 )
1450 return QStringLiteral(
"tif" );
1456 return QStringLiteral(
"las" );
1461 return QStringLiteral(
"mbtiles" );
1466 auto layerPointerToString = [](
QgsMapLayer * layer ) -> QString
1468 if ( layer && layer->
providerType() == QLatin1String(
"memory" ) )
1476 auto cleanPointerValues = [&layerPointerToString](
const QVariant & value ) -> QVariant
1478 if (
QgsMapLayer *layer = qobject_cast< QgsMapLayer * >( value.value< QObject * >() ) )
1481 return layerPointerToString( layer );
1483 else if ( value.userType() == QMetaType::type(
"QPointer< QgsMapLayer >" ) )
1486 return layerPointerToString( value.value< QPointer< QgsMapLayer > >().data() );
1495 for (
auto it = map.constBegin(); it != map.constEnd(); ++it )
1497 if ( it->type() == QVariant::Map )
1501 else if ( it->type() == QVariant::List )
1504 const QVariantList source = it.value().toList();
1505 dest.reserve( source.size() );
1506 for (
const QVariant &v : source )
1508 dest.append( cleanPointerValues( v ) );
1510 res.insert( it.key(), dest );
1514 res.insert( it.key(), cleanPointerValues( it.value() ) );
1524 for (
auto it = parameters.constBegin(); it != parameters.constEnd(); ++it )
1526 if ( it.value().type() == QVariant::Map )
1528 const QVariantMap value = it.value().toMap();
1529 if ( value.value( QStringLiteral(
"type" ) ).toString() == QLatin1String(
"data_defined" ) )
1531 const QString expression = value.value( QStringLiteral(
"expression" ) ).toString();
1532 const QString field = value.value( QStringLiteral(
"field" ) ).toString();
1533 if ( !expression.isEmpty() )
1537 else if ( !field.isEmpty() )
1544 error = QObject::tr(
"Invalid data defined parameter for %1, requires 'expression' or 'field' values." ).arg( it.key() );
1549 output.insert( it.key(), it.value() );
1552 else if ( it.value().type() == QVariant::String )
1554 const QString stringValue = it.value().toString();
1556 if ( stringValue.startsWith( QLatin1String(
"field:" ) ) )
1560 else if ( stringValue.startsWith( QLatin1String(
"expression:" ) ) )
1566 output.insert( it.key(), it.value() );
1571 output.insert( it.key(), it.value() );
1579 if ( ! QTextCodec::availableCodecs().contains( defaultEncoding.toLatin1() ) )
1581 const QString systemCodec = QTextCodec::codecForLocale()->name();
1582 if ( ! systemCodec.isEmpty() )
1586 return QString(
"UTF-8" );
1589 return defaultEncoding;
1597 : mSource( originalSource )
1598 , mOwnsSource( ownsOriginalSource )
1599 , mSourceCrs( mSource->sourceCrs() )
1600 , mSourceFields( mSource->fields() )
1601 , mSourceWkbType( mSource->wkbType() )
1602 , mSourceName( mSource->sourceName() )
1603 , mSourceExtent( mSource->sourceExtent() )
1604 , mSourceSpatialIndexPresence( mSource->hasSpatialIndex() )
1605 , mInvalidGeometryCheck(
QgsWkbTypes::geometryType( mSource->wkbType() ) ==
Qgis::GeometryType::Point
1607 : context.invalidGeometryCheck() )
1608 , mInvalidGeometryCallback( context.invalidGeometryCallback( originalSource ) )
1609 , mTransformErrorCallback( context.transformErrorCallback() )
1610 , mInvalidGeometryCallbackSkip( context.defaultInvalidGeometryCallbackForCheck(
QgsFeatureRequest::GeometrySkipInvalid, originalSource ) )
1611 , mInvalidGeometryCallbackAbort( context.defaultInvalidGeometryCallbackForCheck(
QgsFeatureRequest::GeometryAbortOnInvalid, originalSource ) )
1612 , mFeatureLimit( featureLimit )
1613 , mFilterExpression( filterExpression )
1635 if ( mFeatureLimit != -1 && req.
limit() != -1 )
1636 req.
setLimit( std::min(
static_cast< long long >( req.
limit() ), mFeatureLimit ) );
1637 else if ( mFeatureLimit != -1 )
1640 if ( !mFilterExpression.isEmpty() )
1652 return sourceAvailability;
1665 if ( mFeatureLimit != -1 && req.
limit() != -1 )
1666 req.
setLimit( std::min(
static_cast< long long >( req.
limit() ), mFeatureLimit ) );
1667 else if ( mFeatureLimit != -1 )
1670 if ( !mFilterExpression.isEmpty() )
1683 return mSourceFields;
1688 return mSourceWkbType;
1693 if ( !mFilterExpression.isEmpty() )
1696 if ( mFeatureLimit == -1 )
1699 return std::min( mFeatureLimit, mSource->
featureCount() );
1709 if ( mFilterExpression.isEmpty() )
1714 if ( fieldIndex < 0 || fieldIndex >=
fields().count() )
1715 return QSet<QVariant>();
1722 QSet<QVariant> values;
1727 values.insert( f.
attribute( fieldIndex ) );
1728 if ( limit > 0 && values.size() >= limit )
1736 if ( mFilterExpression.isEmpty() )
1741 if ( fieldIndex < 0 || fieldIndex >=
fields().count() )
1753 const QVariant v = f.
attribute( fieldIndex );
1764 if ( mFilterExpression.isEmpty() )
1769 if ( fieldIndex < 0 || fieldIndex >=
fields().count() )
1781 const QVariant v = f.
attribute( fieldIndex );
1792 return mSourceExtent;
1797 if ( mFilterExpression.isEmpty() )
1803 .setFilterExpression( mFilterExpression ) );
1818 return mSourceSpatialIndexPresence;
1829 return expressionContextScope;
1834 mInvalidGeometryCheck = method;
1835 switch ( mInvalidGeometryCheck )
1838 mInvalidGeometryCallback =
nullptr;
1842 mInvalidGeometryCallback = mInvalidGeometryCallbackSkip;
1846 mInvalidGeometryCallback = mInvalidGeometryCallbackAbort;
1858 , mContext( context )
1859 , mSinkName( sinkName )
1860 , mOwnsSink( ownsOriginalSink )
1872 if ( !result && mContext.
feedback() )
1875 if ( !error.isEmpty() )
1876 mContext.
feedback()->
reportError( QObject::tr(
"Feature could not be written to %1: %2" ).arg( mSinkName, error ) );
1878 mContext.
feedback()->
reportError( QObject::tr(
"Feature could not be written to %1" ).arg( mSinkName ) );
1886 if ( !result && mContext.
feedback() )
1889 if ( !error.isEmpty() )
1890 mContext.
feedback()->
reportError( QObject::tr(
"%n feature(s) could not be written to %1: %2",
nullptr, features.count() ).arg( mSinkName, error ) );
1892 mContext.
feedback()->
reportError( QObject::tr(
"%n feature(s) could not be written to %1",
nullptr, features.count() ).arg( mSinkName ) );
1900 if ( !result && mContext.
feedback() )
1903 if ( !error.isEmpty() )
1904 mContext.
feedback()->
reportError( QObject::tr(
"Features could not be written to %1: %2" ).arg( mSinkName, error ) );
1906 mContext.
feedback()->
reportError( QObject::tr(
"Features could not be written to %1" ).arg( mSinkName ) );
The Qgis class provides global constants for use throughout the application.
@ FieldComments
Writer can support field comments.
@ FieldAliases
Writer can support field aliases.
@ EditAlias
Allows editing aliases.
@ EditComment
Allows editing comments.
@ Success
No errors were encountered.
@ TiledScene
Tiled scene layer. Added in QGIS 3.34.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
WkbType
The WKB type describes the number of dimensions a geometry has.
@ NoSymbology
Export only data.
Represents a map layer containing a set of georeferenced annotations, e.g.
This class represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
bool createFromString(const QString &definition)
Set up this CRS from a string definition.
Contains information about the context in which a coordinate transform is executed.
Custom exception class for Coordinate Reference System related exceptions.
Class for storing the component parts of a RDBMS data source URI (e.g.
QByteArray encodedUri() const
Returns the complete encoded URI as a byte array.
QString table() const
Returns the table name stored in the URI.
void setParam(const QString &key, const QString &value)
Sets a generic parameter value on the URI.
QString database() const
Returns the database name stored in the URI.
Abstract interface for generating an expression context scope.
virtual QgsExpressionContextScope * createExpressionContextScope() const =0
This method needs to be reimplemented in all classes which implement this interface and return an exp...
Single scope for storing variables and functions for use within a QgsExpressionContext.
void setFields(const QgsFields &fields)
Convenience function for setting a fields for the context.
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setLimit(long long limit)
Set the maximum number of features to request.
InvalidGeometryCheck
Handling of features with invalid geometries.
@ GeometryNoCheck
No invalid geometry checking.
@ GeometryAbortOnInvalid
Close iterator on encountering any features with invalid geometry. This requires a slow geometry vali...
@ GeometrySkipInvalid
Skip any features with invalid geometry. This requires a slow geometry validity check for every featu...
long long limit() const
Returns the maximum number of features to request, or -1 if no limit set.
QgsFeatureRequest & combineFilterExpression(const QString &expression)
Modifies the existing filter expression to add an additional expression filter.
QgsFeatureRequest & setFlags(QgsFeatureRequest::Flags flags)
Sets flags that affect how features will be fetched.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
QgsFeatureRequest & setInvalidGeometryCallback(const std::function< void(const QgsFeature &)> &callback)
Sets a callback function to use when encountering an invalid geometry and invalidGeometryCheck() is s...
QgsFeatureRequest & setInvalidGeometryCheck(InvalidGeometryCheck check)
Sets invalid geometry checking behavior.
QgsFeatureRequest & setTransformErrorCallback(const std::function< void(const QgsFeature &)> &callback)
Sets a callback function to use when encountering a transform error when iterating features and a des...
An interface for objects which accept features via addFeature(s) methods.
@ FastInsert
Use faster inserts, at the cost of updating the passed features to reflect changes made at the provid...
@ RegeneratePrimaryKey
This flag indicates, that a primary key field cannot be guaranteed to be unique and the sink should i...
An interface for objects which provide features via a getFeatures method.
virtual QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const
Returns the set of unique values contained within the specified fieldIndex from this source.
SpatialIndexPresence
Enumeration of spatial index presence states.
virtual FeatureAvailability hasFeatures() const
Determines if there are any features available in the source.
FeatureAvailability
Possible return value for hasFeatures() to determine if a source is empty.
@ FeaturesMaybeAvailable
There may be features available in this source.
@ NoFeaturesAvailable
There are certainly no features available in this source.
virtual QVariant minimumValue(int fieldIndex) const
Returns the minimum value for an attribute column or an invalid variant in case of error.
virtual QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const =0
Returns an iterator for the features in the source.
virtual QVariant maximumValue(int fieldIndex) const
Returns the maximum value for an attribute column or an invalid variant in case of error.
virtual long long featureCount() const =0
Returns the number of features contained in the source, or -1 if the feature count is unknown.
virtual QgsFeatureIds allFeatureIds() const
Returns a list of all feature IDs for features present in the source.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
bool isCanceled() const
Tells whether the operation has been canceled already.
Encapsulate a field in an attribute table or data source.
void setName(const QString &name)
Set the field name.
Container of fields for a vector layer.
bool append(const QgsField &field, FieldOrigin origin=OriginProvider, int originIndex=-1)
Appends a field. The field must have unique name, otherwise it is rejected (returns false)
int indexOf(const QString &fieldName) const
Gets the field index from the field name.
int count() const
Returns number of items.
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
static QString stringToSafeFilename(const QString &string)
Converts a string to a safe filename, replacing characters which are not safe for filenames with an '...
A storage object for map layers, in which the layers are owned by the store and have their lifetime b...
QMap< QString, QgsMapLayer * > mapLayers() const
Returns a map of all layers by layer ID.
QgsMapLayer * addMapLayer(QgsMapLayer *layer, bool takeOwnership=true)
Add a layer to the store.
Base class for all map layer types.
QString source() const
Returns the source for the layer.
QString providerType() const
Returns the provider type (provider key) for this layer.
QgsCoordinateReferenceSystem crs
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
virtual void setTransformContext(const QgsCoordinateTransformContext &transformContext)=0
Sets the coordinate transform context to transformContext.
static QgsVectorLayer * createMemoryLayer(const QString &name, const QgsFields &fields, Qgis::WkbType geometryType=Qgis::WkbType::NoGeometry, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem(), bool loadDefaultStyle=true) SIP_FACTORY
Creates a new memory layer using the specified parameters.
Represents a mesh layer supporting display of data on structured or unstructured meshes.
QgsMeshDataProvider * dataProvider() override
Returns the layer's data provider, it may be nullptr.
Base class for plugin layers.
Represents a map layer supporting display of point clouds.
A class to represent a 2D point.
Abstract base class for processing algorithms.
QgsProcessingOutputDefinitions outputDefinitions() const
Returns an ordered list of output definitions utilized by the algorithm.
QgsProcessingParameterDefinitions parameterDefinitions() const
Returns an ordered list of parameter definitions utilized by the algorithm.
Contains information about the context in which a processing algorithm is executed.
QString defaultEncoding() const
Returns the default encoding to use for newly created files.
QgsProcessingFeedback * feedback()
Returns the associated feedback object.
QgsExpressionContext & expressionContext()
Returns the expression context.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
QgsProject * project() const
Returns the project in which the algorithm is being executed.
QgsMapLayerStore * temporaryLayerStore()
Returns a reference to the layer store used for storing temporary layers during algorithm execution.
QString temporaryFolder() const
Returns the (optional) temporary folder to use when running algorithms.
Custom exception class for processing related exceptions.
QgsProxyFeatureSink subclass which reports feature addition errors to a QgsProcessingContext.
~QgsProcessingFeatureSink() override
QgsProcessingFeatureSink(QgsFeatureSink *originalSink, const QString &sinkName, QgsProcessingContext &context, bool ownsOriginalSink=false)
Constructor for QgsProcessingFeatureSink, accepting an original feature sink originalSink and process...
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features to the sink.
bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a single feature to the sink.
Encapsulates settings relating to a feature source input to a processing algorithm.
Flags flags
Flags which dictate source behavior.
bool selectedFeaturesOnly
true if only selected features in the source should be used by algorithms.
QgsFeatureRequest::InvalidGeometryCheck geometryCheck
Geometry check method to apply to this source.
QgsProperty source
Source definition.
long long featureLimit
If set to a value > 0, places a limit on the maximum number of features which will be read from the s...
@ FlagOverrideDefaultGeometryCheck
If set, the default geometry check method (as dictated by QgsProcessingContext) will be overridden fo...
QString filterExpression
Optional expression filter to use for filtering features which will be read from the source.
QgsFeatureSource subclass which proxies methods to an underlying QgsFeatureSource,...
QgsRectangle sourceExtent() const override
Returns the extent of all geometries from the source.
QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const override
Returns the set of unique values contained within the specified fieldIndex from this source.
QgsExpressionContextScope * createExpressionContextScope() const
Returns an expression context scope suitable for this source.
QgsProcessingFeatureSource(QgsFeatureSource *originalSource, const QgsProcessingContext &context, bool ownsOriginalSource=false, long long featureLimit=-1, const QString &filterExpression=QString())
Constructor for QgsProcessingFeatureSource, accepting an original feature source originalSource and p...
QgsFeatureSource::FeatureAvailability hasFeatures() const override
Determines if there are any features available in the source.
QVariant maximumValue(int fieldIndex) const override
Returns the maximum value for an attribute column or an invalid variant in case of error.
~QgsProcessingFeatureSource() override
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request, Flags flags) const
Returns an iterator for the features in the source, respecting the supplied feature flags.
QgsCoordinateReferenceSystem sourceCrs() const override
Returns the coordinate reference system for features in the source.
Qgis::WkbType wkbType() const override
Returns the geometry type for features returned by this source.
QVariant minimumValue(int fieldIndex) const override
Returns the minimum value for an attribute column or an invalid variant in case of error.
long long featureCount() const override
Returns the number of features contained in the source, or -1 if the feature count is unknown.
@ FlagSkipGeometryValidityChecks
Invalid geometry checks should always be skipped. This flag can be useful for algorithms which always...
QString sourceName() const override
Returns a friendly display name for the source.
SpatialIndexPresence hasSpatialIndex() const override
Returns an enum value representing the presence of a valid spatial index on the source,...
QgsFeatureIds allFeatureIds() const override
Returns a list of all feature IDs for features present in the source.
QgsFields fields() const override
Returns the fields associated with features in the source.
void setInvalidGeometryCheck(QgsFeatureRequest::InvalidGeometryCheck method)
Overrides the default geometry check method for the source.
Base class for providing feedback from a processing algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
Base class for the definition of processing outputs.
Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.
QgsProperty sink
Sink/layer definition.
Base class for the definition of processing parameters.
@ FlagHidden
Parameter is hidden and should not be shown to users.
static QList< QgsTiledSceneLayer * > compatibleTiledSceneLayers(QgsProject *project, bool sort=true)
Returns a list of tiled scene layers from a project which are compatible with the processing framewor...
static QString stringToPythonLiteral(const QString &string)
Converts a string to a Python string literal.
static QString defaultVectorExtension()
Returns the default vector extension to use, in the absence of all other constraints (e....
static QVariant generateIteratingDestination(const QVariant &input, const QVariant &id, QgsProcessingContext &context)
Converts an input parameter value for use in source iterating mode, where one individual sink is crea...
static QgsFields indicesToFields(const QList< int > &indices, const QgsFields &fields)
Returns a subset of fields based on the indices of desired fields.
static QList< int > fieldNamesToIndices(const QStringList &fieldNames, const QgsFields &fields)
Returns a list of field indices parsed from the given list of field names.
static QVariantMap preprocessQgisProcessParameters(const QVariantMap ¶meters, bool &ok, QString &error)
Pre-processes a set of parameter values for the qgis_process command.
static QList< QgsAnnotationLayer * > compatibleAnnotationLayers(QgsProject *project, bool sort=true)
Returns a list of annotation layers from a project which are compatible with the processing framework...
static QString generateTempFilename(const QString &basename, const QgsProcessingContext *context=nullptr)
Returns a temporary filename for a given file, putting it into a temporary folder (creating that fold...
static QString normalizeLayerSource(const QString &source)
Normalizes a layer source string for safe comparison across different operating system environments.
static QString formatHelpMapAsHtml(const QVariantMap &map, const QgsProcessingAlgorithm *algorithm)
Returns a HTML formatted version of the help text encoded in a variant map for a specified algorithm.
static QgsFields combineFields(const QgsFields &fieldsA, const QgsFields &fieldsB, const QString &fieldsBPrefix=QString())
Combines two field lists, avoiding duplicate field names (in a case-insensitive manner).
static QString encodeProviderKeyAndUri(const QString &providerKey, const QString &uri)
Encodes a provider key and layer uri to a single string, for use with decodeProviderKeyAndUri()
LayerHint
Layer type hints.
@ TiledScene
Tiled scene layer type, since QGIS 3.34.
@ Annotation
Annotation layer type, since QGIS 3.22.
@ Vector
Vector layer type.
@ VectorTile
Vector tile layer type, since QGIS 3.32.
@ Mesh
Mesh layer type, since QGIS 3.6.
@ Raster
Raster layer type.
@ UnknownType
Unknown layer type.
@ PointCloud
Point cloud layer type, since QGIS 3.22.
static QgsProcessingFeatureSource * variantToSource(const QVariant &value, QgsProcessingContext &context, const QVariant &fallbackValue=QVariant())
Converts a variant value to a new feature source.
static QList< QgsRasterLayer * > compatibleRasterLayers(QgsProject *project, bool sort=true)
Returns a list of raster layers from a project which are compatible with the processing framework.
static QgsRectangle combineLayerExtents(const QList< QgsMapLayer * > &layers, const QgsCoordinateReferenceSystem &crs, QgsProcessingContext &context)
Combines the extent of several map layers.
static QString resolveDefaultEncoding(const QString &defaultEncoding="System")
Returns the default encoding.
static QList< QgsPluginLayer * > compatiblePluginLayers(QgsProject *project, bool sort=true)
Returns a list of plugin layers from a project which are compatible with the processing framework.
static QString variantToPythonLiteral(const QVariant &value)
Converts a variant to a Python literal.
static QgsCoordinateReferenceSystem variantToCrs(const QVariant &value, QgsProcessingContext &context, const QVariant &fallbackValue=QVariant())
Converts a variant value to a coordinate reference system.
static QList< QgsVectorLayer * > compatibleVectorLayers(QgsProject *project, const QList< int > &sourceTypes=QList< int >(), bool sort=true)
Returns a list of vector layers from a project which are compatible with the processing framework.
static QVariantMap removePointerValuesFromMap(const QVariantMap &map)
Removes any raw pointer values from an input map, replacing them with appropriate string values where...
static bool decodeProviderKeyAndUri(const QString &string, QString &providerKey, QString &uri)
Decodes a provider key and layer uri from an encoded string, for use with encodeProviderKeyAndUri()
static void createFeatureSinkPython(QgsFeatureSink **sink, QString &destination, QgsProcessingContext &context, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &crs, const QVariantMap &createOptions=QVariantMap())
Creates a feature sink ready for adding features.
static QList< QgsVectorTileLayer * > compatibleVectorTileLayers(QgsProject *project, bool sort=true)
Returns a list of vector tile layers from a project which are compatible with the processing framewor...
static QString convertToCompatibleFormatAndLayerName(const QgsVectorLayer *layer, bool selectedFeaturesOnly, const QString &baseName, const QStringList &compatibleFormats, const QString &preferredFormat, QgsProcessingContext &context, QgsProcessingFeedback *feedback, QString &layerName, long long featureLimit=-1, const QString &filterExpression=QString())
Converts a source vector layer to a file path and layer name of a vector layer of compatible format.
static QList< QgsMapLayer * > compatibleLayers(QgsProject *project, bool sort=true)
Returns a list of map layers from a project which are compatible with the processing framework.
static QString convertToCompatibleFormat(const QgsVectorLayer *layer, bool selectedFeaturesOnly, const QString &baseName, const QStringList &compatibleFormats, const QString &preferredFormat, QgsProcessingContext &context, QgsProcessingFeedback *feedback, long long featureLimit=-1, const QString &filterExpression=QString())
Converts a source vector layer to a file path of a vector layer of compatible format.
static QgsFeatureSink * createFeatureSink(QString &destination, QgsProcessingContext &context, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &crs, const QVariantMap &createOptions=QVariantMap(), const QStringList &datasourceOptions=QStringList(), const QStringList &layerOptions=QStringList(), QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), QgsRemappingSinkDefinition *remappingDefinition=nullptr)
Creates a feature sink ready for adding features.
static QString defaultRasterExtension()
Returns the default raster extension to use, in the absence of all other constraints (e....
static QString defaultVectorTileExtension()
Returns the default vector tile extension to use, in the absence of all other constraints (e....
static QgsMapLayer * mapLayerFromString(const QString &string, QgsProcessingContext &context, bool allowLoadingNewLayers=true, QgsProcessingUtils::LayerHint typeHint=QgsProcessingUtils::LayerHint::UnknownType, QgsProcessing::LayerOptionsFlags flags=QgsProcessing::LayerOptionsFlags())
Interprets a string as a map layer within the supplied context.
static QString defaultPointCloudExtension()
Returns the default point cloud extension to use, in the absence of all other constraints (e....
static QList< QgsPointCloudLayer * > compatiblePointCloudLayers(QgsProject *project, bool sort=true)
Returns a list of point cloud layers from a project which are compatible with the processing framewor...
static QList< QgsMeshLayer * > compatibleMeshLayers(QgsProject *project, bool sort=true)
Returns a list of mesh layers from a project which are compatible with the processing framework.
static QString tempFolder(const QgsProcessingContext *context=nullptr)
Returns a session specific processing temporary folder for use in processing algorithms.
static const QgsSettingsEntryInteger * settingsDefaultOutputRasterLayerExt
Settings entry default output raster layer ext.
static const QgsSettingsEntryInteger * settingsDefaultOutputVectorLayerExt
Settings entry default output vector layer ext.
static const QgsSettingsEntryString * settingsTempPath
Settings entry temp path.
static const QString TEMPORARY_OUTPUT
Constant used to indicate that a Processing algorithm output should be a temporary layer/file.
@ TypeVectorLine
Vector line layers.
@ TypeVectorPolygon
Vector polygon layers.
@ TypeVector
Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink ha...
@ TypeVectorPoint
Vector point layers.
@ TypeVectorAnyGeometry
Any vector layer with geometry.
@ SkipIndexGeneration
Do not generate index when creating a layer. Makes sense only for point cloud layers.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
QgsAnnotationLayer * mainAnnotationLayer()
Returns the main annotation layer associated with the project.
QVector< T > layers() const
Returns a list of registered map layers with a specified layer type.
QgsCoordinateReferenceSystem crs
A store for object properties.
@ StaticProperty
Static property (QgsStaticProperty)
QString asExpression() const
Returns an expression string representing the state of the property, or an empty string if the proper...
QVariant value(const QgsExpressionContext &context, const QVariant &defaultValue=QVariant(), bool *ok=nullptr) const
Calculates the current value of the property, including any transforms which are set for the property...
static QgsProperty fromExpression(const QString &expression, bool isActive=true)
Returns a new ExpressionBasedProperty created from the specified expression.
Type propertyType() const
Returns the property type.
static QgsProperty fromField(const QString &fieldName, bool isActive=true)
Returns a new FieldBasedProperty created from the specified field name.
static QgsProperty fromValue(const QVariant &value, bool isActive=true)
Returns a new StaticProperty created from the specified value.
QVariantMap decodeUri(const QString &providerKey, const QString &uri)
Breaks a provider data source URI into its component paths (e.g.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
QList< QgsProviderRegistry::ProviderCandidateDetails > preferredProvidersForUri(const QString &uri) const
Returns the details for the preferred provider(s) for opening the specified uri.
QString encodeUri(const QString &providerKey, const QVariantMap &parts)
Reassembles a provider data source URI from its component paths (e.g.
QgsProviderMetadata * providerMetadata(const QString &providerKey) const
Returns metadata of the provider or nullptr if not found.
A simple feature sink which proxies feature addition on to another feature sink.
bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a single feature to the sink.
QString lastError() const override
Returns the most recent error encountered by the sink, e.g.
QgsFeatureSink * destinationSink()
Returns the destination QgsFeatureSink which the proxy will forward features to.
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features to the sink.
static QStringList supportedFormatExtensions(RasterFormatOptions options=SortRecommended)
Returns a list of file extensions for supported formats.
Represents a raster layer.
A rectangle specified with double values.
double xMinimum() const
Returns the x minimum value (left side of rectangle).
double yMinimum() const
Returns the y minimum value (bottom side of rectangle).
double xMaximum() const
Returns the x maximum value (right side of rectangle).
double yMaximum() const
Returns the y maximum value (top side of rectangle).
void combineExtentWith(const QgsRectangle &rect)
Expands the rectangle so that it covers both the original rectangle and the given rectangle.
QgsCoordinateReferenceSystem crs() const
Returns the associated coordinate reference system, or an invalid CRS if no reference system is set.
A QgsPointXY with associated coordinate reference system.
A QgsRectangle with associated coordinate reference system.
Defines the parameters used to remap features when creating a QgsRemappingProxyFeatureSink.
void setDestinationCrs(const QgsCoordinateReferenceSystem &destination)
Sets the destination crs used for reprojecting incoming features to the sink's destination CRS.
void setDestinationWkbType(Qgis::WkbType type)
Sets the WKB geometry type for the destination.
void setDestinationFields(const QgsFields &fields)
Sets the fields for the destination sink.
T value(const QString &dynamicKeyPart=QString()) const
Returns settings value.
Represents a map layer supporting display of tiled scene objects.
static bool isNull(const QVariant &variant)
Returns true if the specified variant should be considered a NULL value.
Options to pass to writeAsVectorFormat()
QString fileEncoding
Encoding to use.
QString driverName
OGR driver to use.
QString layerName
Layer name. If let empty, it will be derived from the filename.
QStringList layerOptions
List of OGR layer creation options.
Qgis::FeatureSymbologyExport symbologyExport
Symbology to export.
QgsVectorFileWriter::ActionOnExistingFile actionOnExistingFile
Action on existing file.
QStringList datasourceOptions
List of OGR data source creation options.
static QStringList defaultLayerOptions(const QString &driverName)
Returns a list of the default layer options for a specified driver.
static QString driverForExtension(const QString &extension)
Returns the OGR driver name for a specified file extension.
static QgsVectorFileWriter * create(const QString &fileName, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &srs, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), QString *newFilename=nullptr, QString *newLayer=nullptr)
Create a new vector file writer.
static QStringList defaultDatasetOptions(const QString &driverName)
Returns a list of the default dataset options for a specified driver.
static QStringList supportedFormatExtensions(VectorFormatOptions options=SortRecommended)
Returns a list of file extensions for supported formats, e.g "shp", "gpkg".
@ CreateOrOverwriteFile
Create or overwrite file.
@ AppendToLayerNoNewFields
Append features to existing layer, but do not create new fields.
QgsFeatureSource subclass for the selected features from a QgsVectorLayer.
Represents a vector layer which manages a vector based data sets.
bool isSpatial() const FINAL
Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeome...
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
QgsFeatureIterator getSelectedFeatures(QgsFeatureRequest request=QgsFeatureRequest()) const
Returns an iterator of the selected features.
Q_INVOKABLE Qgis::GeometryType geometryType() const
Returns point, line or polygon.
QgsRectangle extent() const FINAL
Returns the extent of the layer.
Implements a map layer that is dedicated to rendering of vector tiles.
Handles storage of information regarding WKB types and their properties.
@ UnknownCount
Provider returned an unknown feature count.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call
bool qgsVariantLessThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is less than the second.
bool qgsVariantGreaterThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is greater than the second.
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
QList< QgsFeature > QgsFeatureList
QSet< QgsFeatureId > QgsFeatureIds
QList< int > QgsAttributeList
QString convertToCompatibleFormatInternal(const QgsVectorLayer *vl, bool selectedFeaturesOnly, const QString &baseName, const QStringList &compatibleFormats, const QString &preferredFormat, QgsProcessingContext &context, QgsProcessingFeedback *feedback, QString *layerName, long long featureLimit, const QString &filterExpression)
const QgsCoordinateReferenceSystem & crs
Setting options for loading mesh layers.
bool skipCrsValidation
Controls whether the layer is allowed to have an invalid/unknown CRS.
Setting options for loading point cloud layers.
bool skipCrsValidation
Controls whether the layer is allowed to have an invalid/unknown CRS.
bool skipIndexGeneration
Set to true if point cloud index generation should be skipped.
Setting options for loading raster layers.
bool skipCrsValidation
Controls whether the layer is allowed to have an invalid/unknown CRS.
bool loadDefaultStyle
Sets to true if the default layer style should be loaded.
Setting options for loading tiled scene layers.
bool skipCrsValidation
Controls whether the layer is allowed to have an invalid/unknown CRS.
Setting options for loading vector layers.