QGIS/python/core/auto_generated/qgsfeaturerequest.sip.in

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





class QgsFeatureRequest
{
%Docstring
This class wraps a request for features to a vector layer (or directly its vector data provider).
The request may apply a filter to fetch only a particular subset of features. Currently supported filters:

- no filter - all features are returned
- feature id - only feature that matches given feature id is returned
- feature ids - only features that match any of the given feature ids are returned
- filter expression - only features that match the given filter expression are returned

Additionally a spatial rectangle can be set in combination:
Only features that intersect given rectangle should be fetched. For the sake of speed,
the intersection is often done only using feature's bounding box. There is a flag
ExactIntersect that makes sure that only intersecting features will be returned.

For efficiency, it is also possible to tell provider that some data is not required:

- NoGeometry flag
- SubsetOfAttributes flag
- SimplifyMethod for geometries to fetch

The options may be chained, e.g.:

.. code-block:: python

       QgsFeatureRequest().setFilterRect(QgsRectangle(0,0,1,1)).setFlags(QgsFeatureRequest.ExactIntersect)

Examples:

.. code-block:: python

       # fetch all features:
       QgsFeatureRequest()
       # fetch all features, only one attribute
       QgsFeatureRequest().setSubsetOfAttributes(['myfield'], layer.fields())
       # fetch all features, without geometries
       QgsFeatureRequest().setFlags(QgsFeatureRequest.NoGeometry)
       # fetch only features from particular extent
       QgsFeatureRequest().setFilterRect(QgsRectangle(0,0,1,1))
       # fetch only one feature
       QgsFeatureRequest().setFilterFid(45)
%End

%TypeHeaderCode
#include "qgsfeaturerequest.h"
%End
  public:
    enum Flag
    {
      NoFlags,
      NoGeometry,
      SubsetOfAttributes,
      ExactIntersect
    };
    typedef QFlags<QgsFeatureRequest::Flag> Flags;


    enum FilterType
    {
      FilterNone,
      FilterFid,
      FilterExpression,
      FilterFids
    };

    enum InvalidGeometryCheck
    {
      GeometryNoCheck,
      GeometrySkipInvalid,
      GeometryAbortOnInvalid,
    };

    class OrderByClause
{
%Docstring
The OrderByClause class represents an order by clause for a QgsFeatureRequest.

It can be a simple field or an expression. Multiple order by clauses can be added to
a QgsFeatureRequest to fine tune the behavior if a single field or expression is not
enough to completely specify the required behavior.

If expression compilation is activated in the settings and the expression can be
translated for the provider in question, it will be evaluated on provider side.
If one of these two premises does not apply, the ordering will take place locally
which results in increased memory and CPU usage.

If the ordering is done on strings, the order depends on the system's locale if the
local fallback implementation is used. The order depends on the server system's locale
and implementation if ordering is done on the server.

In case the fallback code needs to be used, a limit set on the request will be respected
for the features returned by the iterator but internally all features will be requested
from the provider.

.. versionadded:: 2.14
%End

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

        OrderByClause( const QString &expression, bool ascending = true );
%Docstring
Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`

:param expression: The expression to use for ordering
:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
                  If the order is ascending, by default nulls are last
                  If the order is descending, by default nulls are first
%End

        OrderByClause( const QString &expression, bool ascending, bool nullsfirst );
%Docstring
Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`

:param expression: The expression to use for ordering
:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
:param nullsfirst: If ``True``, NULLS are at the beginning, if ``False``, NULLS are at the end
%End

