QGIS API Documentation
3.2.0-Bonn (bc43194)
|
Native c++ processing algorithm provider. More...
#include <qgsnativealgorithms.h>
Public Member Functions | |
QgsNativeAlgorithms (QObject *parent=nullptr) | |
Constructor for QgsNativeAlgorithms. More... | |
QString | helpId () const override |
Returns the provider help id string, used for creating QgsHelp urls for algorithms belong to this provider. More... | |
QIcon | icon () const override |
Returns an icon for the provider. More... | |
QString | id () const override |
Returns the unique provider id, used for identifying the provider. More... | |
QString | name () const override |
Returns the provider name, which is used to describe the provider within the GUI. More... | |
bool | supportsNonFileBasedOutput () const override |
Returns true if the provider supports non-file based outputs (such as memory layers or direct database outputs). More... | |
QString | svgIconPath () const override |
Returns a path to an SVG version of the provider's icon. More... | |
![]() | |
QgsProcessingProvider (QObject *parent=nullptr) | |
Constructor for QgsProcessingProvider. More... | |
QgsProcessingProvider (const QgsProcessingProvider &other)=delete | |
Providers cannot be copied. More... | |
~QgsProcessingProvider () override | |
const QgsProcessingAlgorithm * | algorithm (const QString &name) const |
Returns the matching algorithm by name, or a nullptr if no matching algorithm is contained by this provider. More... | |
QList< const QgsProcessingAlgorithm *> | algorithms () const |
Returns a list of algorithms supplied by this provider. More... | |
virtual bool | canBeActivated () const |
Returns true if the provider can be activated, or false if it cannot be activated (e.g. More... | |
virtual QString | defaultRasterFileExtension () const |
Returns the default file extension to use for raster outputs created by the provider. More... | |
virtual QString | defaultVectorFileExtension (bool hasGeometry=true) const |
Returns the default file extension to use for vector outputs created by the provider. More... | |
virtual bool | isActive () const |
Returns true if the provider is active and able to run algorithms. More... | |
virtual bool | load () |
Loads the provider. More... | |
virtual QString | longName () const |
Returns the a longer version of the provider name, which can include extra details such as version numbers. More... | |
QgsProcessingProvider & | operator= (const QgsProcessingProvider &other)=delete |
Providers cannot be copied. More... | |
void | refreshAlgorithms () |
Refreshes the algorithms available from the provider, causing it to re-populate with all associated algorithms. More... | |
virtual QStringList | supportedOutputRasterLayerExtensions () const |
Returns a list of the raster format file extensions supported by this provider. More... | |
virtual QStringList | supportedOutputVectorLayerExtensions () const |
Returns a list of the vector format file extensions supported by this provider. More... | |
virtual void | unload () |
Unloads the provider. More... | |
Protected Member Functions | |
void | loadAlgorithms () override |
Loads all algorithms belonging to this provider. More... | |
![]() | |
bool | addAlgorithm (QgsProcessingAlgorithm *algorithm) |
Adds an algorithm to the provider. More... | |
Additional Inherited Members | |
![]() | |
void | algorithmsLoaded () |
Emitted when the provider has loaded (or refreshed) its list of available algorithms. More... | |
Native c++ processing algorithm provider.
Definition at line 31 of file qgsnativealgorithms.h.
QgsNativeAlgorithms::QgsNativeAlgorithms | ( | QObject * | parent = nullptr | ) |
Constructor for QgsNativeAlgorithms.
|
overridevirtual |
Returns the provider help id string, used for creating QgsHelp urls for algorithms belong to this provider.
By default, this returns the provider's id(). This string should not be localised.
Reimplemented from QgsProcessingProvider.
|
overridevirtual |
|
overridevirtual |
Returns the unique provider id, used for identifying the provider.
This string should be a unique, short, character only string, eg "qgis" or "gdal". This string should not be localised.
Implements QgsProcessingProvider.
|
overrideprotectedvirtual |
Loads all algorithms belonging to this provider.
Subclasses should implement this, calling addAlgorithm() to register all their associated algorithms.
Implements QgsProcessingProvider.
|
overridevirtual |
Returns the provider name, which is used to describe the provider within the GUI.
This string should be short (e.g. "Lastools") and localised.
Implements QgsProcessingProvider.
|
overridevirtual |
Returns true if the provider supports non-file based outputs (such as memory layers or direct database outputs).
If a provider returns false for this method than it indicates that none of the outputs from any of the provider's algorithms have support for non-file based outputs. Returning true indicates that the algorithm's parameters will each individually declare their non-file based support.
The default behavior for providers is to support non-file based outputs, and most providers which rely solely on QGIS API (and which do not depend on third-party scripts or external dependencies) will automatically support this.
Reimplemented from QgsProcessingProvider.
|
overridevirtual |
Returns a path to an SVG version of the provider's icon.
Reimplemented from QgsProcessingProvider.