Made provider names more descriptive

git-svn-id: http://sextante.googlecode.com/svn/trunk/soft/bindings/qgis-plugin@149 881b9c09-3ef8-f3c2-ec3d-21d735c97f4d
qgis · Apr 24, 2012 · 36db53a · 36db53a
1 parent dbbcca2
commit 36db53a
Show file tree

Hide file tree

Showing 16 changed files with 58 additions and 13 deletions.
diff --git a/src/sextante/core/AlgorithmProvider.py b/src/sextante/core/AlgorithmProvider.py
@@ -47,6 +47,11 @@ def unload(self):
         SextanteConfig.removeSetting(name)
 
     def getName(self):
+        '''Returns the name to use to create the command-line name. Should be a short descriptive name of the provider'''
+        return "sextante"
+
+    def getDescription(self):
+        '''Returns the full name of the provider'''
         return "Generic algorithm provider"
 
 

diff --git a/src/sextante/ftools/FToolsAlgorithmProvider.py b/src/sextante/ftools/FToolsAlgorithmProvider.py
@@ -43,6 +43,9 @@ def __init__(self):
                      Dissolve(), Difference(), Intersection(), Union(), Clip(), ExtentFromLayer(),
                      RandomSelection(), RandomSelectionWithinSubsets(), SelectByLocation()]
 
+    def getDescription(self):
+        return "fTools (Vector analysis)"
+
     def getName(self):
         return "ftools"
 

diff --git a/src/sextante/gdal/GdalAlgorithmProvider.py b/src/sextante/gdal/GdalAlgorithmProvider.py
@@ -35,8 +35,11 @@ def scriptsFolder(self):
         '''The folder where script algorithms are stored'''
         return os.path.dirname(__file__) + "/scripts"
 
+    def getDescription(self):
+        return "GDAL"
+
     def getName(self):
-        return "Gdal"
+        return "gdal"
 
     def getIcon(self):
         return QIcon(os.path.dirname(__file__) + "/icons/gdalicon.png")

diff --git a/src/sextante/grass/GrassAlgorithmProvider.py b/src/sextante/grass/GrassAlgorithmProvider.py
@@ -64,8 +64,11 @@ def createAlgsList(self):
     def _loadAlgorithms(self):
         self.algs = self.preloadedAlgs
 
+    def getDescription(self):
+        return "GRASS commands"
+
     def getName(self):
-        return "GRASS"
+        return "grass"
 
     def getIcon(self):
         return  QIcon(os.path.dirname(__file__) + "/../images/grass.png")

diff --git a/src/sextante/gui/SextanteToolbox.py b/src/sextante/gui/SextanteToolbox.py
@@ -156,7 +156,8 @@ def fillTree(self):
 
             if len(groups)>0:
                 providerItem = QtGui.QTreeWidgetItem()
-                providerItem.setText(0,providerName + " [" + str(len(provider)) + " geoalgorithms]")
+                providerItem.setText(0, Sextante.getProviderFromName(providerName).getDescription()
+                                     + " [" + str(len(provider)) + " geoalgorithms]")
                 providerItem.setIcon(0, Sextante.getProviderFromName(providerName).getIcon())
                 for groupItem in groups.values():
                     providerItem.addChild(groupItem)

diff --git a/src/sextante/lastools/LasToolsAlgorithmProvider.py b/src/sextante/lastools/LasToolsAlgorithmProvider.py
@@ -26,8 +26,12 @@ def __init__(self):
     def initializeSettings(self):
         AlgorithmProvider.initializeSettings(self)
         SextanteConfig.addSetting(Setting("LASTools", LasToolsUtils.LASTOOLS_FOLDER, "LASTools folder", LasToolsUtils.LasToolsPath()))
+
     def getName(self):
-        return "LASTools"
+        return "lastools"
+
+    def getDescription(self):
+        return "LASTools (Tools for LiDAR data)"
 
     def getIcon(self):
         return QIcon(os.path.dirname(__file__) + "/../images/tool.png")

diff --git a/src/sextante/mmqgis/MMQGISAlgorithmProvider.py b/src/sextante/mmqgis/MMQGISAlgorithmProvider.py
@@ -15,6 +15,8 @@ def __init__(self):
     def scriptsFolder(self):
         return os.path.dirname(__file__) + "/scripts"
 
+    def getDescription(self):
+        return "MMQGIS (Vector and table tools)"
     def getName(self):
         return "mmqgis"
 

diff --git a/src/sextante/modeler/ModelerAlgorithmProvider.py b/src/sextante/modeler/ModelerAlgorithmProvider.py
@@ -29,9 +29,12 @@ def setAlgsList(self, algs):
     def modelsFolder(self):
         return ModelerUtils.modelsFolder()
 
-    def getName(self):
+    def getDescription(self):
         return "Modeler"
 
+    def getName(self):
+        return "model"
+
     def getIcon(self):
         return QtGui.QIcon(os.path.dirname(__file__) + "/../images/model.png")
 

