Skip to content

Commit 770c45d

Browse files
nyalldawsonnyalldawson
committed
Rename QgsProcessingParameterVectorLayer to QgsProcessingParameterFeatureSource
Helps abstract away sources to allow non vector layer sources in future
1 parent ffce9c9 commit 770c45d

File tree

8 files changed

+36
-36
lines changed

8 files changed

+36
-36
lines changed

‎python/core/processing/qgsprocessingparameters.sip

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ class QgsProcessingParameterDefinition
6262
sipType = sipType_QgsProcessingParameterTable;
6363
else if ( sipCpp->type() == "field" )
6464
sipType = sipType_QgsProcessingParameterTableField;
65-
else if ( sipCpp->type() == "vector" )
66-
sipType = sipType_QgsProcessingParameterVectorLayer;
65+
else if ( sipCpp->type() == "source" )
66+
sipType = sipType_QgsProcessingParameterFeatureSource;
6767
else if ( sipCpp->type() == "vectorOut" )
6868
sipType = sipType_QgsProcessingParameterOutputVectorLayer;
6969
%End
@@ -1019,10 +1019,10 @@ class QgsProcessingParameterTableField : QgsProcessingParameterDefinition
10191019

10201020
};
10211021

1022-
class QgsProcessingParameterVectorLayer : QgsProcessingParameterDefinition
1022+
class QgsProcessingParameterFeatureSource : QgsProcessingParameterDefinition
10231023
{
10241024
%Docstring
1025-
A vector layer parameter for processing algorithms.
1025+
An input feature source (such as vector layers) parameter for processing algorithms.
10261026
.. versionadded:: 3.0
10271027
%End
10281028

@@ -1031,11 +1031,11 @@ class QgsProcessingParameterVectorLayer : QgsProcessingParameterDefinition
10311031
%End
10321032
public:
10331033

1034-
QgsProcessingParameterVectorLayer( const QString &name, const QString &description = QString(),
1035-
const QList< int > &types = QList< int >(),
1036-
const QVariant &defaultValue = QVariant(), bool optional = false );
1034+
QgsProcessingParameterFeatureSource( const QString &name, const QString &description = QString(),
1035+
const QList< int > &types = QList< int >(),
1036+
const QVariant &defaultValue = QVariant(), bool optional = false );
10371037
%Docstring
1038-
Constructor for QgsProcessingParameterVectorLayer.
1038+
Constructor for QgsProcessingParameterFeatureSource.
10391039
%End
10401040

10411041
virtual QString type() const;
@@ -1044,14 +1044,14 @@ class QgsProcessingParameterVectorLayer : QgsProcessingParameterDefinition
10441044

10451045
QList< int > dataTypes() const;
10461046
%Docstring
1047-
Returns the layer types for layers acceptable by the parameter.
1047+
Returns the geometry types for sources acceptable by the parameter.
10481048
.. seealso:: setDataTypes()
10491049
:rtype: list of int
10501050
%End
10511051

10521052
void setDataTypes( const QList< int > &types );
10531053
%Docstring
1054-
Sets the layer ``types`` for layers acceptable by the parameter.
1054+
Sets the geometry ``types`` for sources acceptable by the parameter.
10551055
.. seealso:: dataTypes()
10561056
%End
10571057

‎python/plugins/processing/algs/qgis/Boundary.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
QgsWkbTypes,
3232
QgsProcessingUtils,
3333
QgsProcessingParameterDefinition,
34-
QgsProcessingParameterVectorLayer,
34+
QgsProcessingParameterFeatureSource,
3535
QgsProcessingParameterOutputVectorLayer,
3636
QgsProcessingOutputVectorLayer)
3737

@@ -53,7 +53,7 @@ class Boundary(QgisAlgorithm):
5353

5454
def __init__(self):
5555
super().__init__()
56-
self.addParameter(QgsProcessingParameterVectorLayer(self.INPUT_LAYER, self.tr('Input layer'), [QgsProcessingParameterDefinition.TypeVectorLine, QgsProcessingParameterDefinition.TypeVectorPolygon]))
56+
self.addParameter(QgsProcessingParameterFeatureSource(self.INPUT_LAYER, self.tr('Input layer'), [QgsProcessingParameterDefinition.TypeVectorLine, QgsProcessingParameterDefinition.TypeVectorPolygon]))
5757
self.addParameter(QgsProcessingParameterOutputVectorLayer(self.OUTPUT_LAYER, self.tr('Boundary')))
5858
self.addOutput(QgsProcessingOutputVectorLayer(self.OUTPUT_LAYER, self.tr("Boundaries")))
5959

