QGIS/python/core/qgsfeatureiterator.sip

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



class QgsAbstractFeatureIterator
{
%Docstring
 Internal feature iterator to be implemented within data providers
%End

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

    enum CompileStatus
    {
      NoCompilation,
      PartiallyCompiled,
      Compiled,
    };

    QgsAbstractFeatureIterator( const QgsFeatureRequest &request );
%Docstring
base class constructor - stores the iteration parameters
%End

    virtual ~QgsAbstractFeatureIterator();
%Docstring
destructor makes sure that the iterator is closed properly
%End

    virtual bool nextFeature( QgsFeature &f );
%Docstring
fetch next feature, return true on success
 :rtype: bool
%End

    virtual bool rewind() = 0;
%Docstring
reset the iterator to the starting position
 :rtype: bool
%End
    virtual bool close() = 0;
%Docstring
end of iterating: free the resources / lock
 :rtype: bool
%End


    CompileStatus compileStatus() const;
%Docstring
 Returns the status of expression compilation for filter expression requests.
.. versionadded:: 2.16
 :rtype: CompileStatus
%End

  protected:

    virtual bool fetchFeature( QgsFeature &f ) = 0;
%Docstring
 If you write a feature iterator for your provider, this is the method you
 need to implement!!

 \param f The feature to write to
 :return:  true if a feature was written to f
 :rtype: bool
%End

    virtual bool nextFeatureFilterExpression( QgsFeature &f );
%Docstring
 By default, the iterator will fetch all features and check if the feature
 matches the expression.
 If you have a more sophisticated metodology (SQL request for the features...)
 and you check for the expression in your fetchFeature method, you can just
 redirect this call to fetchFeature so the default check will be omitted.

 \param f The feature to write to
 :return:  true if a feature was written to f
 :rtype: bool
%End

    virtual bool nextFeatureFilterFids( QgsFeature &f );
%Docstring
 By default, the iterator will fetch all features and check if the id
 is in the request.
 If you have a more sophisticated metodology (SQL request for the features...)
 and you are sure, that any feature you return from fetchFeature will match
 if the request was FilterFids you can just redirect this call to fetchFeature
 so the default check will be omitted.

 \param f The feature to write to
 :return:  true if a feature was written to f
 :rtype: bool
%End




    void ref();
%Docstring
Add reference
%End
    void deref();
%Docstring
Remove reference, delete if refs == 0
%End



    virtual bool prepareSimplification( const QgsSimplifyMethod &simplifyMethod );
%Docstring
Setup the simplification of geometries to fetch using the specified simplify method
 :rtype: bool
%End

};


class QgsFeatureIterator
{
%Docstring
 Wrapper for iterator of features from vector data provider or vector layer
%End

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

    QgsFeatureIterator *__iter__();
%Docstring
 :rtype: QgsFeatureIterator
%End
%MethodCode
    sipRes = sipCpp;
%End

    SIP_PYOBJECT __next__();
%MethodCode
    QgsFeature *f = new QgsFeature;
    if ( sipCpp->nextFeature( *f ) )
      sipRes = sipConvertFromType( f, sipType_QgsFeature, Py_None );
    else
    {
      delete f;
      PyErr_SetString( PyExc_StopIteration, "" );
    }
%End

    QgsFeatureIterator();
%Docstring
construct invalid iterator
%End
    QgsFeatureIterator( const QgsFeatureIterator &fi );
%Docstring
copy constructor copies the iterator, increases ref.count
%End
    ~QgsFeatureIterator();
%Docstring
destructor deletes the iterator if it has no more references
%End


    bool nextFeature( QgsFeature &f );
%Docstring
 :rtype: bool
%End
    bool rewind();
%Docstring
 :rtype: bool
%End
    bool close();
%Docstring
 :rtype: bool
%End

    bool isClosed() const;
%Docstring
find out whether the iterator is still valid or closed already
 :rtype: bool
%End


    QgsAbstractFeatureIterator::CompileStatus compileStatus() const;
%Docstring
 Returns the status of expression compilation for filter expression requests.
.. versionadded:: 2.16
 :rtype: QgsAbstractFeatureIterator.CompileStatus
%End


};


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