mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-16 00:03:12 -04:00
d7aa3f5f7c
flexible QVariantMap creatOptions parameters which include an optional fileEncoding value More flexible, allows sinks to be created using any creation option which is passed to the underlying provider
239 lines
9.9 KiB
C++
239 lines
9.9 KiB
C++
/***************************************************************************
|
|
qgsprocessingutils.h
|
|
------------------------
|
|
begin : April 2017
|
|
copyright : (C) 2017 by Nyall Dawson
|
|
email : nyall dot dawson at gmail dot com
|
|
***************************************************************************/
|
|
|
|
/***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
#ifndef QGSPROCESSINGUTILS_H
|
|
#define QGSPROCESSINGUTILS_H
|
|
|
|
#include "qgis_core.h"
|
|
|
|
#include "qgsrasterlayer.h"
|
|
#include "qgsvectorlayer.h"
|
|
#include "qgsmessagelog.h"
|
|
#include "qgsspatialindex.h"
|
|
|
|
class QgsProject;
|
|
class QgsProcessingContext;
|
|
class QgsMapLayerStore;
|
|
|
|
#include <QString>
|
|
#include <QVariant>
|
|
|
|
/**
|
|
* \class QgsProcessingUtils
|
|
* \ingroup core
|
|
* Utility functions for use with processing classes.
|
|
* \since QGIS 3.0
|
|
*/
|
|
class CORE_EXPORT QgsProcessingUtils
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
* Returns a list of raster layers from a \a project which are compatible with the processing
|
|
* framework.
|
|
*
|
|
* If the \a sort argument is true then the layers will be sorted by their QgsMapLayer::name()
|
|
* value.
|
|
* \see compatibleVectorLayers()
|
|
* \see compatibleLayers()
|
|
*/
|
|
static QList< QgsRasterLayer * > compatibleRasterLayers( QgsProject *project, bool sort = true );
|
|
|
|
/**
|
|
* Returns a list of vector layers from a \a project which are compatible with the processing
|
|
* framework.
|
|
*
|
|
* If the \a geometryTypes list is non-empty then the layers will be sorted so that only
|
|
* layers with geometry types included in the list will be returned. Leaving the \a geometryTypes
|
|
* list empty will cause all vector layers, regardless of their geometry type, to be returned.
|
|
*
|
|
* If the \a sort argument is true then the layers will be sorted by their QgsMapLayer::name()
|
|
* value.
|
|
* \see compatibleRasterLayers()
|
|
* \see compatibleLayers()
|
|
*/
|
|
static QList< QgsVectorLayer * > compatibleVectorLayers( QgsProject *project,
|
|
const QList< QgsWkbTypes::GeometryType > &geometryTypes = QList< QgsWkbTypes::GeometryType >(),
|
|
bool sort = true );
|
|
|
|
/**
|
|
* Returns a list of map layers from a \a project which are compatible with the processing
|
|
* framework.
|
|
*
|
|
* If the \a sort argument is true then the layers will be sorted by their QgsMapLayer::name()
|
|
* value.
|
|
* \see compatibleRasterLayers()
|
|
* \see compatibleVectorLayers()
|
|
*/
|
|
static QList< QgsMapLayer * > compatibleLayers( QgsProject *project, bool sort = true );
|
|
|
|
/**
|
|
* Interprets a string as a map layer within the supplied \a context.
|
|
*
|
|
* The method will attempt to
|
|
* load a layer matching the passed \a string. E.g. if the string matches a layer ID or name
|
|
* within the context's project or temporary layer store then this layer will be returned.
|
|
* If the string is a file path and \a allowLoadingNewLayers is true, then the layer at this
|
|
* file path will be loaded and added to the context's temporary layer store.
|
|
* Ownership of the layer remains with the \a context or the context's current project.
|
|
*/
|
|
static QgsMapLayer *mapLayerFromString( const QString &string, QgsProcessingContext &context, bool allowLoadingNewLayers = true );
|
|
|
|
/**
|
|
* Normalizes a layer \a source string for safe comparison across different
|
|
* operating system environments.
|
|
*/
|
|
static QString normalizeLayerSource( const QString &source );
|
|
|
|
/**
|
|
* Creates a feature sink ready for adding features. The \a destination specifies a destination
|
|
* URI for the resultant layer. It may be updated in place to reflect the actual destination
|
|
* for the layer.
|
|
*
|
|
* Sink parameters such as desired \a encoding, \a fields, \a geometryType and \a crs must be specified.
|
|
*
|
|
* The \a createOptions map can be used to specify additional sink creation options, which
|
|
* are passed to the underlying provider when creating new layers. Known options also
|
|
* include 'fileEncoding', which is used to specify a file encoding to use for created
|
|
* files. If 'fileEncoding' is not specified, the default encoding from the \a context will be used.
|
|
*
|
|
* If a layer is created for the feature sink, the layer will automatically be added to the \a context's
|
|
* temporary layer store.
|
|
*
|
|
* The caller takes responsibility for deleting the returned sink.
|
|
*/
|
|
#ifndef SIP_RUN
|
|
static QgsFeatureSink *createFeatureSink(
|
|
QString &destination,
|
|
QgsProcessingContext &context,
|
|
const QgsFields &fields,
|
|
QgsWkbTypes::Type geometryType,
|
|
const QgsCoordinateReferenceSystem &crs,
|
|
const QVariantMap &createOptions = QVariantMap() ) SIP_FACTORY;
|
|
#endif
|
|
|
|
/**
|
|
* Creates a feature sink ready for adding features. The \a destination specifies a destination
|
|
* URI for the resultant layer. It may be updated in place to reflect the actual destination
|
|
* for the layer.
|
|
*
|
|
* Sink parameters such as desired \a fields, \a geometryType and \a crs must be specified.
|
|
*
|
|
* The \a createOptions map can be used to specify additional sink creation options, which
|
|
* are passed to the underlying provider when creating new layers. Known options also
|
|
* include 'fileEncoding', which is used to specify a file encoding to use for created
|
|
* files. If 'fileEncoding' is not specified, the default encoding from the \a context will be used.
|
|
*
|
|
* If a layer is created for the feature sink, the layer will automatically be added to the \a context's
|
|
* temporary layer store.
|
|
*
|
|
* \note this version of the createFeatureSink() function has an API designed around use from the
|
|
* SIP bindings. c++ code should call the other createFeatureSink() version.
|
|
* \note available in Python bindings as createFeatureSink()
|
|
*/
|
|
static void createFeatureSinkPython(
|
|
QgsFeatureSink **sink SIP_OUT SIP_TRANSFERBACK,
|
|
QString &destination SIP_INOUT,
|
|
QgsProcessingContext &context,
|
|
const QgsFields &fields,
|
|
QgsWkbTypes::Type geometryType,
|
|
const QgsCoordinateReferenceSystem &crs,
|
|
const QVariantMap &createOptions = QVariantMap() ) SIP_PYNAME( createFeatureSink );
|
|
|
|
/**
|
|
* Combines the extent of several map \a layers. If specified, the target \a crs
|
|
* will be used to transform the layer's extent to the desired output reference system.
|
|
*/
|
|
static QgsRectangle combineLayerExtents( const QList< QgsMapLayer *> layers, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
|
|
|
|
private:
|
|
|
|
static bool canUseLayer( const QgsRasterLayer *layer );
|
|
static bool canUseLayer( const QgsVectorLayer *layer,
|
|
const QList< QgsWkbTypes::GeometryType > &geometryTypes = QList< QgsWkbTypes::GeometryType >() );
|
|
|
|
/**
|
|
* Interprets a \a string as a map layer from a store.
|
|
*
|
|
* This method attempts to match a string to a store map layer, using
|
|
* first the layer ID, then layer names, and finally layer source.
|
|
* If the string matches a normalized version of any layer source
|
|
* for layers in the specified \a store, then those matching layers will be
|
|
* returned.
|
|
* \see mapLayerFromString()
|
|
*/
|
|
static QgsMapLayer *mapLayerFromStore( const QString &string, QgsMapLayerStore *store );
|
|
|
|
/**
|
|
* Interprets a string as a map layer. The method will attempt to
|
|
* load a layer matching the passed \a string. E.g. if the string is a file path,
|
|
* then the layer at this file path will be loaded.
|
|
* The caller takes responsibility for deleting the returned map layer.
|
|
*/
|
|
static QgsMapLayer *loadMapLayerFromString( const QString &string );
|
|
|
|
friend class TestQgsProcessing;
|
|
|
|
};
|
|
|
|
#ifndef SIP_RUN
|
|
|
|
/**
|
|
* \class QgsProcessingFeatureSource
|
|
* \ingroup core
|
|
* QgsFeatureSource subclass which proxies methods to an underlying QgsFeatureSource, modifying
|
|
* results according to the settings in a QgsProcessingContext.
|
|
* \note not available in Python bindings
|
|
* \since QGIS 3.0
|
|
*/
|
|
class QgsProcessingFeatureSource : public QgsFeatureSource
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Constructor for QgsProcessingFeatureSource, accepting an original feature source \a originalSource
|
|
* and processing \a context.
|
|
* Ownership of \a originalSource is dictated by \a ownsOriginalSource. If \a ownsOriginalSource is false,
|
|
* ownership is not transferred, and callers must ensure that \a originalSource exists for the lifetime of this object.
|
|
* If \a ownsOriginalSource is true, then this object will take ownership of \a originalSource.
|
|
*/
|
|
QgsProcessingFeatureSource( QgsFeatureSource *originalSource, const QgsProcessingContext &context, bool ownsOriginalSource = false );
|
|
|
|
~QgsProcessingFeatureSource();
|
|
|
|
virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest &request = QgsFeatureRequest() ) const override;
|
|
virtual QgsCoordinateReferenceSystem sourceCrs() const override;
|
|
virtual QgsFields fields() const override;
|
|
virtual QgsWkbTypes::Type wkbType() const override;
|
|
virtual long featureCount() const override;
|
|
|
|
private:
|
|
|
|
QgsFeatureSource *mSource = nullptr;
|
|
bool mOwnsSource = false;
|
|
QgsFeatureRequest::InvalidGeometryCheck mInvalidGeometryCheck = QgsFeatureRequest::GeometryNoCheck;
|
|
std::function< void( const QgsFeature & ) > mInvalidGeometryCallback;
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
#endif // QGSPROCESSINGUTILS_H
|
|
|
|
|