Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmloadlayer.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                 :            : 
      18                 :            : #include "qgsalgorithmloadlayer.h"
      19                 :            : 
      20                 :            : ///@cond PRIVATE
      21                 :            : 
      22                 :          0 : QString QgsLoadLayerAlgorithm::name() const
      23                 :            : {
      24                 :          0 :   return QStringLiteral( "loadlayer" );
      25                 :            : }
      26                 :            : 
      27                 :          0 : QgsProcessingAlgorithm::Flags QgsLoadLayerAlgorithm::flags() const
      28                 :            : {
      29                 :          0 :   return FlagHideFromToolbox | FlagNotAvailableInStandaloneTool;
      30                 :            : }
      31                 :            : 
      32                 :          0 : QString QgsLoadLayerAlgorithm::displayName() const
      33                 :            : {
      34                 :          0 :   return QObject::tr( "Load layer into project" );
      35                 :            : }
      36                 :            : 
      37                 :          0 : QStringList QgsLoadLayerAlgorithm::tags() const
      38                 :            : {
      39                 :          0 :   return QObject::tr( "load,open,layer,raster,vector,project" ).split( ',' );
      40                 :          0 : }
      41                 :            : 
      42                 :          0 : QString QgsLoadLayerAlgorithm::group() const
      43                 :            : {
      44                 :          0 :   return QObject::tr( "Modeler tools" );
      45                 :            : }
      46                 :            : 
      47                 :          0 : QString QgsLoadLayerAlgorithm::groupId() const
      48                 :            : {
      49                 :          0 :   return QStringLiteral( "modelertools" );
      50                 :            : }
      51                 :            : 
      52                 :          0 : QString QgsLoadLayerAlgorithm::shortHelpString() const
      53                 :            : {
      54                 :          0 :   return QObject::tr( "This algorithm loads a layer to the current project." );
      55                 :            : }
      56                 :            : 
      57                 :          0 : QgsLoadLayerAlgorithm *QgsLoadLayerAlgorithm::createInstance() const
      58                 :            : {
      59                 :          0 :   return new QgsLoadLayerAlgorithm();
      60                 :            : }
      61                 :            : 
      62                 :          0 : void QgsLoadLayerAlgorithm::initAlgorithm( const QVariantMap & )
      63                 :            : {
      64                 :          0 :   addParameter( new QgsProcessingParameterMapLayer( QStringLiteral( "INPUT" ), QObject::tr( "Layer" ) ) );
      65                 :          0 :   addParameter( new QgsProcessingParameterString( QStringLiteral( "NAME" ), QObject::tr( "Loaded layer name" ) ) );
      66                 :          0 :   addOutput( new QgsProcessingOutputMapLayer( QStringLiteral( "OUTPUT" ), QObject::tr( "Layer" ) ) );
      67                 :          0 : }
      68                 :            : 
      69                 :          0 : QVariantMap QgsLoadLayerAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
      70                 :            : {
      71                 :          0 :   QgsMapLayer *layer = parameterAsLayer( parameters, QStringLiteral( "INPUT" ), context );
      72                 :          0 :   QString name = parameterAsString( parameters, QStringLiteral( "NAME" ), context );
      73                 :            : 
      74                 :          0 :   if ( !layer )
      75                 :          0 :     throw QgsProcessingException( QObject::tr( "Invalid input layer" ) );
      76                 :            : 
      77                 :          0 :   if ( name.isEmpty() )
      78                 :          0 :     throw QgsProcessingException( QObject::tr( "Invalid (empty) layer name" ) );
      79                 :            : 
      80                 :          0 :   layer->setName( name );
      81                 :          0 :   QgsProcessingContext::LayerDetails details( name, context.project(), name );
      82                 :          0 :   details.forceName = true;
      83                 :          0 :   context.addLayerToLoadOnCompletion( layer->id(), details );
      84                 :            : 
      85                 :          0 :   QVariantMap results;
      86                 :          0 :   results.insert( QStringLiteral( "OUTPUT" ), layer->id() );
      87                 :          0 :   return results;
      88                 :          0 : }
      89                 :            : 
      90                 :            : ///@endcond