/
qgsrasterrange.sip.in
120 lines (87 loc) · 2.98 KB
/
qgsrasterrange.sip.in
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
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsrasterrange.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
typedef QList<QgsRasterRange> QgsRasterRangeList;
class QgsRasterRange
{
%Docstring
Raster values range container. Represents range of values between min and max
including min and max value.
%End
%TypeHeaderCode
#include "qgsrasterrange.h"
%End
public:
enum BoundsType
{
IncludeMinAndMax,
IncludeMax,
IncludeMin,
Exclusive,
};
QgsRasterRange();
%Docstring
Default constructor, both min and max value for the range will be set to NaN.
%End
QgsRasterRange( double min, double max, BoundsType bounds = IncludeMinAndMax );
%Docstring
Constructor for a range with the given ``min`` and ``max`` values.
The ``bounds`` argument dictates how the min and max value themselves
will be handled by the range.
%End
double min() const;
%Docstring
Returns the minimum value for the range.
.. seealso:: :py:func:`setMin`
%End
double max() const;
%Docstring
Returns the maximum value for the range.
.. seealso:: :py:func:`setMax`
%End
BoundsType bounds() const;
%Docstring
Returns the bounds type for the range, which specifies
whether or not the min and max values themselves are included
in the range.
.. seealso:: :py:func:`setBounds`
.. versionadded:: 3.4
%End
double setMin( double min );
%Docstring
Sets the minimum value for the range.
.. seealso:: :py:func:`min`
%End
double setMax( double max );
%Docstring
Sets the maximum value for the range.
.. seealso:: :py:func:`max`
%End
void setBounds( BoundsType type );
%Docstring
Setss the bounds ``type`` for the range, which specifies
whether or not the min and max values themselves are included
in the range.
.. seealso:: :py:func:`bounds`
.. versionadded:: 3.4
%End
bool operator==( QgsRasterRange o ) const;
static bool contains( double value, const QgsRasterRangeList &rangeList );
%Docstring
Tests if a ``value`` is within the list of ranges
:param value: value
:param rangeList: list of ranges
:return: true if value is in at least one of ranges
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsrasterrange.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/