pktools  2.6.7
Processing Kernel for geospatial data
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider Class Reference
Inheritance diagram for qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider:
Inheritance graph
[legend]
Collaboration diagram for qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider:
Collaboration graph
[legend]

Public Member Functions

def __init__
 
def initializeSettings
 
def unload
 
def getName
 
def getDescription
 
def getIcon
 

Public Attributes

 activate
 
 alglist
 
 algs
 

Static Public Attributes

string MY_DUMMY_SETTING = "MY_DUMMY_SETTING"
 

Detailed Description

Definition at line 55 of file pktoolsAlgorithmProvider.py.

Member Function Documentation

def qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider.getDescription (   self)
This is the provired full name.

Definition at line 100 of file pktoolsAlgorithmProvider.py.

101  def getDescription(self):
102  '''This is the provired full name.
103  '''
104  return "Utilities for remote sensing image processing"
def qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider.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
from this provider

Definition at line 93 of file pktoolsAlgorithmProvider.py.

93 
94  def getName(self):
95  '''This is the name that will appear on the toolbox group.
96  It is also used to create the command line name of all the algorithms
97  from this provider
98  '''
99  return "pktools"
def qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider.initializeSettings (   self)
In this method we add settings needed to configure our provider.
Do not forget to call the parent method, since it takes care or
automatically adding a setting for activating or deactivating the
algorithms in the provider

Definition at line 73 of file pktoolsAlgorithmProvider.py.

73 
74  def initializeSettings(self):
75  '''In this method we add settings needed to configure our provider.
76  Do not forget to call the parent method, since it takes care or
77  automatically adding a setting for activating or deactivating the
78  algorithms in the provider
79  '''
80  AlgorithmProvider.initializeSettings(self)
81  ProcessingConfig.addSetting(Setting(self.getDescription(), pktoolsUtils.PKTOOLS_FOLDER, "pktools folder", pktoolsUtils.pktoolsPath()))
82 
# ProcessingConfig.addSetting(Setting("Example algorithms", pktoolsAlgorithmProvider.MY_DUMMY_SETTING, "Example setting", "Default value"))
def qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider.unload (   self)
Setting should be removed here, so they do not appear anymore
when the plugin is unloaded

Definition at line 87 of file pktoolsAlgorithmProvider.py.

87 
88  def unload(self):
89  '''Setting should be removed here, so they do not appear anymore
90  when the plugin is unloaded'''
91  AlgorithmProvider.unload(self)
92  ProcessingConfig.removeSetting(pktoolsAlgorithmProvider.MY_DUMMY_SETTING)

The documentation for this class was generated from the following file: