|
| 1 | +/*************************************************************************** |
| 2 | + qgsalgorithmaddincrementalfield.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 | + |
| 18 | +#include "qgsalgorithmaddincrementalfield.h" |
| 19 | + |
| 20 | +///@cond PRIVATE |
| 21 | + |
| 22 | +QString QgsAddIncrementalFieldAlgorithm::name() const |
| 23 | +{ |
| 24 | + return QStringLiteral( "addautoincrementalfield" ); |
| 25 | +} |
| 26 | + |
| 27 | +QString QgsAddIncrementalFieldAlgorithm::displayName() const |
| 28 | +{ |
| 29 | + return QObject::tr( "Add autoincremental field" ); |
| 30 | +} |
| 31 | + |
| 32 | +QString QgsAddIncrementalFieldAlgorithm::shortHelpString() const |
| 33 | +{ |
| 34 | + return QObject::tr( "This algorithm adds a new integer field to a vector layer, with a sequential value for each feature.\n\n" |
| 35 | + "This field can be used as a unique ID for features in the layer. The new attribute " |
| 36 | + "is not added to the input layer but a new layer is generated instead.\n\n" |
| 37 | + "The initial starting value for the incremental series can be specified." ); |
| 38 | +} |
| 39 | + |
| 40 | +QStringList QgsAddIncrementalFieldAlgorithm::tags() const |
| 41 | +{ |
| 42 | + return QObject::tr( "add,create,serial,primary,key,unique,field" ).split( ',' ); |
| 43 | +} |
| 44 | + |
| 45 | +QString QgsAddIncrementalFieldAlgorithm::group() const |
| 46 | +{ |
| 47 | + return QObject::tr( "Vector table" ); |
| 48 | +} |
| 49 | + |
| 50 | +QString QgsAddIncrementalFieldAlgorithm::outputName() const |
| 51 | +{ |
| 52 | + return QObject::tr( "Incremented" ); |
| 53 | +} |
| 54 | + |
| 55 | +QList<int> QgsAddIncrementalFieldAlgorithm::inputLayerTypes() const |
| 56 | +{ |
| 57 | + return QList<int>() << QgsProcessing::TypeVector; |
| 58 | +} |
| 59 | + |
| 60 | +QgsAddIncrementalFieldAlgorithm *QgsAddIncrementalFieldAlgorithm::createInstance() const |
| 61 | +{ |
| 62 | + return new QgsAddIncrementalFieldAlgorithm(); |
| 63 | +} |
| 64 | + |
| 65 | +void QgsAddIncrementalFieldAlgorithm::initParameters( const QVariantMap & ) |
| 66 | +{ |
| 67 | + addParameter( new QgsProcessingParameterString( QStringLiteral( "FIELD_NAME" ), QObject::tr( "Field name" ), QStringLiteral( "AUTO" ) ) ); |
| 68 | + addParameter( new QgsProcessingParameterNumber( QStringLiteral( "START" ), QObject::tr( "Start values at" ), |
| 69 | + QgsProcessingParameterNumber::Integer, 0, true ) ); |
| 70 | +} |
| 71 | + |
| 72 | +QgsFields QgsAddIncrementalFieldAlgorithm::outputFields( const QgsFields &inputFields ) const |
| 73 | +{ |
| 74 | + QgsFields outFields = inputFields; |
| 75 | + outFields.append( QgsField( mFieldName, QVariant::LongLong ) ); |
| 76 | + return outFields; |
| 77 | +} |
| 78 | + |
| 79 | +bool QgsAddIncrementalFieldAlgorithm::prepareAlgorithm( const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback * ) |
| 80 | +{ |
| 81 | + mValue = parameterAsInt( parameters, QStringLiteral( "START" ), context ); |
| 82 | + mFieldName = parameterAsString( parameters, QStringLiteral( "FIELD_NAME" ), context ); |
| 83 | + return true; |
| 84 | +} |
| 85 | + |
| 86 | +QgsFeature QgsAddIncrementalFieldAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingFeedback * ) |
| 87 | +{ |
| 88 | + QgsFeature f = feature; |
| 89 | + QgsAttributes attributes = f.attributes(); |
| 90 | + attributes.append( mValue ); |
| 91 | + mValue++; |
| 92 | + f.setAttributes( attributes ); |
| 93 | + return f; |
| 94 | +} |
| 95 | + |
| 96 | +///@endcond |
0 commit comments