The algorithm-plugins are containers for filters and widgets. They do not have an own instance.
Filters are called by the filter(...)-Methods. To get an online help use filterHelp(...). Widgets are used with ui-dialogs. To get an online help use widgetHelp(...).
This function is used to invoke itom filter-functions or algorithms, declared within itom-algorithm plugins. The parameters (arguments) depends on the specific filter function (see filterHelp(name)), By filterHelp() a list of available filter functions is retrieved.
Parameters: | name : {str}
furtherParameters : {variant}
|
---|---|
Returns: | out : {variant}
|
See also
This method prints information about one specific filter (algorithm) or a list of filters to the console output. If one specific filter, defined in an algorithm plugin can be found that case-sensitively fits the given filterName its full documentation is printed. Else, a list of filters is printed whose name contains the given filterName.
Parameters: | filterName : {str}, optional
dictionary : {dict}, optional
furtherInfos : {int}, optional
|
---|---|
Returns: | out : {None or dict}
|
This method prints information about one specific widget or a list of widgets to the console output. If one specific widget, defined in an algorithm plugin can be found that case-sensitively fits the given widgetName its full documentation is printed. Else, a list of widgets is printed whose name contains the given widgetName.
Parameters: | widgetName : {str}, optional
dictionary : {dict}, optional
furtherInfos : {int}, optional
|
---|---|
Returns: | out : {None or dict}
|