‎python/plugins/processing/gui/ParametersPanel.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
from qgis.core import (QgsProcessingParameterDefinition,
3535
QgsProcessingParameterExtent,
3636
QgsProcessingParameterPoint,
37-
QgsProcessingParameterVectorLayer,
37+
QgsProcessingParameterFeatureSource,
3838
QgsProcessingOutputVectorLayer,
3939
QgsProcessingParameterOutputVectorLayer)
4040
from qgis.PyQt import uic
@@ -110,7 +110,7 @@ def initWidgets(self):
110110
widget = wrapper.widget
111111

112112
if widget is not None:
113-
if isinstance(param, QgsProcessingParameterVectorLayer):
113+
if isinstance(param, QgsProcessingParameterFeatureSource):
114114
layout = QHBoxLayout()
115115
layout.setSpacing(2)
116116
layout.setMargin(0)

‎python/plugins/processing/gui/wrappers.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
QgsProcessingParameterExpression,
6060
QgsProcessingParameterTable,
6161
QgsProcessingParameterTableField,
62-
QgsProcessingParameterVectorLayer)
62+
QgsProcessingParameterFeatureSource)
6363

6464
from qgis.PyQt.QtWidgets import (
6565
QCheckBox,
@@ -1256,7 +1256,7 @@ def create_wrapper_from_class(param, dialog, row=0, col=0):
12561256
wrapper = TableWidgetWrapper
12571257
elif param.type() == 'field':
12581258
wrapper = TableFieldWidgetWrapper
1259-
elif param.type() == 'vector':
1259+
elif param.type() == 'source':
12601260
wrapper = VectorWidgetWrapper
12611261
else:
12621262
assert False, param.type()

‎src/core/processing/qgsnativealgorithms.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ void QgsNativeAlgorithms::loadAlgorithms()
6565

6666
QgsCentroidAlgorithm::QgsCentroidAlgorithm()
6767
{
68-
addParameter( new QgsProcessingParameterVectorLayer( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );
68+
addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );
6969
addParameter( new QgsProcessingParameterOutputVectorLayer( QStringLiteral( "OUTPUT_LAYER" ), QObject::tr( "Centroids" ), QgsProcessingParameterDefinition::TypeVectorPoint ) );
7070
addOutput( new QgsProcessingOutputVectorLayer( QStringLiteral( "OUTPUT_LAYER" ), QObject::tr( "Centroids" ), QgsProcessingParameterDefinition::TypeVectorPoint ) );
7171
}
@@ -127,7 +127,7 @@ QVariantMap QgsCentroidAlgorithm::processAlgorithm( const QVariantMap &parameter
127127

128128
QgsBufferAlgorithm::QgsBufferAlgorithm()
129129
{
130-
addParameter( new QgsProcessingParameterVectorLayer( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );
130+
addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );
131131
addParameter( new QgsProcessingParameterNumber( QStringLiteral( "DISTANCE" ), QObject::tr( "Distance" ), QgsProcessingParameterNumber::Double, 10 ) );
132132
addParameter( new QgsProcessingParameterNumber( QStringLiteral( "SEGMENTS" ), QObject::tr( "Segments" ), QgsProcessingParameterNumber::Integer, 5, false, 1 ) );
133133

‎src/core/processing/qgsprocessingparameters.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1176,14 +1176,14 @@ void QgsProcessingParameterTableField::setAllowMultiple( bool allowMultiple )
11761176
mAllowMultiple = allowMultiple;
11771177
}
11781178

1179-
QgsProcessingParameterVectorLayer::QgsProcessingParameterVectorLayer( const QString &name, const QString &description, const QList<int> &types, const QVariant &defaultValue, bool optional )
1179+
QgsProcessingParameterFeatureSource::QgsProcessingParameterFeatureSource( const QString &name, const QString &description, const QList<int> &types, const QVariant &defaultValue, bool optional )
11801180
: QgsProcessingParameterDefinition( name, description, defaultValue, optional )
11811181
, mDataTypes( types )
11821182
{
11831183

11841184
}
11851185

1186-
bool QgsProcessingParameterVectorLayer::checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context ) const
1186+
bool QgsProcessingParameterFeatureSource::checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context ) const
11871187
{
11881188
if ( !input.isValid() )
11891189
return mFlags & FlagOptional;
@@ -1209,12 +1209,12 @@ bool QgsProcessingParameterVectorLayer::checkValueIsAcceptable( const QVariant &
12091209
return false;
12101210
}
12111211

1212-
QList< int > QgsProcessingParameterVectorLayer::dataTypes() const
1212+
QList< int > QgsProcessingParameterFeatureSource::dataTypes() const
12131213
{
12141214
return mDataTypes;
12151215
}
12161216

1217-
void QgsProcessingParameterVectorLayer::setDataTypes( const QList<int> &types )
1217+
void QgsProcessingParameterFeatureSource::setDataTypes( const QList<int> &types )
12181218
{
12191219
mDataTypes = types;
12201220
}

‎src/core/processing/qgsprocessingparameters.h

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ class CORE_EXPORT QgsProcessingParameterDefinition
8484
sipType = sipType_QgsProcessingParameterTable;
8585
else if ( sipCpp->type() == "field" )
8686
sipType = sipType_QgsProcessingParameterTableField;
87-
else if ( sipCpp->type() == "vector" )
88-
sipType = sipType_QgsProcessingParameterVectorLayer;
87+
else if ( sipCpp->type() == "source" )
88+
sipType = sipType_QgsProcessingParameterFeatureSource;
8989
else if ( sipCpp->type() == "vectorOut" )
9090
sipType = sipType_QgsProcessingParameterOutputVectorLayer;
9191
SIP_END
@@ -1008,33 +1008,33 @@ class CORE_EXPORT QgsProcessingParameterTableField : public QgsProcessingParamet
10081008
};
10091009

