← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/qwt/oneiric-proposed

« back to all changes in this revision

Viewing changes to doc/man/man3/QwtInterval.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2011-06-10 11:22:47 UTC
  • mfrom: (1.1.6 upstream) (2.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20110610112247-0i1019vvmzaq6p86
Tags: 6.0.0-1
http://bugs.debian.org/624107
http://bugs.debian.org/604379
http://bugs.debian.org/626868
http://bugs.debian.org/626567
* New upstream release (Closes: #624107):
  - drop Qt3 support. (Closes: #604379, #626868)
* Register documentation with doc-base. (Closes: #626567)
* Drop patches:
  - 01_makefiles.diff
  - 02_add_missing_warnings.diff
  - 03_qwt_branch_pull_r544.diff
* Add qwt_install_paths.patch to fix the hardcoded installation paths.
* Update debian/control:
  - drop libqt3-mt-dev build dependency.
  - bump Standards-Version to 3.9.2 (no changes).
  - drop Qt3 related packages.
  - due to bump soname (and as we dropper Qt3 support):
    - libqwt5-qt4-dev -> libqwt-dev
    - libqwt5-qt4 -> libqwt6
    - libqwt5-doc -> libqwt-doc
* Update debian/copyright file.
* Update debian/rules: drop Qt3 packages support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man3/QwtInterval.3
 
1
.TH "QwtInterval" 3 "Fri Apr 15 2011" "Version 6.0.0" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtInterval \- 
 
6
.PP
 
7
A class representing an interval.  
 
8
 
 
9
.SH SYNOPSIS
 
10
.br
 
11
.PP
 
12
.PP
 
13
\fC#include <qwt_interval.h>\fP
 
14
.SS "Public Types"
 
15
 
 
16
.in +1c
 
17
.ti -1c
 
18
.RI "enum \fBBorderFlag\fP { \fBIncludeBorders\fP =  0x00, \fBExcludeMinimum\fP =  0x01, \fBExcludeMaximum\fP =  0x02, \fBExcludeBorders\fP =  ExcludeMinimum | ExcludeMaximum }"
 
19
.br
 
20
.ti -1c
 
21
.RI "typedef QFlags< \fBBorderFlag\fP > \fBBorderFlags\fP"
 
22
.br
 
23
.in -1c
 
24
.SS "Public Member Functions"
 
25
 
 
26
.in +1c
 
27
.ti -1c
 
28
.RI "\fBQwtInterval\fP ()"
 
29
.br
 
30
.ti -1c
 
31
.RI "\fBQwtInterval\fP (double minValue, double maxValue, \fBBorderFlags\fP=IncludeBorders)"
 
32
.br
 
33
.ti -1c
 
34
.RI "void \fBsetInterval\fP (double minValue, double maxValue, \fBBorderFlags\fP=IncludeBorders)"
 
35
.br
 
36
.ti -1c
 
37
.RI "\fBQwtInterval\fP \fBnormalized\fP () const "
 
38
.br
 
39
.ti -1c
 
40
.RI "\fBQwtInterval\fP \fBinverted\fP () const "
 
41
.br
 
42
.ti -1c
 
43
.RI "\fBQwtInterval\fP \fBlimited\fP (double minValue, double maxValue) const "
 
44
.br
 
45
.ti -1c
 
46
.RI "bool \fBoperator==\fP (const \fBQwtInterval\fP &) const "
 
47
.br
 
48
.ti -1c
 
49
.RI "bool \fBoperator!=\fP (const \fBQwtInterval\fP &) const "
 
50
.br
 
51
.ti -1c
 
52
.RI "void \fBsetBorderFlags\fP (\fBBorderFlags\fP)"
 
53
.br
 
54
.ti -1c
 
55
.RI "\fBBorderFlags\fP \fBborderFlags\fP () const "
 
56
.br
 
57
.ti -1c
 
58
.RI "double \fBminValue\fP () const "
 
59
.br
 
60
.ti -1c
 
61
.RI "double \fBmaxValue\fP () const "
 
62
.br
 
63
.ti -1c
 
64
.RI "double \fBwidth\fP () const "
 
65
.br
 
66
.ti -1c
 
67
.RI "void \fBsetMinValue\fP (double)"
 
68
.br
 
69
.ti -1c
 
70
.RI "void \fBsetMaxValue\fP (double)"
 
71
.br
 
72
.ti -1c
 
73
.RI "bool \fBcontains\fP (double value) const "
 
74
.br
 
75
.ti -1c
 
76
.RI "bool \fBintersects\fP (const \fBQwtInterval\fP &) const "
 
77
.br
 
78
.ti -1c
 
79
.RI "\fBQwtInterval\fP \fBintersect\fP (const \fBQwtInterval\fP &) const "
 
80
.br
 
81
.ti -1c
 
82
.RI "\fBQwtInterval\fP \fBunite\fP (const \fBQwtInterval\fP &) const "
 
83
.br
 
84
.ti -1c
 
85
.RI "\fBQwtInterval\fP \fBoperator|\fP (const \fBQwtInterval\fP &) const "
 
86
.br
 
87
.ti -1c
 
88
.RI "\fBQwtInterval\fP \fBoperator&\fP (const \fBQwtInterval\fP &) const "
 
89
.br
 
90
.ti -1c
 
91
.RI "\fBQwtInterval\fP & \fBoperator|=\fP (const \fBQwtInterval\fP &)"
 
92
.br
 
93
.ti -1c
 
94
.RI "\fBQwtInterval\fP & \fBoperator&=\fP (const \fBQwtInterval\fP &)"
 
95
.br
 
96
.ti -1c
 
97
.RI "\fBQwtInterval\fP \fBextend\fP (double value) const "
 
98
.br
 
99
.ti -1c
 
100
.RI "\fBQwtInterval\fP \fBoperator|\fP (double) const "
 
101
.br
 
102
.ti -1c
 
103
.RI "\fBQwtInterval\fP & \fBoperator|=\fP (double)"
 
104
.br
 
105
.ti -1c
 
106
.RI "bool \fBisValid\fP () const "
 
107
.br
 
108
.ti -1c
 
109
.RI "bool \fBisNull\fP () const "
 
110
.br
 
111
.ti -1c
 
112
.RI "void \fBinvalidate\fP ()"
 
113
.br
 
114
.ti -1c
 
115
.RI "\fBQwtInterval\fP \fBsymmetrize\fP (double value) const "
 
116
.br
 
117
.in -1c
 
118
.SH "Detailed Description"
 
119
.PP 
 
120
A class representing an interval. 
 
121
 
 
122
The interval is represented by 2 doubles, the lower and the upper limit. 
 
123
.SH "Member Typedef Documentation"
 
124
.PP 
 
125
.SS "typedef QFlags<\fBBorderFlag\fP> \fBQwtInterval::BorderFlags\fP"
 
126
.PP
 
127
Border flags. 
 
128
.SH "Member Enumeration Documentation"
 
129
.PP 
 
130
.SS "enum \fBQwtInterval::BorderFlag\fP"Flag indicating if a border is included or excluded 
 
131
.PP
 
132
\fBSee also:\fP
 
133
.RS 4
 
134
\fBsetBorderFlags()\fP, \fBborderFlags()\fP 
 
135
.RE
 
136
.PP
 
137
 
 
138
.PP
 
139
\fBEnumerator: \fP
 
140
.in +1c
 
141
.TP
 
142
\fB\fIIncludeBorders \fP\fP
 
143
Min/Max values are inside the interval. 
 
144
.TP
 
145
\fB\fIExcludeMinimum \fP\fP
 
146
Min value is not included in the interval. 
 
147
.TP
 
148
\fB\fIExcludeMaximum \fP\fP
 
149
Max value is not included in the interval. 
 
150
.TP
 
151
\fB\fIExcludeBorders \fP\fP
 
152
Min/Max values are not included in the interval. 
 
153
.SH "Constructor & Destructor Documentation"
 
154
.PP 
 
155
.SS "QwtInterval::QwtInterval ()\fC [inline]\fP"
 
156
.PP
 
157
Default Constructor. Creates an invalid interval [0.0, -1.0] 
 
158
.PP
 
159
\fBSee also:\fP
 
160
.RS 4
 
161
\fBsetInterval()\fP, \fBisValid()\fP 
 
162
.RE
 
163
.PP
 
164
 
 
165
.SS "QwtInterval::QwtInterval (doubleminValue, doublemaxValue, \fBBorderFlags\fPborderFlags = \fCIncludeBorders\fP)\fC [inline]\fP"Constructor
 
166
.PP
 
167
Build an interval with from min/max values
 
168
.PP
 
169
\fBParameters:\fP
 
170
.RS 4
 
171
\fIminValue\fP Minimum value 
 
172
.br
 
173
\fImaxValue\fP Maximum value 
 
174
.br
 
175
\fIborderFlags\fP Include/Exclude borders 
 
176
.RE
 
177
.PP
 
178
 
 
179
.SH "Member Function Documentation"
 
180
.PP 
 
181
.SS "\fBQwtInterval::BorderFlags\fP QwtInterval::borderFlags () const\fC [inline]\fP"\fBReturns:\fP
 
182
.RS 4
 
183
Border flags 
 
184
.RE
 
185
.PP
 
186
\fBSee also:\fP
 
187
.RS 4
 
188
\fBsetBorderFlags()\fP 
 
189
.RE
 
190
.PP
 
191
 
 
192
.SS "bool QwtInterval::contains (doublevalue) const"Test if a value is inside an interval
 
193
.PP
 
194
\fBParameters:\fP
 
195
.RS 4
 
196
\fIvalue\fP Value 
 
197
.RE
 
198
.PP
 
199
\fBReturns:\fP
 
200
.RS 4
 
201
true, if value >= \fBminValue()\fP && value <= \fBmaxValue()\fP 
 
202
.RE
 
203
.PP
 
204
 
 
205
.SS "\fBQwtInterval\fP QwtInterval::extend (doublevalue) const"Extend the interval
 
206
.PP
 
207
If value is below minValue, value becomes the lower limit. If value is above maxValue, value becomes the upper limit.
 
208
.PP
 
209
extend has no effect for invalid intervals
 
210
.PP
 
211
\fBParameters:\fP
 
212
.RS 4
 
213
\fIvalue\fP Value 
 
214
.RE
 
215
.PP
 
216
\fBSee also:\fP
 
217
.RS 4
 
218
\fBisValid()\fP 
 
219
.RE
 
220
.PP
 
221
 
 
222
.SS "\fBQwtInterval\fP QwtInterval::intersect (const \fBQwtInterval\fP &other) const"
 
223
.PP
 
224
Intersect 2 intervals. 
 
225
.SS "bool QwtInterval::intersects (const \fBQwtInterval\fP &other) const"Test if two intervals overlap 
 
226
.SS "void QwtInterval::invalidate ()\fC [inline]\fP"Invalidate the interval
 
227
.PP
 
228
The limits are set to interval [0.0, -1.0] 
 
229
.PP
 
230
\fBSee also:\fP
 
231
.RS 4
 
232
\fBisValid()\fP 
 
233
.RE
 
234
.PP
 
235
 
 
236
.SS "\fBQwtInterval\fP QwtInterval::inverted () const"Invert the limits of the interval 
 
237
.PP
 
238
\fBReturns:\fP
 
239
.RS 4
 
240
Inverted interval 
 
241
.RE
 
242
.PP
 
243
\fBSee also:\fP
 
244
.RS 4
 
245
\fBnormalized()\fP 
 
246
.RE
 
247
.PP
 
248
 
 
249
.SS "bool QwtInterval::isNull () const\fC [inline]\fP"\fBReturns:\fP
 
250
.RS 4
 
251
true, if \fBisValid()\fP && (\fBminValue()\fP >= \fBmaxValue()\fP) 
 
252
.RE
 
253
.PP
 
254
 
 
255
.SS "bool QwtInterval::isValid () const\fC [inline]\fP"A interval is valid when \fBminValue()\fP <= \fBmaxValue()\fP. In case of \fBQwtInterval::ExcludeBorders\fP it is true when \fBminValue()\fP < \fBmaxValue()\fP 
 
256
.SS "\fBQwtInterval\fP QwtInterval::limited (doublelowerBound, doubleupperBound) const"Limit the interval, keeping the border modes
 
257
.PP
 
258
\fBParameters:\fP
 
259
.RS 4
 
260
\fIlowerBound\fP Lower limit 
 
261
.br
 
262
\fIupperBound\fP Upper limit
 
263
.RE
 
264
.PP
 
265
\fBReturns:\fP
 
266
.RS 4
 
267
Limited interval 
 
268
.RE
 
269
.PP
 
270
 
 
271
.SS "double QwtInterval::maxValue () const\fC [inline]\fP"\fBReturns:\fP
 
272
.RS 4
 
273
Upper limit of the interval 
 
274
.RE
 
275
.PP
 
276
 
 
277
.SS "double QwtInterval::minValue () const\fC [inline]\fP"\fBReturns:\fP
 
278
.RS 4
 
279
Lower limit of the interval 
 
280
.RE
 
281
.PP
 
282
 
 
283
.SS "\fBQwtInterval\fP QwtInterval::normalized () const"
 
284
.PP
 
285
Normalize the limits of the interval. If \fBmaxValue()\fP < \fBminValue()\fP the limits will be inverted. 
 
286
.PP
 
287
\fBReturns:\fP
 
288
.RS 4
 
289
Normalized interval
 
290
.RE
 
291
.PP
 
292
\fBSee also:\fP
 
293
.RS 4
 
294
\fBisValid()\fP, \fBinverted()\fP 
 
295
.RE
 
296
.PP
 
297
 
 
298
.SS "bool QwtInterval::operator!= (const \fBQwtInterval\fP &other) const\fC [inline]\fP"
 
299
.PP
 
300
Compare two intervals. 
 
301
.SS "\fBQwtInterval\fP QwtInterval::operator& (const \fBQwtInterval\fP &interval) const\fC [inline]\fP"Intersection of two intervals 
 
302
.PP
 
303
\fBSee also:\fP
 
304
.RS 4
 
305
\fBintersect()\fP 
 
306
.RE
 
307
.PP
 
308
 
 
309
.SS "\fBQwtInterval\fP & QwtInterval::operator&= (const \fBQwtInterval\fP &interval)"
 
310
.PP
 
311
Intersects this interval with the given interval. 
 
312
.SS "bool QwtInterval::operator== (const \fBQwtInterval\fP &other) const\fC [inline]\fP"
 
313
.PP
 
314
Compare two intervals. 
 
315
.SS "\fBQwtInterval\fP QwtInterval::operator| (const \fBQwtInterval\fP &interval) const\fC [inline]\fP"Union of two intervals 
 
316
.PP
 
317
\fBSee also:\fP
 
318
.RS 4
 
319
\fBunite()\fP 
 
320
.RE
 
321
.PP
 
322
 
 
323
.SS "\fBQwtInterval\fP QwtInterval::operator| (doublevalue) const\fC [inline]\fP"Extend an interval
 
324
.PP
 
325
\fBParameters:\fP
 
326
.RS 4
 
327
\fIvalue\fP Value 
 
328
.RE
 
329
.PP
 
330
\fBReturns:\fP
 
331
.RS 4
 
332
Extended interval 
 
333
.RE
 
334
.PP
 
335
\fBSee also:\fP
 
336
.RS 4
 
337
\fBextend()\fP 
 
338
.RE
 
339
.PP
 
340
 
 
341
.SS "\fBQwtInterval\fP & QwtInterval::operator|= (const \fBQwtInterval\fP &interval)"
 
342
.PP
 
343
Unites this interval with the given interval. 
 
344
.SS "\fBQwtInterval\fP & QwtInterval::operator|= (doublevalue)"Extend an interval
 
345
.PP
 
346
\fBParameters:\fP
 
347
.RS 4
 
348
\fIvalue\fP Value 
 
349
.RE
 
350
.PP
 
351
\fBReturns:\fP
 
352
.RS 4
 
353
Reference of the extended interval
 
354
.RE
 
355
.PP
 
356
\fBSee also:\fP
 
357
.RS 4
 
358
\fBextend()\fP 
 
359
.RE
 
360
.PP
 
361
 
 
362
.SS "void QwtInterval::setBorderFlags (\fBBorderFlags\fPborderFlags)\fC [inline]\fP"Change the border flags
 
363
.PP
 
364
\fBParameters:\fP
 
365
.RS 4
 
366
\fIborderFlags\fP Or'd BorderMode flags 
 
367
.RE
 
368
.PP
 
369
\fBSee also:\fP
 
370
.RS 4
 
371
\fBborderFlags()\fP 
 
372
.RE
 
373
.PP
 
374
 
 
375
.SS "void QwtInterval::setInterval (doubleminValue, doublemaxValue, \fBBorderFlags\fPborderFlags = \fCIncludeBorders\fP)\fC [inline]\fP"Assign the limits of the interval
 
376
.PP
 
377
\fBParameters:\fP
 
378
.RS 4
 
379
\fIminValue\fP Minimum value 
 
380
.br
 
381
\fImaxValue\fP Maximum value 
 
382
.br
 
383
\fIborderFlags\fP Include/Exclude borders 
 
384
.RE
 
385
.PP
 
386
 
 
387
.SS "void QwtInterval::setMaxValue (doublemaxValue)\fC [inline]\fP"Assign the upper limit of the interval
 
388
.PP
 
389
\fBParameters:\fP
 
390
.RS 4
 
391
\fImaxValue\fP Maximum value 
 
392
.RE
 
393
.PP
 
394
 
 
395
.SS "void QwtInterval::setMinValue (doubleminValue)\fC [inline]\fP"Assign the lower limit of the interval
 
396
.PP
 
397
\fBParameters:\fP
 
398
.RS 4
 
399
\fIminValue\fP Minimum value 
 
400
.RE
 
401
.PP
 
402
 
 
403
.SS "\fBQwtInterval\fP QwtInterval::symmetrize (doublevalue) const"Adjust the limit that is closer to value, so that value becomes the center of the interval.
 
404
.PP
 
405
\fBParameters:\fP
 
406
.RS 4
 
407
\fIvalue\fP Center 
 
408
.RE
 
409
.PP
 
410
\fBReturns:\fP
 
411
.RS 4
 
412
Interval with value as center 
 
413
.RE
 
414
.PP
 
415
 
 
416
.SS "\fBQwtInterval\fP QwtInterval::unite (const \fBQwtInterval\fP &other) const"
 
417
.PP
 
418
Unite 2 intervals. 
 
419
.SS "double QwtInterval::width () const\fC [inline]\fP"Return the width of an interval The width of invalid intervals is 0.0, otherwise the result is \fBmaxValue()\fP - \fBminValue()\fP.
 
420
.PP
 
421
\fBSee also:\fP
 
422
.RS 4
 
423
\fBisValid()\fP 
 
424
.RE
 
425
.PP
 
426
 
 
427
 
 
428
.SH "Author"
 
429
.PP 
 
430
Generated automatically by Doxygen for Qwt User's Guide from the source code.