File: qgssinglegeometrycheck.sip.in

package info (click to toggle)
qgis 3.22.16%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 1,186,020 kB
  • sloc: cpp: 1,275,562; python: 194,091; xml: 15,597; perl: 3,471; sh: 3,368; sql: 2,485; ansic: 2,219; yacc: 1,056; lex: 574; javascript: 504; lisp: 411; makefile: 227
file content (163 lines) | stat: -rw-r--r-- 4,770 bytes parent folder | download | duplicates (5)
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/analysis/vector/geometry_checker/qgssinglegeometrycheck.h        *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/






class QgsSingleGeometryCheckError
{
%Docstring(signature="appended")

An error from a :py:class:`QgsSingleGeometryCheck`.

.. note::

   This class is a technology preview and unstable API.

.. versionadded:: 3.4
%End

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

    QgsSingleGeometryCheckError( const QgsSingleGeometryCheck *check, const QgsGeometry &geometry, const QgsGeometry &errorLocation, const QgsVertexId &vertexId = QgsVertexId() );
%Docstring
Creates a new single geometry check error.
%End

    virtual ~QgsSingleGeometryCheckError();

    virtual void update( const QgsSingleGeometryCheckError *other );
%Docstring
Update this error with the information from ``other``.
Will be used to update existing errors whenever they are re-checked.
%End

    virtual bool isEqual( const QgsSingleGeometryCheckError *other ) const;
%Docstring
Check if this error is equal to ``other``.
Is reimplemented by subclasses with additional information, comparison
of base information is done in parent class.
%End


    virtual QString description() const;
%Docstring
A human readable description of this error.
%End

    const QgsSingleGeometryCheck *check() const;
%Docstring
The check that created this error.

.. versionadded:: 3.4
%End

    QgsGeometry errorLocation() const;
%Docstring
The exact location of the error.

.. versionadded:: 3.4
%End

    QgsVertexId vertexId() const;
%Docstring
The vertex id of the error. May be invalid depending on the check.

.. versionadded:: 3.4
%End

  protected:
};

class QgsGeometryCheckErrorSingle : QgsGeometryCheckError
{
%Docstring(signature="appended")

Wraps a :py:class:`QgsSingleGeometryError` into a standard :py:class:`QgsGeometryCheckError`.
The single error can be obtained via singleError.

.. note::

   This class is a technology preview and unstable API.

.. versionadded:: 3.4
%End

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

    QgsGeometryCheckErrorSingle( QgsSingleGeometryCheckError *singleError, const QgsGeometryCheckerUtils::LayerFeature &layerFeature );
%Docstring
Creates a new error for a :py:class:`QgsSingleGeometryCheck`.
%End

    QgsSingleGeometryCheckError *singleError() const;
%Docstring
The underlying single error.
%End


  private:
    const QgsGeometryCheckErrorSingle &operator=( const QgsGeometryCheckErrorSingle & );
};

class QgsSingleGeometryCheck : QgsGeometryCheck
{
%Docstring(signature="appended")

Base class for geometry checks for a single geometry without any context of the layer or other layers in the project.
Classic examples are validity checks like self-intersection.

Subclasses need to implement the processGeometry method.

.. versionadded:: 3.4
%End

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

    QgsSingleGeometryCheck( const QgsGeometryCheckContext *context,
                            const QVariantMap &configuration );
%Docstring
Creates a new single geometry check.
%End

     virtual void collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools,
                        QList<QgsGeometryCheckError *> &errors,
                        QStringList &messages,
                        QgsFeedback *feedback = 0,
                        const QgsGeometryCheck::LayerFeatureIds &ids = QgsGeometryCheck::LayerFeatureIds() ) const ${SIP_FINAL};

    virtual QList<QgsSingleGeometryCheckError *> processGeometry( const QgsGeometry &geometry ) const = 0;
%Docstring
Check the ``geometry`` for errors. It may make use of ``configuration`` options.

Returns a list of :py:class:`QgsSingleGeometryCheckErrors`, ownership is transferred to the caller.
An empty list is returned for geometries without errors.

.. versionadded:: 3.4
%End

};

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