Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmaddixyfields.cpp
       3                 :            :                          -----------------------------------
       4                 :            :     begin                : March 2019
       5                 :            :     copyright            : (C) 2019 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 "qgsalgorithmaddxyfields.h"
      19                 :            : #include "qgsfeaturerequest.h"
      20                 :            : #include "qgsvectorlayer.h"
      21                 :            : 
      22                 :            : ///@cond PRIVATE
      23                 :            : 
      24                 :          0 : QString QgsAddXYFieldsAlgorithm::name() const
      25                 :            : {
      26                 :          0 :   return QStringLiteral( "addxyfields" );
      27                 :            : }
      28                 :            : 
      29                 :          0 : QString QgsAddXYFieldsAlgorithm::displayName() const
      30                 :            : {
      31                 :          0 :   return QObject::tr( "Add X/Y fields to layer" );
      32                 :            : }
      33                 :            : 
      34                 :          0 : QString QgsAddXYFieldsAlgorithm::shortHelpString() const
      35                 :            : {
      36                 :          0 :   return QObject::tr( "Adds X and Y (or latitude/longitude) fields to a point layer. The X/Y fields can be calculated in a different CRS to the layer (e.g. creating latitude/longitude fields for a layer in a project CRS)." );
      37                 :            : }
      38                 :            : 
      39                 :          0 : QString QgsAddXYFieldsAlgorithm::shortDescription() const
      40                 :            : {
      41                 :          0 :   return QObject::tr( "Adds X and Y (or latitude/longitude) fields to a point layer." );
      42                 :            : }
      43                 :            : 
      44                 :          0 : QStringList QgsAddXYFieldsAlgorithm::tags() const
      45                 :            : {
      46                 :          0 :   return QObject::tr( "add,create,latitude,longitude,columns,attributes" ).split( ',' );
      47                 :          0 : }
      48                 :            : 
      49                 :          0 : QString QgsAddXYFieldsAlgorithm::group() const
      50                 :            : {
      51                 :          0 :   return QObject::tr( "Vector table" );
      52                 :            : }
      53                 :            : 
      54                 :          0 : QString QgsAddXYFieldsAlgorithm::groupId() const
      55                 :            : {
      56                 :          0 :   return QStringLiteral( "vectortable" );
      57                 :            : }
      58                 :            : 
      59                 :          0 : QString QgsAddXYFieldsAlgorithm::outputName() const
      60                 :            : {
      61                 :          0 :   return QObject::tr( "Added fields" );
      62                 :            : }
      63                 :            : 
      64                 :          0 : QList<int> QgsAddXYFieldsAlgorithm::inputLayerTypes() const
      65                 :            : {
      66                 :          0 :   return QList<int>() << QgsProcessing::TypeVectorPoint;
      67                 :          0 : }
      68                 :            : 
      69                 :          0 : QgsAddXYFieldsAlgorithm *QgsAddXYFieldsAlgorithm::createInstance() const
      70                 :            : {
      71                 :          0 :   return new QgsAddXYFieldsAlgorithm();
      72                 :          0 : }
      73                 :            : 
      74                 :          0 : QgsProcessingFeatureSource::Flag QgsAddXYFieldsAlgorithm::sourceFlags() const
      75                 :            : {
      76                 :          0 :   return QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks;
      77                 :            : }
      78                 :            : 
      79                 :          0 : void QgsAddXYFieldsAlgorithm::initParameters( const QVariantMap &configuration )
      80                 :            : {
      81                 :          0 :   mIsInPlace = configuration.value( QStringLiteral( "IN_PLACE" ) ).toBool();
      82                 :            : 
      83                 :          0 :   addParameter( new QgsProcessingParameterCrs( QStringLiteral( "CRS" ), QObject::tr( "Coordinate system" ), QStringLiteral( "EPSG:4326" ) ) );
      84                 :            : 
      85                 :          0 :   if ( !mIsInPlace )
      86                 :          0 :     addParameter( new QgsProcessingParameterString( QStringLiteral( "PREFIX" ), QObject::tr( "Field prefix" ), QVariant(), false, true ) );
      87                 :            :   else
      88                 :            :   {
      89                 :          0 :     addParameter( new QgsProcessingParameterField( QStringLiteral( "FIELD_X" ), QObject::tr( "X field" ), QVariant(), QStringLiteral( "INPUT" ) ) );
      90                 :          0 :     addParameter( new QgsProcessingParameterField( QStringLiteral( "FIELD_Y" ), QObject::tr( "Y field" ), QVariant(), QStringLiteral( "INPUT" ) ) );
      91                 :            :   }
      92                 :          0 : }
      93                 :            : 
      94                 :          0 : QgsFields QgsAddXYFieldsAlgorithm::outputFields( const QgsFields &inputFields ) const
      95                 :            : {
      96                 :          0 :   if ( mIsInPlace )
      97                 :            :   {
      98                 :          0 :     mInPlaceXFieldIndex = inputFields.lookupField( mInPlaceXField );
      99                 :          0 :     mInPlaceYFieldIndex = inputFields.lookupField( mInPlaceYField );
     100                 :          0 :     return inputFields;
     101                 :            :   }
     102                 :            :   else
     103                 :            :   {
     104                 :          0 :     const QString xFieldName = mPrefix + 'x';
     105                 :          0 :     const QString yFieldName = mPrefix + 'y';
     106                 :            : 
     107                 :          0 :     QgsFields outFields = inputFields;
     108                 :          0 :     outFields.append( QgsField( xFieldName, QVariant::Double, QString(), 20, 10 ) );
     109                 :          0 :     outFields.append( QgsField( yFieldName, QVariant::Double, QString(), 20, 10 ) );
     110                 :          0 :     return outFields;
     111                 :          0 :   }
     112                 :          0 : }
     113                 :            : 
     114                 :          0 : QgsCoordinateReferenceSystem QgsAddXYFieldsAlgorithm::outputCrs( const QgsCoordinateReferenceSystem &inputCrs ) const
     115                 :            : {
     116                 :          0 :   mSourceCrs = inputCrs;
     117                 :          0 :   return inputCrs;
     118                 :            : }
     119                 :            : 
     120                 :          0 : bool QgsAddXYFieldsAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
     121                 :            : {
     122                 :          0 :   if ( !mIsInPlace )
     123                 :          0 :     mPrefix = parameterAsString( parameters, QStringLiteral( "PREFIX" ), context );
     124                 :            :   else
     125                 :            :   {
     126                 :          0 :     mInPlaceXField = parameterAsString( parameters, QStringLiteral( "FIELD_X" ), context );
     127                 :          0 :     mInPlaceYField = parameterAsString( parameters, QStringLiteral( "FIELD_Y" ), context );
     128                 :            :   }
     129                 :            : 
     130                 :          0 :   mCrs = parameterAsCrs( parameters, QStringLiteral( "CRS" ), context );
     131                 :          0 :   return true;
     132                 :          0 : }
     133                 :            : 
     134                 :          0 : QgsFeatureList QgsAddXYFieldsAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
     135                 :            : {
     136                 :          0 :   if ( mTransformNeedsInitialization )
     137                 :            :   {
     138                 :          0 :     mTransform = QgsCoordinateTransform( mSourceCrs, mCrs, context.transformContext() );
     139                 :          0 :     mTransformNeedsInitialization = false;
     140                 :          0 :   }
     141                 :          0 :   if ( mIsInPlace && mInPlaceXFieldIndex == -1 )
     142                 :            :   {
     143                 :          0 :     throw QgsProcessingException( QObject::tr( "Destination field not found" ) );
     144                 :            :   }
     145                 :            : 
     146                 :          0 :   QVariant x;
     147                 :          0 :   QVariant y;
     148                 :          0 :   if ( feature.hasGeometry() )
     149                 :            :   {
     150                 :          0 :     if ( feature.geometry().isMultipart() )
     151                 :          0 :       throw QgsProcessingException( QObject::tr( "Multipoint features are not supported - please convert to single point features first." ) );
     152                 :            : 
     153                 :          0 :     const QgsPointXY point = feature.geometry().asPoint();
     154                 :            :     try
     155                 :            :     {
     156                 :          0 :       const QgsPointXY transformed = mTransform.transform( point );
     157                 :          0 :       x = transformed.x();
     158                 :          0 :       y = transformed.y();
     159                 :          0 :     }
     160                 :            :     catch ( QgsCsException & )
     161                 :            :     {
     162                 :          0 :       feedback->reportError( QObject::tr( "Could not transform point to destination CRS" ) );
     163                 :          0 :     }
     164                 :          0 :   }
     165                 :          0 :   QgsFeature f =  feature;
     166                 :          0 :   QgsAttributes attributes = f.attributes();
     167                 :          0 :   if ( !mIsInPlace )
     168                 :            :   {
     169                 :          0 :     attributes << x << y;
     170                 :          0 :   }
     171                 :            :   else
     172                 :            :   {
     173                 :          0 :     attributes[mInPlaceXFieldIndex] = x;
     174                 :          0 :     attributes[mInPlaceYFieldIndex] = y;
     175                 :            :   }
     176                 :          0 :   f.setAttributes( attributes );
     177                 :          0 :   return QgsFeatureList() << f;
     178                 :          0 : }
     179                 :            : 
     180                 :          0 : bool QgsAddXYFieldsAlgorithm::supportInPlaceEdit( const QgsMapLayer *layer ) const
     181                 :            : {
     182                 :          0 :   if ( const QgsVectorLayer *vl = qobject_cast< const QgsVectorLayer * >( layer ) )
     183                 :            :   {
     184                 :          0 :     return vl->geometryType() == QgsWkbTypes::PointGeometry;
     185                 :            :   }
     186                 :          0 :   return false;
     187                 :          0 : }
     188                 :            : 
     189                 :            : ///@endcond