File: qgsvectorlayerfeatureiterator.sip

package info (click to toggle)
qgis 2.18.28%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,007,948 kB
  • sloc: cpp: 671,774; python: 158,539; xml: 35,690; ansic: 8,346; sh: 1,766; perl: 1,669; sql: 999; yacc: 836; lex: 461; makefile: 292
file content (75 lines) | stat: -rw-r--r-- 2,668 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

// abstract feature iterator implementations are not part of public API


class QgsVectorLayerFeatureIterator : QgsAbstractFeatureIterator
{
%TypeHeaderCode
#include <qgsvectorlayerfeatureiterator.h>
%End
  public:
    ~QgsVectorLayerFeatureIterator();

    //! reset the iterator to the starting position
    virtual bool rewind();

    //! end of iterating: free the resources / lock
    virtual bool close();

  protected:
    //! fetch next feature, return true on success
    virtual bool fetchFeature( QgsFeature& feature );

    //! Overrides default method as we only need to filter features in the edit buffer
    //! while for others filtering is left to the provider implementation.
    virtual bool nextFeatureFilterExpression( QgsFeature &f );

    //! Setup the simplification of geometries to fetch using the specified simplify method
    virtual bool prepareSimplification( const QgsSimplifyMethod& simplifyMethod );

    //! @note not available in Python bindings
    //void rewindEditBuffer();
    //! @note not available in Python bindings
    //void prepareJoins();
    //! @note not available in Python bindings
    //void prepareExpressions();
    //! @note not available in Python bindings
    //bool fetchNextAddedFeature( QgsFeature& f );
    //! @note not available in Python bindings
    //bool fetchNextChangedGeomFeature( QgsFeature& f );
    //! @note not available in Python bindings
    //bool fetchNextChangedAttributeFeature( QgsFeature& f );
    //! @note not available in Python bindings
    //void useAddedFeature( const QgsFeature& src, QgsFeature& f );
    //! @note not available in Python bindings
    //void useChangedAttributeFeature( QgsFeatureId fid, const QgsGeometry& geom, QgsFeature& f );
    //! @note not available in Python bindings
    //bool nextFeatureFid( QgsFeature& f );
    //! @note not available in Python bindings
    //void addJoinedAttributes( QgsFeature &f );

    /**
     * Adds attributes that don't source from the provider but are added inside QGIS
     * Includes
     *  - Joined fields
     *  - Expression fields
     *
     * @param f The feature will be modified
     * @note not available in Python bindings
     */
    //void addVirtualAttributes( QgsFeature &f );

    /** Update feature with uncommited attribute updates.
     * @note not available in Python bindings
     */
    //void updateChangedAttributes( QgsFeature& f );

    /** Update feature with uncommited geometry updates.
     * @note not available in Python bindings
     */
    //void updateFeatureGeometry( QgsFeature& f );

  private:
    QgsVectorLayerFeatureIterator( const QgsVectorLayerFeatureIterator &rhs );

};