QGIS API Documentation 3.99.0-Master (357b655ed83)
Loading...
Searching...
No Matches
qgsalgorithmstringconcatenation.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmstringconcatenation.cpp
3 ---------------------
4 begin : October 2017
5 copyright : (C) 2017 by Etienne Trimaille
6 email : etienne at kartoza 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 QgsStringConcatenationAlgorithm::name() const
27{
28 return u"stringconcatenation"_s;
29}
30
31Qgis::ProcessingAlgorithmFlags QgsStringConcatenationAlgorithm::flags() const
32{
34}
35
36QString QgsStringConcatenationAlgorithm::displayName() const
37{
38 return QObject::tr( "String concatenation" );
39}
40
41QStringList QgsStringConcatenationAlgorithm::tags() const
42{
43 return QObject::tr( "string,concatenation,merge" ).split( ',' );
44}
45
46QString QgsStringConcatenationAlgorithm::group() const
47{
48 return QObject::tr( "Modeler tools" );
49}
50
51QString QgsStringConcatenationAlgorithm::groupId() const
52{
53 return u"modelertools"_s;
54}
55
56QString QgsStringConcatenationAlgorithm::shortHelpString() const
57{
58 return QObject::tr( "This algorithm concatenates two strings together." );
59}
60
61QString QgsStringConcatenationAlgorithm::shortDescription() const
62{
63 return QObject::tr( "Concatenates two strings together." );
64}
65
66QgsStringConcatenationAlgorithm *QgsStringConcatenationAlgorithm::createInstance() const
67{
68 return new QgsStringConcatenationAlgorithm();
69}
70
71void QgsStringConcatenationAlgorithm::initAlgorithm( const QVariantMap & )
72{
73 addParameter( new QgsProcessingParameterString( u"INPUT_1"_s, QObject::tr( "Input 1" ), QVariant(), false, false ) );
74 addParameter( new QgsProcessingParameterString( u"INPUT_2"_s, QObject::tr( "Input 2" ), QVariant(), false, false ) );
75 addOutput( new QgsProcessingOutputString( u"CONCATENATION"_s, QObject::tr( "Concatenation" ) ) );
76}
77
78QVariantMap QgsStringConcatenationAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
79{
80 const QString input_1 = parameterAsString( parameters, u"INPUT_1"_s, context );
81 const QString input_2 = parameterAsString( parameters, u"INPUT_2"_s, context );
82
83 QVariantMap outputs;
84 outputs.insert( u"CONCATENATION"_s, QString( input_1 + input_2 ) );
85 return outputs;
86}
87
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3680
@ HideFromToolbox
Algorithm should be hidden from the toolbox.
Definition qgis.h:3654
@ SkipGenericModelLogging
When running as part of a model, the generic algorithm setup and results logging should be skipped.
Definition qgis.h:3665
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.
A string output for processing algorithms.
A string parameter for processing algorithms.