diff --git a/src/sextante/modeler/ModelerDialog.py b/src/sextante/modeler/ModelerDialog.py
@@ -307,7 +307,7 @@ def fillAlgorithmTree(self):
 
             if len(groups) > 0:
                 providerItem = QtGui.QTreeWidgetItem()
-                providerItem.setText(0, providerName)
+                providerItem.setText(0, Providers.providers[providerName].getDescription())
                 providerItem.setIcon(0, Providers.providers[providerName].getIcon())
                 for groupItem in groups.values():
                     providerItem.addChild(groupItem)

diff --git a/src/sextante/modeler/ModelerOnlyAlgorithmProvider.py b/src/sextante/modeler/ModelerOnlyAlgorithmProvider.py
@@ -12,8 +12,10 @@ class ModelerOnlyAlgorithmProvider(AlgorithmProvider):
     def __init__(self):
         AlgorithmProvider.__init__(self)
 
-
     def getName(self):
+        return "modelertools"
+
+    def getDescription(self):
         return "Modeler-only tools"
 
     def getIcon(self):

diff --git a/src/sextante/otb/OTBAlgorithmProvider.py b/src/sextante/otb/OTBAlgorithmProvider.py
@@ -13,8 +13,12 @@ def __init__(self):
         AlgorithmProvider.__init__(self)
         self.createAlgsList()
 
+
+    def getDescription(self):
+        return "Orfeo Toolbox (Image analysis)"
+
     def getName(self):
-        return "OTB"
+        return "otb"
 
     def getIcon(self):
         return QIcon(os.path.dirname(__file__) + "/../images/otb.png")

diff --git a/src/sextante/r/RAlgorithmProvider.py b/src/sextante/r/RAlgorithmProvider.py
@@ -34,8 +34,12 @@ def unload(self):
     def getIcon(self):
         return QtGui.QIcon(os.path.dirname(__file__) + "/../images/r.png")
 
+
+    def getDescription(self):
+        return "R scripts"
+
     def getName(self):
-        return "R"
+        return "r"
 
     def _loadAlgorithms(self):
         folder = RUtils.RScriptsFolder()

diff --git a/src/sextante/saga/SagaAlgorithmProvider.py b/src/sextante/saga/SagaAlgorithmProvider.py
@@ -45,15 +45,18 @@ def createAlgsList(self):
                 alg = SagaAlgorithm(os.path.join(folder, descriptionFile))
                 if alg.name.strip() != "":
                     self.preloadedAlgs.append(alg)
-            except Exception,e:
+            except Exception:
                 SextanteLog.addToLog(SextanteLog.LOG_ERROR, "Could not open SAGA algorithm: " + descriptionFile)
 
     def _loadAlgorithms(self):
         self.algs = self.preloadedAlgs
 
-    def getName(self):
+    def getDescription(self):
         return "SAGA"
 
+    def getName(self):
+        return "saga"
+
     def getIcon(self):
         return  QIcon(os.path.dirname(__file__) + "/../images/saga.png")
 

diff --git a/src/sextante/script/ScriptAlgorithmProvider.py b/src/sextante/script/ScriptAlgorithmProvider.py
@@ -34,6 +34,9 @@ def scriptsFolder(self):
         return ScriptUtils.scriptsFolder()
 
     def getName(self):
+        return "script"
+
+    def getDescription(self):
         return "Scripts"
 
     def _loadAlgorithms(self):

diff --git a/src/sextanteexampleprovider/ExampleAlgorithm.py b/src/sextanteexampleprovider/ExampleAlgorithm.py
@@ -6,6 +6,7 @@
 from PyQt4.QtCore import *
 from PyQt4.QtGui import *
 from sextante.parameters.ParameterExtent import ParameterExtent
+from sextante.parameters.ParameterCrs import ParameterCrs
 
 
 class ExampleAlgorithm(GeoAlgorithm):
@@ -39,6 +40,7 @@ def defineCharacteristics(self):
         #It is a mandatory (not optional) one, hence the False argument
         self.addParameter(ParameterVector(self.INPUT_LAYER, "Input layer", ParameterVector.VECTOR_TYPE_ANY, False))
         self.addParameter(ParameterExtent("EXTENT","EXTENT"))
+        self.addParameter(ParameterCrs("CRS", "CRS"))
         # we add a vector layer as output
         self.addOutput(OutputVector(self.OUTPUT_LAYER, "Output layer with selected features"))
 

diff --git a/src/sextanteexampleprovider/ExampleAlgorithmProvider.py b/src/sextanteexampleprovider/ExampleAlgorithmProvider.py
@@ -27,9 +27,12 @@ def unload(self):
 
 
     def getName(self):
-        '''This is the name that will appear on the toolbox group.
-        It is also used to create the command line name of all the algorithms
+        '''This name is  used to create the command line name of all the algorithms
         from this provider'''
+        return "exampleprovider"
+
+    def getDescription(self):
+        '''This is the name that will appear on the toolbox group.'''
         return "Example algorithms"
 
     def getIcon(self):