QGIS API Documentation 3.99.0-Master (357b655ed83)
Loading...
Searching...
No Matches
qgsalgorithmmergelines.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmmergelines.cpp
3 ---------------------
4 begin : April 2017
5 copyright : (C) 2017 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
19
20#include <QString>
21
22using namespace Qt::StringLiterals;
23
25
26QString QgsMergeLinesAlgorithm::name() const
27{
28 return u"mergelines"_s;
29}
30
31QString QgsMergeLinesAlgorithm::displayName() const
32{
33 return QObject::tr( "Merge lines" );
34}
35
36QStringList QgsMergeLinesAlgorithm::tags() const
37{
38 return QObject::tr( "line,merge,join,parts" ).split( ',' );
39}
40
41QString QgsMergeLinesAlgorithm::group() const
42{
43 return QObject::tr( "Vector geometry" );
44}
45
46QString QgsMergeLinesAlgorithm::groupId() const
47{
48 return u"vectorgeometry"_s;
49}
50
51QString QgsMergeLinesAlgorithm::outputName() const
52{
53 return QObject::tr( "Merged" );
54}
55
56Qgis::ProcessingSourceType QgsMergeLinesAlgorithm::outputLayerType() const
57{
59}
60
61Qgis::WkbType QgsMergeLinesAlgorithm::outputWkbType( Qgis::WkbType ) const
62{
64}
65
66QString QgsMergeLinesAlgorithm::shortHelpString() const
67{
68 return QObject::tr( "This algorithm joins all connected parts of MultiLineString geometries into single LineString geometries.\n\n"
69 "If any parts of the input MultiLineString geometries are not connected, the resultant "
70 "geometry will be a MultiLineString containing any lines which could be merged and any non-connected line parts." );
71}
72
73QString QgsMergeLinesAlgorithm::shortDescription() const
74{
75 return QObject::tr( "Joins all connected parts of MultiLineString geometries into single LineString geometries." );
76}
77
78QList<int> QgsMergeLinesAlgorithm::inputLayerTypes() const
79{
80 return QList<int>() << static_cast<int>( Qgis::ProcessingSourceType::VectorLine );
81}
82
83QgsMergeLinesAlgorithm *QgsMergeLinesAlgorithm::createInstance() const
84{
85 return new QgsMergeLinesAlgorithm();
86}
87
88QgsFeatureList QgsMergeLinesAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &, QgsProcessingFeedback *feedback )
89{
90 if ( !feature.hasGeometry() )
91 return QgsFeatureList() << feature;
92
93 QgsFeature out = feature;
94 const QgsGeometry outputGeometry = feature.geometry().mergeLines();
95 if ( outputGeometry.isNull() )
96 feedback->reportError( QObject::tr( "Error merging lines for feature %1" ).arg( feature.id() ) );
97
98 out.setGeometry( outputGeometry );
99 return QgsFeatureList() << out;
100}
101
ProcessingSourceType
Processing data source types.
Definition qgis.h:3602
@ VectorLine
Vector line layers.
Definition qgis.h:3606
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:280
@ MultiLineString
MultiLineString.
Definition qgis.h:287
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:60
QgsFeatureId id
Definition qgsfeature.h:68
QgsGeometry geometry
Definition qgsfeature.h:71
bool hasGeometry() const
Returns true if the feature has an associated geometry.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
A geometry is the spatial representation of a feature.
QgsGeometry mergeLines(const QgsGeometryParameters &parameters=QgsGeometryParameters()) const
Merges any connected lines in a LineString/MultiLineString geometry and converts them to single line ...
Contains information about the context in which a processing algorithm is executed.
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.
QList< QgsFeature > QgsFeatureList