File: qgscachedfeatureiterator.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (131 lines) | stat: -rw-r--r-- 3,462 bytes parent folder | download | duplicates (12)
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgscachedfeatureiterator.h                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsCachedFeatureIterator : QgsAbstractFeatureIterator
{
%Docstring(signature="appended")
Delivers features from the cache
%End

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

    QgsCachedFeatureIterator( QgsVectorLayerCache *vlCache, const QgsFeatureRequest &featureRequest );
%Docstring
This constructor creates a feature iterator, that delivers all cached
features. No request is made to the backend.

:param vlCache: The vector layer cache to use
:param featureRequest: The feature request to answer
%End

    ~QgsCachedFeatureIterator();

    virtual bool rewind();

%Docstring
Rewind to the beginning of the iterator

:return: bool ``True`` if the operation was OK
%End

    virtual bool close();

%Docstring
Close this iterator. No further features will be available.

:return: ``True`` if successful
%End

  protected:

    virtual bool fetchFeature( QgsFeature &f );

%Docstring
Implementation for fetching a feature.

:param f: Will write to this feature

:return: bool ``True`` if the operation was OK
%End

    virtual bool nextFeatureFilterFids( QgsFeature &f );
%Docstring
We have a local special iterator for FilterFids, no need to run the
generic.

:param f: Will write to this feature

:return: bool ``True`` if the operation was OK
%End

  private:
    QgsCachedFeatureIterator( const QgsCachedFeatureIterator &other );
};

class QgsCachedFeatureWriterIterator : QgsAbstractFeatureIterator
{
%Docstring(signature="appended")
Uses another iterator as backend and writes features to the cache
%End

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

    QgsCachedFeatureWriterIterator( QgsVectorLayerCache *vlCache, const QgsFeatureRequest &featureRequest );
%Docstring
This constructor creates a feature iterator, which queries the backend
and caches retrieved features.

:param vlCache: The vector layer cache to use
:param featureRequest: The feature request to answer
%End

    virtual bool rewind();

%Docstring
Rewind to the beginning of the iterator

:return: bool ``True`` if the operation was OK
%End

    virtual bool close();

%Docstring
Close this iterator. No further features will be available.

:return: ``True`` if successful
%End

  protected:

    virtual bool fetchFeature( QgsFeature &f );

%Docstring
Implementation for fetching a feature.

:param f: Will write to this feature

:return: bool ``True`` if the operation was OK
%End

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