10101010
/**
1011-
* \class QgsProcessingParameterVectorLayer
1011+
* \class QgsProcessingParameterFeatureSource
10121012
* \ingroup core
1013-
* A vector layer parameter for processing algorithms.
1013+
* An input feature source (such as vector layers) parameter for processing algorithms.
10141014
* \since QGIS 3.0
10151015
*/
1016-
class CORE_EXPORT QgsProcessingParameterVectorLayer : public QgsProcessingParameterDefinition
1016+
class CORE_EXPORT QgsProcessingParameterFeatureSource : public QgsProcessingParameterDefinition
10171017
{
10181018
public:
10191019

10201020
/**
1021-
* Constructor for QgsProcessingParameterVectorLayer.
1021+
* Constructor for QgsProcessingParameterFeatureSource.
10221022
*/
1023-
QgsProcessingParameterVectorLayer( const QString &name, const QString &description = QString(),
1024-
const QList< int > &types = QList< int >(),
1025-
const QVariant &defaultValue = QVariant(), bool optional = false );
1023+
QgsProcessingParameterFeatureSource( const QString &name, const QString &description = QString(),
1024+
const QList< int > &types = QList< int >(),
1025+
const QVariant &defaultValue = QVariant(), bool optional = false );
10261026

1027-
QString type() const override { return QStringLiteral( "vector" ); }
1027+
QString type() const override { return QStringLiteral( "source" ); }
10281028
bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
10291029

10301030
/**
1031-
* Returns the layer types for layers acceptable by the parameter.
1031+
* Returns the geometry types for sources acceptable by the parameter.
10321032
* \see setDataTypes()
10331033
*/
10341034
QList< int > dataTypes() const;
10351035

10361036
/**
1037-
* Sets the layer \a types for layers acceptable by the parameter.
1037+
* Sets the geometry \a types for sources acceptable by the parameter.
10381038
* \see dataTypes()
10391039
*/
10401040
void setDataTypes( const QList< int > &types );

‎tests/src/core/testqgsprocessing.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2133,7 +2133,7 @@ void TestQgsProcessing::parameterVectorLayer()
21332133
context.setProject( &p );
21342134

21352135
// not optional!
2136-
std::unique_ptr< QgsProcessingParameterVectorLayer > def( new QgsProcessingParameterVectorLayer( "non_optional", QString(), QList< int >() << QgsProcessingParameterDefinition::TypeVectorAny, QString( "EPSG:3113" ), false ) );
2136+
std::unique_ptr< QgsProcessingParameterFeatureSource > def( new QgsProcessingParameterFeatureSource( "non_optional", QString(), QList< int >() << QgsProcessingParameterDefinition::TypeVectorAny, QString( "EPSG:3113" ), false ) );
21372137
QVERIFY( !def->checkValueIsAcceptable( false ) );
21382138
QVERIFY( !def->checkValueIsAcceptable( true ) );
21392139
QVERIFY( !def->checkValueIsAcceptable( 5 ) );
@@ -2164,7 +2164,7 @@ void TestQgsProcessing::parameterVectorLayer()
21642164
QVERIFY( !QgsProcessingParameters::parameterAsVectorLayer( def.get(), params, context ) );
21652165

21662166
// optional
2167-
def.reset( new QgsProcessingParameterVectorLayer( "optional", QString(), QList< int >() << QgsProcessingParameterDefinition::TypeVectorAny, v1->id(), true ) );
2167+
def.reset( new QgsProcessingParameterFeatureSource( "optional", QString(), QList< int >() << QgsProcessingParameterDefinition::TypeVectorAny, v1->id(), true ) );
21682168
params.insert( "optional", QVariant() );
21692169
QCOMPARE( QgsProcessingParameters::parameterAsVectorLayer( def.get(), params, context )->id(), v1->id() );
21702170
QVERIFY( def->checkValueIsAcceptable( false ) );

0 commit comments

Comments
 (0)