        OrderByClause( const QgsExpression &expression, bool ascending = true );
%Docstring
Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`

:param expression: The expression to use for ordering
:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
                  If the order is ascending, by default nulls are last
                  If the order is descending, by default nulls are first
%End

        OrderByClause( const QgsExpression &expression, bool ascending, bool nullsfirst );
%Docstring
Creates a new OrderByClause for a :py:class:`QgsFeatureRequest`

:param expression: The expression to use for ordering
:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
:param nullsfirst: If ``True``, NULLS are at the beginning, if ``False``, NULLS are at the end
%End

        QgsExpression expression() const;
%Docstring
The expression

:return: the expression
%End

        bool prepare( QgsExpressionContext *context );
%Docstring
Prepare the expression with the given context.

.. seealso:: :py:func:`QgsExpression.prepare`

.. versionadded:: 3.0
%End

        bool ascending() const;
%Docstring
Order ascending

:return: If ascending order is requested
%End

        void setAscending( bool ascending );
%Docstring
Set if ascending order is requested
%End

        bool nullsFirst() const;
%Docstring
Set if NULLS should be returned first

:return: if NULLS should be returned first
%End

        void setNullsFirst( bool nullsFirst );
%Docstring
Set if NULLS should be returned first
%End

        QString dump() const;
%Docstring
Dumps the content to an SQL equivalent
%End


    };


    class OrderBy
{
%Docstring
Represents a list of OrderByClauses, with the most important first and the least
important last.

.. versionadded:: 2.14
%End

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

        OrderBy();
%Docstring
Create a new empty order by
%End

        OrderBy( const QList<QgsFeatureRequest::OrderByClause> &other );
%Docstring
Create a new order by from a list of clauses
%End

        QList<QgsFeatureRequest::OrderByClause> list() const;
%Docstring
Gets a copy as a list of OrderByClauses

This is only required in Python where the inheritance
is not properly propagated and this makes it usable.
%End

        void save( QDomElement &elem ) const;
%Docstring
Serialize to XML
%End

        void load( const QDomElement &elem );
%Docstring
Deserialize from XML
%End

        QSet<QString> usedAttributes() const;
%Docstring
Returns a set of used attributes

.. note::

   The returned attributes names are NOT guaranteed to be valid.
%End

        QSet<int> usedAttributeIndices( const QgsFields &fields ) const;
%Docstring
Returns a set of used, validated attribute indices

.. versionadded:: 3.8
%End

        QString dump() const;
%Docstring
Dumps the content to an SQL equivalent syntax
%End
    };

    static const QString ALL_ATTRIBUTES;

    QgsFeatureRequest();
%Docstring
construct a default request: for all features get attributes and geometries
%End
    explicit QgsFeatureRequest( QgsFeatureId fid );
%Docstring
construct a request with feature ID filter
%End
    explicit QgsFeatureRequest( const QgsFeatureIds &fids );
%Docstring
construct a request with feature ID filter
%End

    explicit QgsFeatureRequest( const QgsRectangle &rectangle );
%Docstring
Construct a request with ``rectangle`` bounding box filter.

When a destination CRS is set using :py:func:`~QgsFeatureRequest.setDestinationCrs`, ``rectangle``
is expected to be in the same CRS as the :py:func:`~QgsFeatureRequest.destinationCrs`. Otherwise, ``rectangle``
should use the same CRS as the source layer/provider.
%End

    explicit QgsFeatureRequest( const QgsExpression &expr, const QgsExpressionContext &context = QgsExpressionContext() );
%Docstring
construct a request with a filter expression
%End
    QgsFeatureRequest( const QgsFeatureRequest &rh );
%Docstring
copy constructor
%End

    FilterType filterType() const;
%Docstring
Returns the filter type which is currently set on this request

:return: Filter type
%End

    QgsFeatureRequest &setFilterRect( const QgsRectangle &rectangle );
%Docstring
Sets the ``rectangle`` from which features will be taken. An empty rectangle removes the filter.

When a destination CRS is set using :py:func:`~QgsFeatureRequest.setDestinationCrs`, ``rectangle``
is expected to be in the same CRS as the :py:func:`~QgsFeatureRequest.destinationCrs`. Otherwise, ``rectangle``
should use the same CRS as the source layer/provider.

.. seealso:: :py:func:`filterRect`
%End

    const QgsRectangle &filterRect() const;
%Docstring
Returns the rectangle from which features will be taken. If the returned
rectangle is null, then no filter rectangle is set.

When a destination CRS is set using :py:func:`~QgsFeatureRequest.setDestinationCrs`, the rectangle
will be in the same CRS as the :py:func:`~QgsFeatureRequest.destinationCrs`. Otherwise, the rectangle
will use the same CRS as the source layer/provider.

.. seealso:: :py:func:`setFilterRect`
%End

    QgsFeatureRequest &setFilterFid( QgsFeatureId fid );
%Docstring
Sets feature ID that should be fetched.
%End
    QgsFeatureId filterFid() const;
%Docstring
Gets the feature ID that should be fetched.
%End

    QgsFeatureRequest &setFilterFids( const QgsFeatureIds &fids );
%Docstring
Sets feature IDs that should be fetched.
%End
    const QgsFeatureIds &filterFids() const;
%Docstring
Gets feature IDs that should be fetched.
%End

    QgsFeatureRequest &setInvalidGeometryCheck( InvalidGeometryCheck check );
%Docstring
Sets invalid geometry checking behavior.

.. note::

   Invalid geometry checking is not performed when retrieving features
   directly from a :py:class:`QgsVectorDataProvider`.

.. seealso:: :py:func:`invalidGeometryCheck`

.. versionadded:: 3.0
%End

    InvalidGeometryCheck invalidGeometryCheck() const;
%Docstring
Returns the invalid geometry checking behavior.

.. seealso:: :py:func:`setInvalidGeometryCheck`

.. versionadded:: 3.0
%End

    QgsFeatureRequest &setInvalidGeometryCallback( SIP_PYCALLABLE / AllowNone / );
%Docstring
Sets a callback function to use when encountering an invalid geometry and
:py:func:`~QgsFeatureRequest.invalidGeometryCheck` is set to GeometryAbortOnInvalid or GeometrySkipInvalid. This function will be
called using the feature with invalid geometry as a parameter.

.. seealso:: :py:func:`invalidGeometryCallback`

.. versionadded:: 3.0
%End
%MethodCode
    Py_BEGIN_ALLOW_THREADS

    sipCpp->setInvalidGeometryCallback( [a0]( const QgsFeature &arg )
    {
      SIP_BLOCK_THREADS
      Py_XDECREF( sipCallMethod( NULL, a0, "D", &arg, sipType_QgsFeature, NULL ) );
      SIP_UNBLOCK_THREADS
    } );

    sipRes = sipCpp;

    Py_END_ALLOW_THREADS
%End


    QgsFeatureRequest &setFilterExpression( const QString &expression );
%Docstring
Set the filter expression. {:py:class:`QgsExpression`}

:param expression: expression string

.. seealso:: :py:func:`filterExpression`

.. seealso:: :py:func:`setExpressionContext`
%End

    QgsExpression *filterExpression() const;
%Docstring
Returns the filter expression if set.

.. seealso:: :py:func:`setFilterExpression`

.. seealso:: :py:func:`expressionContext`
%End

    QgsFeatureRequest &combineFilterExpression( const QString &expression );
%Docstring
Modifies the existing filter expression to add an additional expression filter. The
filter expressions are combined using AND, so only features matching both
the existing expression and the additional expression will be returned.

.. versionadded:: 2.14
%End

    QgsExpressionContext *expressionContext();
%Docstring
Returns the expression context used to evaluate filter expressions.

.. seealso:: :py:func:`setExpressionContext`

.. seealso:: :py:func:`filterExpression`

.. versionadded:: 2.12
%End

    QgsFeatureRequest &setExpressionContext( const QgsExpressionContext &context );
%Docstring
Sets the expression context used to evaluate filter expressions.

.. seealso:: :py:func:`expressionContext`

.. seealso:: :py:func:`setFilterExpression`

.. versionadded:: 2.12
%End

    QgsFeatureRequest &disableFilter();
%Docstring
Disables filter conditions.
The spatial filter (filterRect) will be kept in place.

:return: The object the method is called on for chaining

.. versionadded:: 2.12
%End


    QgsFeatureRequest &addOrderBy( const QString &expression, bool ascending = true );
%Docstring
Adds a new OrderByClause, appending it as the least important one.

:param expression: The expression to use for ordering
:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
                  If the order is ascending, by default nulls are last
                  If the order is descending, by default nulls are first

.. versionadded:: 2.14
%End

    QgsFeatureRequest &addOrderBy( const QString &expression, bool ascending, bool nullsfirst );
%Docstring
Adds a new OrderByClause, appending it as the least important one.

:param expression: The expression to use for ordering
:param ascending: If the order should be ascending (1,2,3) or descending (3,2,1)
:param nullsfirst: If ``True``, NULLS are at the beginning, if ``False``, NULLS are at the end

.. versionadded:: 2.14
%End

    OrderBy orderBy() const;
%Docstring
Returns a list of order by clauses specified for this feature request.

.. versionadded:: 2.14
%End

    QgsFeatureRequest &setOrderBy( const OrderBy &orderBy );
%Docstring
Set a list of order by clauses.

.. versionadded:: 2.14
%End

    QgsFeatureRequest &setLimit( long limit );
%Docstring
Set the maximum number of features to request.

:param limit: maximum number of features, or -1 to request all features.

.. seealso:: :py:func:`limit`

.. versionadded:: 2.14
%End

    long limit() const;
%Docstring
Returns the maximum number of features to request, or -1 if no limit set.

.. seealso:: :py:func:`setLimit`

.. versionadded:: 2.14
%End

    QgsFeatureRequest &setFlags( QgsFeatureRequest::Flags flags );
%Docstring
Sets flags that affect how features will be fetched
%End
    const Flags &flags() const;

    QgsFeatureRequest &setSubsetOfAttributes( const QgsAttributeList &attrs );
%Docstring
Set a subset of attributes that will be fetched.

An empty attributes list indicates that no attributes will be fetched.
To revert a call to setSubsetOfAttributes and fetch all available attributes,
the SubsetOfAttributes flag should be removed from the request.
%End

    QgsFeatureRequest &setNoAttributes();
%Docstring
Set that no attributes will be fetched.
To revert a call to setNoAttributes and fetch all or some available attributes,
the SubsetOfAttributes flag should be removed from the request.

.. versionadded:: 3.4
%End

    QgsAttributeList subsetOfAttributes() const;
%Docstring
Returns the subset of attributes which at least need to be fetched

:return: A list of attributes to be fetched
%End

    QgsFeatureRequest &setSubsetOfAttributes( const QStringList &attrNames, const QgsFields &fields );
%Docstring
Sets a subset of attributes by names that will be fetched
%End

    QgsFeatureRequest &setSubsetOfAttributes( const QSet<QString> &attrNames, const QgsFields &fields );
%Docstring
Sets a subset of attributes by names that will be fetched
%End

    QgsFeatureRequest &setSimplifyMethod( const QgsSimplifyMethod &simplifyMethod );
%Docstring
Set a simplification method for geometries that will be fetched

.. versionadded:: 2.2
%End

    const QgsSimplifyMethod &simplifyMethod() const;
%Docstring
Gets simplification method for geometries that will be fetched

.. versionadded:: 2.2
%End

    QgsCoordinateReferenceSystem destinationCrs() const;
%Docstring
Returns the destination coordinate reference system for feature's geometries,
or an invalid QgsCoordinateReferenceSystem if no reprojection will be done
and all features will be left with their original geometry.

.. seealso:: :py:func:`setDestinationCrs`

.. seealso:: :py:func:`transformContext`

.. versionadded:: 3.0
%End

    QgsCoordinateTransformContext transformContext() const;
%Docstring
Returns the transform context, for use when a :py:func:`~QgsFeatureRequest.destinationCrs` has been set
and reprojection is required

.. seealso:: :py:func:`setDestinationCrs`

.. seealso:: :py:func:`destinationCrs`

.. versionadded:: 3.0
%End

    QgsFeatureRequest &setDestinationCrs( const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context );
%Docstring
Sets the destination ``crs`` for feature's geometries. If set, all
geometries will be reprojected from their original coordinate reference
system to this desired reference system. If ``crs`` is an invalid
QgsCoordinateReferenceSystem then no reprojection will be done
and all features will be left with their original geometry.

When a ``crs`` is set using :py:func:`~QgsFeatureRequest.setDestinationCrs`, then any :py:func:`~QgsFeatureRequest.filterRect`
set on the request is expected to be in the same CRS as the destination
CRS.

The feature geometry transformation to the destination CRS is performed
after all filter expressions are tested and any virtual fields are
calculated. Accordingly, any geometric expressions used in
:py:func:`~QgsFeatureRequest.filterExpression` will be performed in the original
source CRS. This ensures consistent results are returned regardless of the
destination CRS. Similarly, virtual field values will be calculated using the
original geometry in the source CRS, so these values are not affected by
any destination CRS transform present in the feature request.

.. seealso:: :py:func:`destinationCrs`

.. versionadded:: 3.0
%End

    QgsFeatureRequest &setTransformErrorCallback( SIP_PYCALLABLE / AllowNone / );
%Docstring
Sets a callback function to use when encountering a transform error when iterating
features and a :py:func:`~QgsFeatureRequest.destinationCrs` is set. This function will be
called using the feature which encountered the transform error as a parameter.

.. seealso:: :py:func:`transformErrorCallback`

.. seealso:: :py:func:`setDestinationCrs`

.. versionadded:: 3.0
%End
%MethodCode
    Py_BEGIN_ALLOW_THREADS

    sipCpp->setTransformErrorCallback( [a0]( const QgsFeature &arg )
    {
      SIP_BLOCK_THREADS
      Py_XDECREF( sipCallMethod( NULL, a0, "D", &arg, sipType_QgsFeature, NULL ) );
      SIP_UNBLOCK_THREADS
    } );

    sipRes = sipCpp;

    Py_END_ALLOW_THREADS
%End



    bool acceptFeature( const QgsFeature &feature );
%Docstring
Check if a feature is accepted by this requests filter

:param feature: The feature which will be tested

:return: ``True``, if the filter accepts the feature


.. versionadded:: 2.1
%End

 int connectionTimeout() const /Deprecated/;
%Docstring
Returns the timeout (in milliseconds) for how long we should wait for a connection if none is available from the pool
at this moment. A negative value (which is set by default) will wait forever.

.. note::

   Only works if the provider supports this option.

.. deprecated::
   Use timeout() instead.

.. versionadded:: 3.0
%End

 QgsFeatureRequest &setConnectionTimeout( int connectionTimeout ) /Deprecated/;
%Docstring
Sets the timeout (in milliseconds) for how long we should wait for a connection if none is available from the pool
at this moment. A negative value (which is set by default) will wait forever.

.. note::

   Only works if the provider supports this option.

.. deprecated::
   Use setTimeout() instead.

.. versionadded:: 3.0
%End

    int timeout() const;
%Docstring
Returns the timeout (in milliseconds) for the maximum time we should wait during feature requests before a
feature is returned. A negative value (which is set by default) will wait forever.

.. note::

   Only works if the provider supports this option.

.. versionadded:: 3.4
%End

    QgsFeatureRequest &setTimeout( int timeout );
%Docstring
Sets the ``timeout`` (in milliseconds) for the maximum time we should wait during feature requests before a
feature is returned. A negative value (which is set by default) will wait forever.

.. note::

   Only works if the provider supports this option.

.. versionadded:: 3.4
%End

    bool requestMayBeNested() const;
%Docstring
In case this request may be run nested within another already running
iteration on the same connection, set this to ``True``.

If this flag is ``True``, this request will be able to make use of "spare"
connections to avoid deadlocks.

For example, this should be set on requests that are issued from an
expression function.

.. versionadded:: 3.4
%End

    QgsFeatureRequest &setRequestMayBeNested( bool requestMayBeNested );
%Docstring
In case this request may be run nested within another already running
iteration on the same connection, set this to ``True``.

If this flag is ``True``, this request will be able to make use of "spare"
connections to avoid deadlocks.

For example, this should be set on requests that are issued from an
expression function.

.. versionadded:: 3.4
%End

  protected:
};

QFlags<QgsFeatureRequest::Flag> operator|(QgsFeatureRequest::Flag f1, QFlags<QgsFeatureRequest::Flag> f2);




class QgsAbstractFeatureSource
{
%Docstring
Base class that can be used for any class that is capable of returning features

.. versionadded:: 2.4
%End

%TypeHeaderCode
#include "qgsfeaturerequest.h"
%End
  public:
    virtual ~QgsAbstractFeatureSource();

    virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest &request = QgsFeatureRequest() ) = 0;
%Docstring
Gets an iterator for features matching the specified request

:param request: The request

:return: A feature iterator
%End

  protected:
    void iteratorOpened( QgsAbstractFeatureIterator *it );
    void iteratorClosed( QgsAbstractFeatureIterator *it );


};

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