QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
qgsalgorithmcreatedirectory.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmcreatedirectory.cpp
3 ---------------------
4 begin : June 2020
5 copyright : (C) 2020 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 ***************************************************************************/
18
20
21QString QgsCreateDirectoryAlgorithm::name() const
22{
23 return QStringLiteral( "createdirectory" );
24}
25
26Qgis::ProcessingAlgorithmFlags QgsCreateDirectoryAlgorithm::flags() const
27{
29}
30
31QString QgsCreateDirectoryAlgorithm::displayName() const
32{
33 return QObject::tr( "Create directory" );
34}
35
36QStringList QgsCreateDirectoryAlgorithm::tags() const
37{
38 return QObject::tr( "new,make,folder" ).split( ',' );
39}
40
41QString QgsCreateDirectoryAlgorithm::group() const
42{
43 return QObject::tr( "Modeler tools" );
44}
45
46QString QgsCreateDirectoryAlgorithm::groupId() const
47{
48 return QStringLiteral( "modelertools" );
49}
50
51QString QgsCreateDirectoryAlgorithm::shortHelpString() const
52{
53 return QObject::tr( "This algorithm creates a new directory on a file system. Directories will be created recursively, creating all "
54 "required parent directories in order to construct the full specified directory path.\n\n"
55 "No errors will be raised if the directory already exists." );
56}
57
58QString QgsCreateDirectoryAlgorithm::shortDescription() const
59{
60 return QObject::tr( "Creates a new directory on a file system." );
61}
62
63QgsCreateDirectoryAlgorithm *QgsCreateDirectoryAlgorithm::createInstance() const
64{
65 return new QgsCreateDirectoryAlgorithm();
66}
67
68void QgsCreateDirectoryAlgorithm::initAlgorithm( const QVariantMap & )
69{
70 addParameter( new QgsProcessingParameterMapLayer( QStringLiteral( "PATH" ), QObject::tr( "Directory path" ) ) );
71 addOutput( new QgsProcessingOutputFolder( QStringLiteral( "OUTPUT" ), QObject::tr( "Directory" ) ) );
72}
73
74QVariantMap QgsCreateDirectoryAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
75{
76 const QString path = parameterAsString( parameters, QStringLiteral( "PATH" ), context );
77
78 if ( !path.isEmpty() )
79 {
80 if ( QFile::exists( path ) )
81 {
82 if ( !QFileInfo( path ).isDir() )
83 throw QgsProcessingException( QObject::tr( "A file with the name %1 already exists -- cannot create a new directory here." ).arg( path ) );
84 if ( feedback )
85 feedback->pushInfo( QObject::tr( "The directory %1 already exists." ).arg( path ) );
86 }
87 else
88 {
89 if ( !QDir().mkpath( path ) )
90 {
91 throw QgsProcessingException( QObject::tr( "Could not create directory %1. Please check that you have write permissions for the specified path." ).arg( path ) );
92 }
93
94 if ( feedback )
95 feedback->pushInfo( QObject::tr( "Created %1" ).arg( path ) );
96 }
97 }
98
99 QVariantMap results;
100 results.insert( QStringLiteral( "OUTPUT" ), path );
101 return results;
102}
103
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3076
@ HideFromToolbox
Algorithm should be hidden from the toolbox.
@ SkipGenericModelLogging
When running as part of a model, the generic algorithm setup and results logging should be skipped.
Contains information about the context in which a processing algorithm is executed.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
A folder output for processing algorithms.
A map layer parameter for processing algorithms.