qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider Class Reference

Inheritance diagram for qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider:

Collaboration diagram for qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider:

Public Member Functions
def	__init__ (self)
def	initializeSettings (self)
def	unload (self)
def	getName (self)
def	getDescription (self)
def	getIcon (self)

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

getDescription()

def qgis.pktoolsAlgorithmProvider.pktoolsAlgorithmProvider.getDescription

(

self

)

This is the provired full name.

Definition at line 100 of file pktoolsAlgorithmProvider.py.

    def getDescription(self):
        '''This is the provired full name.
        '''
        return "Utilities for remote sensing image processing"

getName()

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.

    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
        from this provider
        '''
        return "pktools"

initializeSettings()

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.

    def 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
        '''
        AlgorithmProvider.initializeSettings(self)
        ProcessingConfig.addSetting(Setting(self.getDescription(), pktoolsUtils.PKTOOLS_FOLDER, "pktools folder", pktoolsUtils.pktoolsPath()))

#        ProcessingConfig.addSetting(Setting("Example algorithms", pktoolsAlgorithmProvider.MY_DUMMY_SETTING, "Example setting", "Default value"))

unload()

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.

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

---

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

• /home/kempepi/PKTOOLS-2.6.7.6/qgis/pktoolsAlgorithmProvider.py