QGIS/python/core/processing/qgsprocessingutils.sip

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/processing/qgsprocessingutils.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/







class QgsProcessingUtils
{
%Docstring
 Utility functions for use with processing classes.
.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgsprocessingutils.h"
%End
  public:

    static QList< QgsRasterLayer * > compatibleRasterLayers( QgsProject *project, bool sort = true );
%Docstring
 Returns a list of raster layers from a ``project`` which are compatible with the processing
 framework.

 If the ``sort`` argument is true then the layers will be sorted by their QgsMapLayer.name()
 value.
 \see compatibleVectorLayers()
 \see compatibleLayers()
 :rtype: list of QgsRasterLayer
%End

    static QList< QgsVectorLayer * > compatibleVectorLayers( QgsProject *project,
        const QList< QgsWkbTypes::GeometryType > &geometryTypes = QList< QgsWkbTypes::GeometryType >(),
        bool sort = true );
%Docstring
 Returns a list of vector layers from a ``project`` which are compatible with the processing
 framework.

 If the ``geometryTypes`` list is non-empty then the layers will be sorted so that only
 layers with geometry types included in the list will be returned. Leaving the ``geometryTypes``
 list empty will cause all vector layers, regardless of their geometry type, to be returned.

 If the ``sort`` argument is true then the layers will be sorted by their QgsMapLayer.name()
 value.
 \see compatibleRasterLayers()
 \see compatibleLayers()
 :rtype: list of QgsVectorLayer
%End

    static QList< QgsMapLayer * > compatibleLayers( QgsProject *project, bool sort = true );
%Docstring
 Returns a list of map layers from a ``project`` which are compatible with the processing
 framework.

 If the ``sort`` argument is true then the layers will be sorted by their QgsMapLayer.name()
 value.
 \see compatibleRasterLayers()
 \see compatibleVectorLayers()
 :rtype: list of QgsMapLayer
%End


    static QgsMapLayer *mapLayerFromProject( const QString &string, QgsProject *project );
%Docstring
 Interprets a ``string`` as a map layer from a project.

 This method attempts to match a string to a project map layer, using
 first the layer ID, then layer names, and finally layer source.
 If the string matches a normalized version of any layer source
 for layers in the specified ``project``, then those matching layers will be
 returned.
 \see mapLayerFromString()
 :rtype: QgsMapLayer
%End

    static QgsMapLayer *mapLayerFromString( const QString &string ) /Factory/;
%Docstring
 Interprets a string as a map layer. The method will attempt to
 load a layer matching the passed ``string``. E.g. if the string is a file path,
 then the layer at this file path will be loaded.
 The caller takes responsibility for deleting the returned map layer.
 \see mapLayerFromProject()
 :rtype: QgsMapLayer
%End

    static QString normalizeLayerSource( const QString &source );
%Docstring
 Normalizes a layer ``source`` string for safe comparison across different
 operating system environments.
 :rtype: str
%End

};



/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/processing/qgsprocessingutils.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/