19#include "moc_qgsprocessingutils.cpp"
41#include <QRegularExpression>
47 return compatibleMapLayers< QgsRasterLayer >( project, sort );
53 return QList<QgsVectorLayer *>();
55 QList<QgsVectorLayer *> layers;
59 if ( canUseLayer( l, geometryTypes ) )
67 return QString::localeAwareCompare( a->name(), b->name() ) < 0;
75 return compatibleMapLayers< QgsMeshLayer >( project, sort );
80 return compatibleMapLayers< QgsPluginLayer >( project, sort );
85 return compatibleMapLayers< QgsPointCloudLayer >( project, sort );
91 QList<QgsAnnotationLayer *> res = compatibleMapLayers< QgsAnnotationLayer >( project,
false );
99 return QString::localeAwareCompare( a->name(), b->name() ) < 0;
108 return compatibleMapLayers< QgsVectorTileLayer >( project, sort );
113 return compatibleMapLayers< QgsTiledSceneLayer >( project, sort );
116template<
typename T> QList<T *> QgsProcessingUtils::compatibleMapLayers(
QgsProject *project,
bool sort )
122 const auto projectLayers = project->
layers<T *>();
123 for ( T *l : projectLayers )
125 if ( canUseLayer( l ) )
131 std::sort( layers.begin(), layers.end(), [](
const T * a,
const T * b ) ->
bool
133 return QString::localeAwareCompare( a->name(), b->name() ) < 0;
142 return QList<QgsMapLayer *>();
144 QList<QgsMapLayer *> layers;
146 const auto rasterLayers = compatibleMapLayers< QgsRasterLayer >( project,
false );
154 const auto meshLayers = compatibleMapLayers< QgsMeshLayer >( project,
false );
158 const auto pointCloudLayers = compatibleMapLayers< QgsPointCloudLayer >( project,
false );
162 const auto annotationLayers = compatibleMapLayers< QgsAnnotationLayer >( project,
false );
167 const auto vectorTileLayers = compatibleMapLayers< QgsVectorTileLayer >( project,
false );
171 const auto tiledSceneLayers = compatibleMapLayers< QgsTiledSceneLayer >( project,
false );
175 const auto pluginLayers = compatibleMapLayers< QgsPluginLayer >( project,
false );
183 return QString::localeAwareCompare( a->name(), b->name() ) < 0;
191 return QStringLiteral(
"%1://%2" ).arg( providerKey, uri );
196 const thread_local QRegularExpression re( QStringLiteral(
"^(\\w+?):\\/\\/(.+)$" ) );
197 const QRegularExpressionMatch match = re.match(
string );
198 if ( !match.hasMatch() )
201 providerKey = match.captured( 1 );
202 uri = match.captured( 2 );
210 if ( !store ||
string.isEmpty() )
213 QList< QgsMapLayer * > layers = store->
mapLayers().values();
215 layers.erase( std::remove_if( layers.begin(), layers.end(), [](
QgsMapLayer * layer )
217 switch ( layer->type() )
219 case Qgis::LayerType::Vector:
220 return !canUseLayer( qobject_cast< QgsVectorLayer * >( layer ) );
221 case Qgis::LayerType::Raster:
222 return !canUseLayer( qobject_cast< QgsRasterLayer * >( layer ) );
223 case Qgis::LayerType::Plugin:
224 case Qgis::LayerType::Group:
226 case Qgis::LayerType::Mesh:
227 return !canUseLayer( qobject_cast< QgsMeshLayer * >( layer ) );
228 case Qgis::LayerType::VectorTile:
229 return !canUseLayer( qobject_cast< QgsVectorTileLayer * >( layer ) );
230 case Qgis::LayerType::TiledScene:
231 return !canUseLayer( qobject_cast< QgsTiledSceneLayer * >( layer ) );
232 case Qgis::LayerType::PointCloud:
233 return !canUseLayer( qobject_cast< QgsPointCloudLayer * >( layer ) );
234 case Qgis::LayerType::Annotation:
235 return !canUseLayer( qobject_cast< QgsAnnotationLayer * >( layer ) );
240 auto isCompatibleType = [typeHint](
QgsMapLayer * l ) ->
bool
244 case LayerHint::UnknownType:
247 case LayerHint::Vector:
250 case LayerHint::Raster:
253 case LayerHint::Mesh:
256 case LayerHint::PointCloud:
259 case LayerHint::Annotation:
262 case LayerHint::VectorTile:
265 case LayerHint::TiledScene:
273 if ( isCompatibleType( l ) && l->id() ==
string )
278 if ( isCompatibleType( l ) && l->name() ==
string )
283 if ( isCompatibleType( l ) && normalizeLayerSource( l->source() ) == normalizeLayerSource(
string ) )
300 if ( providerMetadata )
303 const QVariantMap parts = providerMetadata->
decodeUri( uri );
304 const QString layerName = parts.value( QStringLiteral(
"layerName" ) ).toString();
306 if ( !layerName.isEmpty() )
310 else if (
const QString path = parts.value( QStringLiteral(
"path" ) ).toString(); !path.isEmpty() )
312 name = QFileInfo( path ).baseName();
317 const QStringList components = uri.split(
'|' );
318 if ( components.isEmpty() )
321 if ( QFileInfo fi( components.at( 0 ) ); fi.isFile() )
322 name = fi.baseName();
324 name = QFileInfo( uri ).baseName();
327 if ( name.isEmpty() )
331 if ( name.isEmpty() )
336 QList< Qgis::LayerType > candidateTypes;
341 if ( providerMetadata )
375 options.loadDefaultStyle =
false;
376 options.skipCrsValidation =
true;
378 std::unique_ptr< QgsVectorLayer > layer;
379 if ( providerMetadata )
381 layer = std::make_unique<QgsVectorLayer>( uri, name, providerMetadata->
key(), options );
386 layer = std::make_unique<QgsVectorLayer>( uri, name, QStringLiteral(
"ogr" ), options );
388 if ( layer->isValid() )
390 return layer.release();
399 std::unique_ptr< QgsRasterLayer > rasterLayer;
400 if ( providerMetadata )
402 rasterLayer = std::make_unique< QgsRasterLayer >( uri, name, providerMetadata->
key(), rasterOptions );
407 rasterLayer = std::make_unique< QgsRasterLayer >( uri, name, QStringLiteral(
"gdal" ), rasterOptions );
410 if ( rasterLayer->isValid() )
412 return rasterLayer.release();
420 std::unique_ptr< QgsMeshLayer > meshLayer;
421 if ( providerMetadata )
423 meshLayer = std::make_unique< QgsMeshLayer >( uri, name, providerMetadata->
key(), meshOptions );
427 meshLayer = std::make_unique< QgsMeshLayer >( uri, name, QStringLiteral(
"mdal" ), meshOptions );
429 if ( meshLayer->isValid() )
431 return meshLayer.release();
444 std::unique_ptr< QgsPointCloudLayer > pointCloudLayer;
445 if ( providerMetadata )
447 pointCloudLayer = std::make_unique< QgsPointCloudLayer >( uri, name, providerMetadata->
key(), pointCloudOptions );
452 if ( !preferredProviders.empty() )
454 pointCloudLayer = std::make_unique< QgsPointCloudLayer >( uri, name, preferredProviders.at( 0 ).metadata()->key(), pointCloudOptions );
464 pointCloudLayer = std::make_unique< QgsPointCloudLayer >( uri, name, QStringLiteral(
"pdal" ), pointCloudOptions );
468 if ( pointCloudLayer && pointCloudLayer->isValid() )
470 return pointCloudLayer.release();
476 dsUri.
setParam(
"type",
"mbtiles" );
479 std::unique_ptr< QgsVectorTileLayer > tileLayer;
480 tileLayer = std::make_unique< QgsVectorTileLayer >( dsUri.
encodedUri(), name );
482 if ( tileLayer->isValid() )
484 return tileLayer.release();
492 std::unique_ptr< QgsTiledSceneLayer > tiledSceneLayer;
493 if ( providerMetadata )
495 tiledSceneLayer = std::make_unique< QgsTiledSceneLayer >( uri, name, providerMetadata->
key(), tiledSceneOptions );
500 if ( !preferredProviders.empty() )
502 tiledSceneLayer = std::make_unique< QgsTiledSceneLayer >( uri, name, preferredProviders.at( 0 ).metadata()->key(), tiledSceneOptions );
505 if ( tiledSceneLayer && tiledSceneLayer->isValid() )
507 return tiledSceneLayer.release();
515 if (
string.isEmpty() )
523 if (
auto *lProject = context.
project() )
525 QgsMapLayer *layer = mapLayerFromStore(
string, lProject->layerStore(), typeHint );
534 if ( !allowLoadingNewLayers )
537 layer = loadMapLayerFromString(
string, context.
transformContext(), typeHint, flags );
551 QVariant val = value;
552 bool selectedFeaturesOnly =
false;
553 long long featureLimit = -1;
554 QString filterExpression;
555 bool overrideGeometryCheck =
false;
557 if ( val.userType() == qMetaTypeId<QgsProcessingFeatureSourceDefinition>() )
568 else if ( val.userType() == qMetaTypeId<QgsProcessingOutputLayerDefinition>() )
575 if (
QgsVectorLayer *layer = qobject_cast< QgsVectorLayer * >( qvariant_cast<QObject *>( val ) ) )
577 std::unique_ptr< QgsProcessingFeatureSource> source = std::make_unique< QgsProcessingFeatureSource >( layer, context,
false, featureLimit, filterExpression );
578 if ( overrideGeometryCheck )
579 source->setInvalidGeometryCheck( geometryCheck );
580 return source.release();
584 if ( val.userType() == qMetaTypeId<QgsProperty>() )
588 else if ( !val.isValid() || val.toString().isEmpty() )
591 if (
QgsVectorLayer *layer = qobject_cast< QgsVectorLayer * >( qvariant_cast<QObject *>( fallbackValue ) ) )
593 std::unique_ptr< QgsProcessingFeatureSource> source = std::make_unique< QgsProcessingFeatureSource >( layer, context,
false, featureLimit, filterExpression );
594 if ( overrideGeometryCheck )
595 source->setInvalidGeometryCheck( geometryCheck );
596 return source.release();
599 layerRef = fallbackValue.toString();
603 layerRef = val.toString();
606 if ( layerRef.isEmpty() )
613 std::unique_ptr< QgsProcessingFeatureSource> source;
614 if ( selectedFeaturesOnly )
620 source = std::make_unique< QgsProcessingFeatureSource >( vl, context,
false, featureLimit, filterExpression );
623 if ( overrideGeometryCheck )
624 source->setInvalidGeometryCheck( geometryCheck );
625 return source.release();
630 QVariant val = value;
632 if ( val.userType() == qMetaTypeId<QgsCoordinateReferenceSystem>() )
637 else if ( val.userType() == qMetaTypeId<QgsProcessingFeatureSourceDefinition>() )
643 else if ( val.userType() == qMetaTypeId<QgsProcessingOutputLayerDefinition>() )
656 if (
QgsMapLayer *layer = qobject_cast< QgsMapLayer * >( qvariant_cast<QObject *>( val ) ) )
659 if ( val.userType() == qMetaTypeId<QgsProperty>() )
662 if ( !val.isValid() )
668 QString crsText = val.toString();
669 if ( crsText.isEmpty() )
670 crsText = fallbackValue.toString();
672 if ( crsText.isEmpty() )
676 if ( context.
project() && crsText.compare( QLatin1String(
"ProjectCrs" ), Qt::CaseInsensitive ) == 0 )
692bool QgsProcessingUtils::canUseLayer(
const QgsMeshLayer *layer )
697bool QgsProcessingUtils::canUseLayer(
const QgsPluginLayer *layer )
699 return layer && layer->
isValid();
704 return layer && layer->
isValid();
707bool QgsProcessingUtils::canUseLayer(
const QgsRasterLayer *layer )
709 return layer && layer->
isValid();
714 return layer && layer->
isValid();
719 return layer && layer->
isValid();
724 return layer && layer->
isValid();
727bool QgsProcessingUtils::canUseLayer(
const QgsVectorLayer *layer,
const QList<int> &sourceTypes )
729 return layer && layer->
isValid() &&
730 ( sourceTypes.isEmpty()
741 QString normalized = source;
742 normalized.replace(
'\\',
'/' );
743 return normalized.trimmed();
752 if ( !source.isEmpty() )
757 if ( provider.compare( QLatin1String(
"gdal" ), Qt::CaseInsensitive ) == 0
758 || provider.compare( QLatin1String(
"ogr" ), Qt::CaseInsensitive ) == 0
759 || provider.compare( QLatin1String(
"mdal" ), Qt::CaseInsensitive ) == 0 )
762 return QStringLiteral(
"%1://%2" ).arg( provider, source );
769 if ( !value.isValid() )
770 return QStringLiteral(
"None" );
772 if ( value.userType() == qMetaTypeId<QgsProperty>() )
773 return QStringLiteral(
"QgsProperty.fromExpression('%1')" ).arg( value.value<
QgsProperty >().
asExpression() );
774 else if ( value.userType() == qMetaTypeId<QgsCoordinateReferenceSystem>() )
777 return QStringLiteral(
"QgsCoordinateReferenceSystem()" );
781 else if ( value.userType() == qMetaTypeId<QgsRectangle>() )
789 else if ( value.userType() == qMetaTypeId<QgsReferencedRectangle>() )
797 else if ( value.userType() == qMetaTypeId<QgsPointXY>() )
803 else if ( value.userType() == qMetaTypeId<QgsReferencedPointXY>() )
811 switch ( value.userType() )
813 case QMetaType::Type::Bool:
814 return value.toBool() ? QStringLiteral(
"True" ) : QStringLiteral(
"False" );
816 case QMetaType::Type::Double:
817 return QString::number( value.toDouble() );
819 case QMetaType::Type::Int:
820 case QMetaType::Type::UInt:
821 return QString::number( value.toInt() );
823 case QMetaType::Type::LongLong:
824 case QMetaType::Type::ULongLong:
825 return QString::number( value.toLongLong() );
827 case QMetaType::Type::QVariantList:
830 const QVariantList vl = value.toList();
831 for (
const QVariant &v : vl )
835 return parts.join(
',' ).prepend(
'[' ).append(
']' );
838 case QMetaType::Type::QVariantMap:
840 const QVariantMap map = value.toMap();
842 parts.reserve( map.size() );
843 for (
auto it = map.constBegin(); it != map.constEnd(); ++it )
847 return parts.join(
',' ).prepend(
'{' ).append(
'}' );
850 case QMetaType::Type::QDateTime:
852 const QDateTime dateTime = value.toDateTime();
853 return QStringLiteral(
"QDateTime(QDate(%1, %2, %3), QTime(%4, %5, %6))" )
854 .arg( dateTime.date().year() )
855 .arg( dateTime.date().month() )
856 .arg( dateTime.date().day() )
857 .arg( dateTime.time().hour() )
858 .arg( dateTime.time().minute() )
859 .arg( dateTime.time().second() );
872 s.replace(
'\\', QLatin1String(
"\\\\" ) );
873 s.replace(
'\n', QLatin1String(
"\\n" ) );
874 s.replace(
'\r', QLatin1String(
"\\r" ) );
875 s.replace(
'\t', QLatin1String(
"\\t" ) );
877 if ( s.contains(
'\'' ) && !s.contains(
'\"' ) )
879 s = s.prepend(
'"' ).append(
'"' );
883 s.replace(
'\'', QLatin1String(
"\\\'" ) );
884 s = s.prepend(
'\'' ).append(
'\'' );
889void QgsProcessingUtils::parseDestinationString( QString &destination, QString &providerKey, QString &uri, QString &layerName, QString &format, QMap<QString, QVariant> &options,
bool &useWriter, QString &extension )
896 const thread_local QRegularExpression splitRx( QStringLiteral(
"^(.{3,}?):(.*)$" ) );
897 QRegularExpressionMatch match = splitRx.match( destination );
898 if ( match.hasMatch() )
900 providerKey = match.captured( 1 );
901 uri = match.captured( 2 );
908 if ( providerKey == QLatin1String(
"postgis" ) )
910 providerKey = QStringLiteral(
"postgres" );
912 if ( providerKey == QLatin1String(
"ogr" ) )
917 if ( !dsUri.
table().isEmpty() )
919 layerName = dsUri.
table();
920 options.insert( QStringLiteral(
"layerName" ), layerName );
923 extension = QFileInfo( uri ).completeSuffix();
925 options.insert( QStringLiteral(
"driverName" ), format );
929 extension = QFileInfo( uri ).completeSuffix();
932 options.insert( QStringLiteral(
"update" ),
true );
939 providerKey = QStringLiteral(
"ogr" );
941 const thread_local QRegularExpression splitRx( QStringLiteral(
"^(.*)\\.(.*?)$" ) );
942 QRegularExpressionMatch match = splitRx.match( destination );
943 if ( match.hasMatch() )
945 extension = match.captured( 2 );
949 if ( format.isEmpty() )
951 format = QStringLiteral(
"GPKG" );
952 destination = destination + QStringLiteral(
".gpkg" );
955 options.insert( QStringLiteral(
"driverName" ), format );
962 QVariantMap options = createOptions;
963 if ( !options.contains( QStringLiteral(
"fileEncoding" ) ) )
969 if ( destination.isEmpty() || destination.startsWith( QLatin1String(
"memory:" ) ) )
972 if ( destination.startsWith( QLatin1String(
"memory:" ) ) )
973 destination = destination.mid( 7 );
975 if ( destination.isEmpty() )
976 destination = QStringLiteral(
"output" );
980 if ( !layer || !layer->isValid() )
987 for (
const QgsField &field : fields )
990 if ( !field.alias().isEmpty() )
991 feedback->pushWarning( QObject::tr(
"%1: Aliases are not compatible with scratch layers" ).arg( field.name() ) );
992 if ( !field.alias().isEmpty() )
993 feedback->pushWarning( QObject::tr(
"%1: Comments are not compatible with scratch layers" ).arg( field.name() ) );
1000 destination = layer->id();
1003 std::unique_ptr< QgsProcessingFeatureSink > sink(
new QgsProcessingFeatureSink( layer->dataProvider(), destination, context ) );
1006 return sink.release();
1010 QString providerKey;
1015 bool useWriter =
false;
1016 parseDestinationString( destination, providerKey, uri, layerName, format, options, useWriter, extension );
1019 if ( useWriter && providerKey == QLatin1String(
"ogr" ) )
1023 QString finalFileName;
1024 QString finalLayerName;
1026 saveOptions.
fileEncoding = options.value( QStringLiteral(
"fileEncoding" ) ).toString();
1027 saveOptions.
layerName = !layerName.isEmpty() ? layerName : options.value( QStringLiteral(
"layerName" ) ).toString();
1032 if ( remappingDefinition )
1036 std::unique_ptr< QgsVectorLayer > vl = std::make_unique< QgsVectorLayer >( destination );
1037 if ( vl->isValid() )
1041 newFields = vl->fields();
1051 if ( writer->hasError() )
1053 throw QgsProcessingException( QObject::tr(
"Could not create layer %1: %2" ).arg( destination, writer->errorMessage() ) );
1058 for (
const QgsField &field : fields )
1061 feedback->pushWarning( QObject::tr(
"%1: Aliases are not supported by %2" ).arg( field.name(), writer->driverLongName() ) );
1063 feedback->pushWarning( QObject::tr(
"%1: Comments are not supported by %2" ).arg( field.name(), writer->driverLongName() ) );
1067 destination = finalFileName;
1068 if ( !saveOptions.
layerName.isEmpty() && !finalLayerName.isEmpty() )
1069 destination += QStringLiteral(
"|layername=%1" ).arg( finalLayerName );
1071 if ( remappingDefinition )
1073 std::unique_ptr< QgsRemappingProxyFeatureSink > remapSink = std::make_unique< QgsRemappingProxyFeatureSink >( *remappingDefinition, writer.release(),
true );
1084 if ( remappingDefinition )
1089 if ( !layerName.isEmpty() )
1092 parts.insert( QStringLiteral(
"layerName" ), layerName );
1096 std::unique_ptr< QgsVectorLayer > layer = std::make_unique<QgsVectorLayer>( uri, destination, providerKey, layerOptions );
1098 destination = layer->id();
1099 if ( layer->isValid() )
1109 for (
const QgsField &field : fields )
1112 feedback->pushWarning( QObject::tr(
"%1: Aliases are not supported by the %2 provider" ).arg( field.name(), providerKey ) );
1114 feedback->pushWarning( QObject::tr(
"%1: Comments are not supported by the %2 provider" ).arg( field.name(), providerKey ) );
1118 std::unique_ptr< QgsRemappingProxyFeatureSink > remapSink = std::make_unique< QgsRemappingProxyFeatureSink >( *remappingDefinition, layer->dataProvider(),
false );
1128 std::unique_ptr< QgsVectorLayerExporter > exporter = std::make_unique<QgsVectorLayerExporter>( uri, providerKey, newFields, geometryType,
crs,
true, options, sinkFlags );
1131 throw QgsProcessingException( QObject::tr(
"Could not create layer %1: %2" ).arg( destination, exporter->errorMessage() ) );
1135 if ( !layerName.isEmpty() )
1137 uri += QStringLiteral(
"|layername=%1" ).arg( layerName );
1144 for (
const QgsField &field : fields )
1147 feedback->pushWarning( QObject::tr(
"%1: Aliases are not supported by the %2 provider" ).arg( field.name(), providerKey ) );
1149 feedback->pushWarning( QObject::tr(
"%1: Comments are not supported by the %2 provider" ).arg( field.name(), providerKey ) );
1207 if ( !input.isValid() )
1208 return QStringLiteral(
"memory:%1" ).arg(
id.toString() );
1210 if ( input.userType() == qMetaTypeId<QgsProcessingOutputLayerDefinition>() )
1217 else if ( input.userType() == qMetaTypeId<QgsProperty>() )
1224 QString res = input.toString();
1230 else if ( res.startsWith( QLatin1String(
"memory:" ) ) )
1232 return QString( res +
'_' +
id.toString() );
1238 int lastIndex = res.lastIndexOf(
'.' );
1239 return lastIndex >= 0 ? QString( res.left( lastIndex ) +
'_' +
id.toString() + res.mid( lastIndex ) ) : QString( res +
'_' +
id.toString() );
1250 static std::vector< std::unique_ptr< QTemporaryDir > > sTempFolders;
1251 static QString sFolder;
1252 static QMutex sMutex;
1253 QMutexLocker locker( &sMutex );
1258 if ( basePath.isEmpty() )
1261 if ( basePath.isEmpty() )
1264 if ( sTempFolders.empty() )
1266 const QString templatePath = QStringLiteral(
"%1/processing_XXXXXX" ).arg( QDir::tempPath() );
1267 std::unique_ptr< QTemporaryDir >
tempFolder = std::make_unique< QTemporaryDir >( templatePath );
1269 sTempFolders.emplace_back( std::move(
tempFolder ) );
1272 else if ( sFolder.isEmpty() || !sFolder.startsWith( basePath ) || sTempFolders.empty() )
1274 if ( !QDir().exists( basePath ) )
1275 QDir().mkpath( basePath );
1277 const QString templatePath = QStringLiteral(
"%1/processing_XXXXXX" ).arg( basePath );
1278 std::unique_ptr< QTemporaryDir >
tempFolder = std::make_unique< QTemporaryDir >( templatePath );
1280 sTempFolders.emplace_back( std::move(
tempFolder ) );
1287 QString subPath = QUuid::createUuid().toString().remove(
'-' ).remove(
'{' ).remove(
'}' );
1288 QString path =
tempFolder( context ) +
'/' + subPath;
1289 if ( !QDir( path ).exists() )
1292 tmpDir.mkdir( path );
1299 auto getText = [map](
const QString & key )->QString
1301 if ( map.contains( key ) )
1302 return map.value( key ).toString();
1307 s += QStringLiteral(
"<html><body><p>" ) + getText( QStringLiteral(
"ALG_DESC" ) ) + QStringLiteral(
"</p>\n" );
1316 if ( !getText( def->name() ).isEmpty() )
1318 inputs += QStringLiteral(
"<h3>" ) + def->description() + QStringLiteral(
"</h3>\n" );
1319 inputs += QStringLiteral(
"<p>" ) + getText( def->name() ) + QStringLiteral(
"</p>\n" );
1322 if ( !inputs.isEmpty() )
1323 s += QStringLiteral(
"<h2>" ) + QObject::tr(
"Input parameters" ) + QStringLiteral(
"</h2>\n" ) + inputs;
1329 if ( !getText( def->name() ).isEmpty() )
1331 outputs += QStringLiteral(
"<h3>" ) + def->description() + QStringLiteral(
"</h3>\n" );
1332 outputs += QStringLiteral(
"<p>" ) + getText( def->name() ) + QStringLiteral(
"</p>\n" );
1335 if ( !outputs.isEmpty() )
1336 s += QStringLiteral(
"<h2>" ) + QObject::tr(
"Outputs" ) + QStringLiteral(
"</h2>\n" ) + outputs;
1338 if ( !map.value( QStringLiteral(
"EXAMPLES" ) ).toString().isEmpty() )
1339 s += QStringLiteral(
"<h2>%1</h2>\n<p>%2</p>" ).arg( QObject::tr(
"Examples" ), getText( QStringLiteral(
"EXAMPLES" ) ) );
1341 s += QLatin1String(
"<br>" );
1342 if ( !map.value( QStringLiteral(
"ALG_CREATOR" ) ).toString().isEmpty() )
1343 s += QStringLiteral(
"<p align=\"right\">" ) + QObject::tr(
"Algorithm author:" ) + QStringLiteral(
" " ) + getText( QStringLiteral(
"ALG_CREATOR" ) ) + QStringLiteral(
"</p>" );
1344 if ( !map.value( QStringLiteral(
"ALG_HELP_CREATOR" ) ).toString().isEmpty() )
1345 s += QStringLiteral(
"<p align=\"right\">" ) + QObject::tr(
"Help author:" ) + QStringLiteral(
" " ) + getText( QStringLiteral(
"ALG_HELP_CREATOR" ) ) + QStringLiteral(
"</p>" );
1346 if ( !map.value( QStringLiteral(
"ALG_VERSION" ) ).toString().isEmpty() )
1347 s += QStringLiteral(
"<p align=\"right\">" ) + QObject::tr(
"Algorithm version:" ) + QStringLiteral(
" " ) + getText( QStringLiteral(
"ALG_VERSION" ) ) + QStringLiteral(
"</p>" );
1349 s += QLatin1String(
"</body></html>" );
1354 long long featureLimit,
const QString &filterExpression,
bool renameFid )
1356 bool requiresTranslation =
false;
1360 requiresTranslation = requiresTranslation || selectedFeaturesOnly;
1363 requiresTranslation = requiresTranslation || featureLimit != -1 || !filterExpression.isEmpty();
1368 requiresTranslation = requiresTranslation || vl->
providerType() != QLatin1String(
"ogr" );
1372 requiresTranslation = requiresTranslation || !vl->
subsetString().isEmpty();
1376 requiresTranslation = requiresTranslation || vl->
source().startsWith( QLatin1String(
"/vsi" ) );
1380 if ( !requiresTranslation )
1383 if ( parts.contains( QStringLiteral(
"path" ) ) )
1385 diskPath = parts.value( QStringLiteral(
"path" ) ).toString();
1386 QFileInfo fi( diskPath );
1387 requiresTranslation = !compatibleFormats.contains( fi.suffix(), Qt::CaseInsensitive );
1391 const QString srcLayerName = parts.value( QStringLiteral(
"layerName" ) ).toString();
1395 *layerName = srcLayerName;
1400 requiresTranslation = requiresTranslation || ( !srcLayerName.isEmpty() && srcLayerName != fi.baseName() );
1405 requiresTranslation =
true;
1409 if ( requiresTranslation )
1419 const int fidIndex = fields.
lookupField( QStringLiteral(
"fid" ) );
1420 if ( fidIndex >= 0 )
1421 fields.
rename( fidIndex, QStringLiteral(
"OLD_FID" ) );
1427 if ( featureLimit != -1 )
1431 if ( !filterExpression.isEmpty() )
1436 if ( selectedFeaturesOnly )
1441 constexpr int maxErrors { 10 };
1442 unsigned long errorCounter { 0 };
1450 const QString errorMessage = writer->errorMessage();
1451 if ( !renameFid && saveOptions.
driverName == QLatin1String(
"GPKG" ) && errorMessage.contains(
"fid", Qt::CaseInsensitive ) )
1454 feedback->
reportError( QObject::tr(
"Cannot store existing FID values in temporary GeoPackage layer, these will be moved to \"OLD_FID\" instead." ),
false );
1456 featureLimit, filterExpression,
true );
1460 if ( errorCounter++ < maxErrors )
1462 errorText = QObject::tr(
"Error writing feature # %1 to output layer: %2" ).arg( QString::number( f.
id() ), errorMessage );
1468 if ( errorCounter >= maxErrors )
1470 feedback->
reportError( QObject::tr(
"There were %1 errors writing features, only the first %2 have been reported." ).arg( QString::number( errorCounter ), QString::number( maxErrors ) ) );
1482 return convertToCompatibleFormatInternal( vl, selectedFeaturesOnly, baseName, compatibleFormats, preferredFormat, context, feedback,
nullptr, featureLimit, filterExpression,
false );
1488 return convertToCompatibleFormatInternal( layer, selectedFeaturesOnly, baseName, compatibleFormats, preferredFormat, context, feedback, &layerName, featureLimit, filterExpression,
false );
1494 QSet< QString > usedNames;
1495 for (
const QgsField &f : fieldsA )
1497 usedNames.insert( f.name().toLower() );
1500 for (
const QgsField &f : fieldsB )
1503 newField.
setName( fieldsBPrefix + f.name() );
1504 if ( usedNames.contains( newField.
name().toLower() ) )
1507 QString newName = newField.
name() +
'_' + QString::number( idx );
1508 while ( usedNames.contains( newName.toLower() ) || fieldsB.
indexOf( newName ) != -1 )
1511 newName = newField.
name() +
'_' + QString::number( idx );
1514 outFields.
append( newField );
1518 outFields.
append( newField );
1520 usedNames.insert( newField.
name() );
1530 if ( !fieldNames.isEmpty() )
1532 indices.reserve( fieldNames.count() );
1533 for (
const QString &f : fieldNames )
1537 indices.append( idx );
1542 indices.reserve( fields.
count() );
1543 for (
int i = 0; i < fields.
count(); ++i )
1544 indices.append( i );
1553 for (
int i : indices )
1554 fieldsSubset.
append( fields.
at( i ) );
1555 return fieldsSubset;
1561 if ( setting.isEmpty() )
1562 return QStringLiteral(
"gpkg" );
1564 if ( setting.startsWith(
'.' ) )
1565 setting = setting.mid( 1 );
1568 if ( !supportedFormats.contains( setting, Qt::CaseInsensitive ) )
1569 return QStringLiteral(
"gpkg" );
1577 if ( setting.isEmpty() )
1578 return QStringLiteral(
"tif" );
1580 if ( setting.startsWith(
'.' ) )
1581 setting = setting.mid( 1 );
1584 if ( !supportedFormats.contains( setting, Qt::CaseInsensitive ) )
1585 return QStringLiteral(
"tif" );
1592 return QStringLiteral(
"las" );
1597 return QStringLiteral(
"mbtiles" );
1602 auto layerPointerToString = [](
QgsMapLayer * layer ) -> QString
1604 if ( layer && layer->
providerType() == QLatin1String(
"memory" ) )
1612 auto cleanPointerValues = [&layerPointerToString](
const QVariant & value ) -> QVariant
1614 if (
QgsMapLayer *layer = qobject_cast< QgsMapLayer * >( value.value< QObject * >() ) )
1617 return layerPointerToString( layer );
1619 else if ( value.userType() == QMetaType::type(
"QPointer< QgsMapLayer >" ) )
1622 return layerPointerToString( value.value< QPointer< QgsMapLayer > >().data() );
1631 for (
auto it = map.constBegin(); it != map.constEnd(); ++it )
1633 if ( it->userType() == QMetaType::Type::QVariantMap )
1637 else if ( it->userType() == QMetaType::Type::QVariantList )
1640 const QVariantList source = it.value().toList();
1641 dest.reserve( source.size() );
1642 for (
const QVariant &v : source )
1644 dest.append( cleanPointerValues( v ) );
1646 res.insert( it.key(), dest );
1650 res.insert( it.key(), cleanPointerValues( it.value() ) );
1660 for (
auto it = parameters.constBegin(); it != parameters.constEnd(); ++it )
1662 if ( it.value().userType() == QMetaType::Type::QVariantMap )
1664 const QVariantMap value = it.value().toMap();
1665 if ( value.value( QStringLiteral(
"type" ) ).toString() == QLatin1String(
"data_defined" ) )
1667 const QString expression = value.value( QStringLiteral(
"expression" ) ).toString();
1668 const QString field = value.value( QStringLiteral(
"field" ) ).toString();
1669 if ( !expression.isEmpty() )
1673 else if ( !field.isEmpty() )
1680 error = QObject::tr(
"Invalid data defined parameter for %1, requires 'expression' or 'field' values." ).arg( it.key() );
1685 output.insert( it.key(), it.value() );
1688 else if ( it.value().userType() == QMetaType::Type::QString )
1690 const QString stringValue = it.value().toString();
1692 if ( stringValue.startsWith( QLatin1String(
"field:" ) ) )
1696 else if ( stringValue.startsWith( QLatin1String(
"expression:" ) ) )
1702 output.insert( it.key(), it.value() );
1707 output.insert( it.key(), it.value() );
1715 if ( ! QTextCodec::availableCodecs().contains( defaultEncoding.toLatin1() ) )
1717 const QString systemCodec = QTextCodec::codecForLocale()->name();
1718 if ( ! systemCodec.isEmpty() )
1722 return QString(
"UTF-8" );
1725 return defaultEncoding;
1733 : mSource( originalSource )
1734 , mOwnsSource( ownsOriginalSource )
1735 , mSourceCrs( mSource->sourceCrs() )
1736 , mSourceFields( mSource->fields() )
1737 , mSourceWkbType( mSource->wkbType() )
1738 , mSourceName( mSource->sourceName() )
1739 , mSourceExtent( mSource->sourceExtent() )
1740 , mSourceSpatialIndexPresence( mSource->hasSpatialIndex() )
1741 , mInvalidGeometryCheck(
QgsWkbTypes::geometryType( mSource->wkbType() ) ==
Qgis::GeometryType::Point
1742 ?
Qgis::InvalidGeometryCheck::NoCheck
1743 : context.invalidGeometryCheck() )
1744 , mInvalidGeometryCallback( context.invalidGeometryCallback( originalSource ) )
1745 , mTransformErrorCallback( context.transformErrorCallback() )
1746 , mInvalidGeometryCallbackSkip( context.defaultInvalidGeometryCallbackForCheck(
Qgis::InvalidGeometryCheck::SkipInvalid, originalSource ) )
1747 , mInvalidGeometryCallbackAbort( context.defaultInvalidGeometryCallbackForCheck(
Qgis::InvalidGeometryCheck::AbortOnInvalid, originalSource ) )
1748 , mFeatureLimit( featureLimit )
1749 , mFilterExpression( filterExpression )
1771 if ( mFeatureLimit != -1 && req.
limit() != -1 )
1772 req.
setLimit( std::min(
static_cast< long long >( req.
limit() ), mFeatureLimit ) );
1773 else if ( mFeatureLimit != -1 )
1776 if ( !mFilterExpression.isEmpty() )
1788 return sourceAvailability;
1801 if ( mFeatureLimit != -1 && req.
limit() != -1 )
1802 req.
setLimit( std::min(
static_cast< long long >( req.
limit() ), mFeatureLimit ) );
1803 else if ( mFeatureLimit != -1 )
1806 if ( !mFilterExpression.isEmpty() )
1819 return mSourceFields;
1824 return mSourceWkbType;
1829 if ( !mFilterExpression.isEmpty() )
1832 if ( mFeatureLimit == -1 )
1835 return std::min( mFeatureLimit, mSource->
featureCount() );
1845 if ( mFilterExpression.isEmpty() )
1850 if ( fieldIndex < 0 || fieldIndex >=
fields().count() )
1851 return QSet<QVariant>();
1858 QSet<QVariant> values;
1863 values.insert( f.
attribute( fieldIndex ) );
1864 if ( limit > 0 && values.size() >= limit )
1872 if ( mFilterExpression.isEmpty() )
1877 if ( fieldIndex < 0 || fieldIndex >=
fields().count() )
1889 const QVariant v = f.
attribute( fieldIndex );
1900 if ( mFilterExpression.isEmpty() )
1905 if ( fieldIndex < 0 || fieldIndex >=
fields().count() )
1917 const QVariant v = f.
attribute( fieldIndex );
1928 return mSourceExtent;
1933 if ( mFilterExpression.isEmpty() )
1939 .setFilterExpression( mFilterExpression ) );
1954 return mSourceSpatialIndexPresence;
1965 return expressionContextScope;
1970 mInvalidGeometryCheck = method;
1971 switch ( mInvalidGeometryCheck )
1974 mInvalidGeometryCallback =
nullptr;
1978 mInvalidGeometryCallback = mInvalidGeometryCallbackSkip;
1982 mInvalidGeometryCallback = mInvalidGeometryCallbackAbort;
1990 return mInvalidGeometryCheck;
1999 , mContext( context )
2000 , mSinkName( sinkName )
2001 , mOwnsSink( ownsOriginalSink )
2029 if ( !result && mContext.
feedback() )
2032 if ( !error.isEmpty() )
2033 mContext.
feedback()->
reportError( QObject::tr(
"Feature could not be written to %1: %2" ).arg( mSinkName, error ) );
2035 mContext.
feedback()->
reportError( QObject::tr(
"Feature could not be written to %1" ).arg( mSinkName ) );
2043 if ( !result && mContext.
feedback() )
2046 if ( !error.isEmpty() )
2047 mContext.
feedback()->
reportError( QObject::tr(
"%n feature(s) could not be written to %1: %2",
nullptr, features.count() ).arg( mSinkName, error ) );
2049 mContext.
feedback()->
reportError( QObject::tr(
"%n feature(s) could not be written to %1",
nullptr, features.count() ).arg( mSinkName ) );
2057 if ( !result && mContext.
feedback() )
2060 if ( !error.isEmpty() )
2061 mContext.
feedback()->
reportError( QObject::tr(
"Features could not be written to %1: %2" ).arg( mSinkName, error ) );
2063 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.
@ Vector
Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink ha...
@ VectorAnyGeometry
Any vector layer with geometry.
@ VectorPoint
Vector point layers.
@ VectorPolygon
Vector polygon layers.
@ VectorLine
Vector line layers.
@ FieldComments
Writer can support field comments.
@ FieldAliases
Writer can support field aliases.
SpatialIndexPresence
Enumeration of spatial index presence states.
@ Success
No errors were encountered.
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
FeatureAvailability
Possible return value for QgsFeatureSource::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.
@ 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.
@ EditAlias
Allows editing aliases.
@ EditComment
Allows editing comments.
QFlags< VectorDataProviderAttributeEditCapability > VectorDataProviderAttributeEditCapabilities
Attribute editing capabilities which may be supported by vector data providers.
InvalidGeometryCheck
Methods for handling of features with invalid geometries.
@ NoCheck
No invalid geometry checking.
@ AbortOnInvalid
Close iterator on encountering any features with invalid geometry. This requires a slow geometry vali...
@ SkipInvalid
Skip any features with invalid geometry. This requires a slow geometry validity check for every featu...
@ OverrideDefaultGeometryCheck
If set, the default geometry check method (as dictated by QgsProcessingContext) will be overridden fo...
@ SkipGeometryValidityChecks
Invalid geometry checks should always be skipped. This flag can be useful for algorithms which always...
WkbType
The WKB type describes the number of dimensions a geometry has.
@ Hidden
Parameter is hidden and should not be shown to users.
@ NoSymbology
Export only data.
QFlags< ProcessingFeatureSourceFlag > ProcessingFeatureSourceFlags
Flags which control how QgsProcessingFeatureSource fetches features.
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.
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)
Fetch next feature and stores in f, returns true on success.
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
QgsFeatureRequest & setLimit(long long limit)
Set the maximum number of features to request.
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 & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsFeatureRequest & setInvalidGeometryCheck(Qgis::InvalidGeometryCheck check)
Sets invalid geometry checking behavior.
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
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 & 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.
QFlags< SinkFlag > SinkFlags
@ 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.
virtual Qgis::FeatureAvailability hasFeatures() const
Determines if there are any features available in the 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...
Q_INVOKABLE 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, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
Q_INVOKABLE int indexOf(const QString &fieldName) const
Gets the field index from the field name.
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
bool rename(int fieldIdx, const QString &name)
Renames a name of field.
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
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.
void finalize() override
Finalizes the sink, flushing any buffered features to the destination.
~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.
bool selectedFeaturesOnly
true if only selected features in the source should be used by algorithms.
QgsProperty source
Source definition.
Qgis::InvalidGeometryCheck geometryCheck
Geometry check method to apply to this source.
Qgis::ProcessingFeatureSourceDefinitionFlags flags
Flags which dictate source behavior.
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...
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...
void setInvalidGeometryCheck(Qgis::InvalidGeometryCheck method)
Overrides the default geometry check method for the source.
Qgis::InvalidGeometryCheck invalidGeometryCheck() const
Returns the geometry check method for 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
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.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request, Qgis::ProcessingFeatureSourceFlags flags) const
Returns an iterator for the features in the source, respecting the supplied feature flags.
Qgis::FeatureAvailability hasFeatures() const override
Determines if there are any features available in the source.
QString sourceName() const override
Returns a friendly display name for the source.
QgsFeatureIds allFeatureIds() const override
Returns a list of all feature IDs for features present in the source.
Qgis::SpatialIndexPresence hasSpatialIndex() const override
Returns an enum value representing the presence of a valid spatial index on the source,...
QgsFields fields() const override
Returns the fields associated with features in 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.
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 QString layerToStringIdentifier(const QgsMapLayer *layer)
Returns a string representation of the source for a layer.
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.
QFlags< LayerOptionsFlag > LayerOptionsFlags
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.
static const QgsSettingsEntryString * settingsDefaultOutputRasterLayerExt
Settings entry default output raster layer ext.
static const QgsSettingsEntryString * settingsDefaultOutputVectorLayerExt
Settings entry default output vector layer ext.
@ 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.
QString asExpression() const
Returns an expression string representing the state of the property, or an empty string if the proper...
Qgis::PropertyType propertyType() const
Returns the property type.
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.
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.
bool flushBuffer() override
Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to...
QgsFeatureSink * mSink
Underlying destination sink.
QString lastError() const override
Returns the most recent error encountered by the sink, e.g.
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.
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, bool silenceNullWarnings=false)
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.
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, bool renameFid)
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.