QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
qgsalgorithmrenamelayer.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmrenamelayer.cpp
3  ---------------------
4  begin : November 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 
21 
22 QString QgsRenameLayerAlgorithm::name() const
23 {
24  return QStringLiteral( "renamelayer" );
25 }
26 
27 QgsProcessingAlgorithm::Flags QgsRenameLayerAlgorithm::flags() const
28 {
29  return FlagHideFromToolbox;
30 }
31 
32 QString QgsRenameLayerAlgorithm::displayName() const
33 {
34  return QObject::tr( "Rename layer" );
35 }
36 
37 QStringList QgsRenameLayerAlgorithm::tags() const
38 {
39  return QObject::tr( "change,layer,name,title" ).split( ',' );
40 }
41 
42 QString QgsRenameLayerAlgorithm::group() const
43 {
44  return QObject::tr( "Modeler tools" );
45 }
46 
47 QString QgsRenameLayerAlgorithm::groupId() const
48 {
49  return QStringLiteral( "modelertools" );
50 }
51 
52 QString QgsRenameLayerAlgorithm::shortHelpString() const
53 {
54  return QObject::tr( "This algorithm renames a layer." );
55 }
56 
57 QgsRenameLayerAlgorithm *QgsRenameLayerAlgorithm::createInstance() const
58 {
59  return new QgsRenameLayerAlgorithm();
60 }
61 
62 void QgsRenameLayerAlgorithm::initAlgorithm( const QVariantMap & )
63 {
64  addParameter( new QgsProcessingParameterMapLayer( QStringLiteral( "INPUT" ), QObject::tr( "Layer" ) ) );
65  addParameter( new QgsProcessingParameterString( QStringLiteral( "NAME" ), QObject::tr( "New name" ) ) );
66  addOutput( new QgsProcessingOutputMapLayer( QStringLiteral( "OUTPUT" ), QObject::tr( "Layer" ) ) );
67 }
68 
69 QVariantMap QgsRenameLayerAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
70 {
71  QgsMapLayer *layer = parameterAsLayer( parameters, QStringLiteral( "INPUT" ), context );
72  const QString name = parameterAsString( parameters, QStringLiteral( "NAME" ), context );
73 
74  if ( !layer )
75  throw QgsProcessingException( QObject::tr( "Invalid input layer" ) );
76 
77  if ( name.isEmpty() )
78  throw QgsProcessingException( QObject::tr( "Invalid (empty) layer name" ) );
79 
80  const bool parameterWasLayerName = parameters.value( QStringLiteral( "INPUT" ) ).toString() == layer->name();
81 
82  layer->setName( name );
83  QVariantMap results;
84  if ( parameterWasLayerName )
85  results.insert( QStringLiteral( "OUTPUT" ), name );
86  else
87  results.insert( QStringLiteral( "OUTPUT" ), parameters.value( QStringLiteral( "INPUT" ) ) );
88 
89  return results;
90 }
91 
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition: qgsprocessingfeedback.h:37
QgsProcessingParameterMapLayer
A map layer parameter for processing algorithms.
Definition: qgsprocessingparameters.h:2901
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition: qgsprocessingcontext.h:46
QgsProcessingParameterString
A string parameter for processing algorithms.
Definition: qgsprocessingparameters.h:2647
qgsalgorithmrenamelayer.h
QgsMapLayer::setName
void setName(const QString &name)
Set the display name of the layer.
Definition: qgsmaplayer.cpp:174
QgsMapLayer
Base class for all map layer types. This is the base class for all map layer types (vector,...
Definition: qgsmaplayer.h:72
QgsMapLayer::name
QString name
Definition: qgsmaplayer.h:76
QgsProcessingOutputMapLayer
A map layer output for processing algorithms, where layers may be either vector or raster.
Definition: qgsprocessingoutputs.h:156
QgsProcessingException
Custom exception class for processing related exceptions.
Definition: qgsexception.h:82