← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.1.0/doc/man/man3/QwtScaleEngine.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2008-05-26 10:26:31 UTC
  • mfrom: (1.1.3 upstream) (2.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080526102631-bp95mfccnrb957nx
Tags: 5.1.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.0/doc/man/man3/QwtScaleEngine.3
1
 
.TH "QwtScaleEngine" 3 "1 May 2008" "Version 5.1.0" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtScaleEngine \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
Inherited by \fBQwtLinearScaleEngine\fP, and \fBQwtLog10ScaleEngine\fP.
10
 
.PP
11
 
.SH "Detailed Description"
12
 
.PP 
13
 
Base class for scale engines. 
14
 
 
15
 
A scale engine trys to find 'reasonable' ranges and step sizes for scales.
16
 
.PP
17
 
The layout of the scale can be varied with \fBsetAttribute()\fP.
18
 
.PP
19
 
Qwt offers implementations for logarithmic (log10) and linear scales. Contributions for other types of scale engines (date/time, log2 ... ) are welcome. 
20
 
.PP
21
 
Definition at line 50 of file qwt_scale_engine.h.
22
 
.SS "Public Types"
23
 
 
24
 
.in +1c
25
 
.ti -1c
26
 
.RI "enum \fBAttribute\fP { \fBNoAttribute\fP =  0, \fBIncludeReference\fP =  1, \fBSymmetric\fP =  2, \fBFloating\fP =  4, \fBInverted\fP =  8 }"
27
 
.br
28
 
.in -1c
29
 
.SS "Public Member Functions"
30
 
 
31
 
.in +1c
32
 
.ti -1c
33
 
.RI "\fBQwtScaleEngine\fP ()"
34
 
.br
35
 
.ti -1c
36
 
.RI "virtual \fB~QwtScaleEngine\fP ()"
37
 
.br
38
 
.ti -1c
39
 
.RI "void \fBsetAttribute\fP (\fBAttribute\fP, bool on=true)"
40
 
.br
41
 
.ti -1c
42
 
.RI "bool \fBtestAttribute\fP (\fBAttribute\fP) const"
43
 
.br
44
 
.ti -1c
45
 
.RI "void \fBsetAttributes\fP (int)"
46
 
.br
47
 
.ti -1c
48
 
.RI "int \fBattributes\fP () const"
49
 
.br
50
 
.ti -1c
51
 
.RI "void \fBsetReference\fP (double reference)"
52
 
.br
53
 
.ti -1c
54
 
.RI "double \fBreference\fP () const"
55
 
.br
56
 
.ti -1c
57
 
.RI "void \fBsetMargins\fP (double m1, double m2)"
58
 
.br
59
 
.ti -1c
60
 
.RI "double \fBloMargin\fP () const"
61
 
.br
62
 
.ti -1c
63
 
.RI "double \fBhiMargin\fP () const"
64
 
.br
65
 
.ti -1c
66
 
.RI "virtual void \fBautoScale\fP (int maxNumSteps, double &x1, double &x2, double &stepSize) const =0"
67
 
.br
68
 
.ti -1c
69
 
.RI "virtual \fBQwtScaleDiv\fP \fBdivideScale\fP (double x1, double x2, int maxMajSteps, int maxMinSteps, double stepSize=0.0) const=0"
70
 
.br
71
 
.ti -1c
72
 
.RI "virtual \fBQwtScaleTransformation\fP * \fBtransformation\fP () const=0"
73
 
.br
74
 
.in -1c
75
 
.SS "Protected Member Functions"
76
 
 
77
 
.in +1c
78
 
.ti -1c
79
 
.RI "bool \fBcontains\fP (const \fBQwtDoubleInterval\fP &, double val) const"
80
 
.br
81
 
.ti -1c
82
 
.RI "QwtValueList \fBstrip\fP (const QwtValueList &, const \fBQwtDoubleInterval\fP &) const"
83
 
.br
84
 
.ti -1c
85
 
.RI "double \fBdivideInterval\fP (double interval, int numSteps) const "
86
 
.br
87
 
.ti -1c
88
 
.RI "\fBQwtDoubleInterval\fP \fBbuildInterval\fP (double v) const"
89
 
.br
90
 
.in -1c
91
 
.SH "Member Enumeration Documentation"
92
 
.PP 
93
 
.SS "enum \fBQwtScaleEngine::Attribute\fP"
94
 
.PP
95
 
see \fBQwtScaleEngine::setAttribute\fP, testAttribute 
96
 
.PP
97
 
Definition at line 54 of file qwt_scale_engine.h.
98
 
.SH "Constructor & Destructor Documentation"
99
 
.PP 
100
 
.SS "QwtScaleEngine::QwtScaleEngine ()\fC [explicit]\fP"
101
 
.PP
102
 
Ctor. 
103
 
.PP
104
 
Definition at line 170 of file qwt_scale_engine.cpp.
105
 
.SS "QwtScaleEngine::~QwtScaleEngine ()\fC [virtual]\fP"
106
 
.PP
107
 
Dtor. 
108
 
.PP
109
 
Definition at line 177 of file qwt_scale_engine.cpp.
110
 
.SH "Member Function Documentation"
111
 
.PP 
112
 
.SS "void QwtScaleEngine::setAttribute (\fBAttribute\fP attribute, bool on = \fCtrue\fP)"
113
 
.PP
114
 
Change a scale attribute
115
 
.PP
116
 
\fBParameters:\fP
117
 
.RS 4
118
 
\fIattribute\fP Attribute to change 
119
 
.br
120
 
\fIon\fP On/Off
121
 
.RE
122
 
.PP
123
 
The behaviour of the scale engine can be changed with the following attributes: 
124
 
.IP "\fBQwtScaleEngine::IncludeReference \fP" 1c
125
 
Build a scale which includes the reference value. 
126
 
.IP "\fBQwtScaleEngine::Symmetric \fP" 1c
127
 
Build a scale which is symmetric to the reference value. 
128
 
.IP "\fBQwtScaleEngine::Floating \fP" 1c
129
 
The endpoints of the scale are supposed to be equal the outmost included values plus the specified margins (see \fBsetMargins()\fP). If this attribute is not* set, the endpoints of the scale will be integer multiples of the step size. 
130
 
.IP "\fBQwtScaleEngine::Inverted \fP" 1c
131
 
Turn the scale upside down. 
132
 
.PP
133
 
.PP
134
 
\fBSee also:\fP
135
 
.RS 4
136
 
\fBQwtScaleEngine::testAttribute()\fP 
137
 
.RE
138
 
.PP
139
 
 
140
 
.PP
141
 
Definition at line 340 of file qwt_scale_engine.cpp.
142
 
.SS "bool QwtScaleEngine::testAttribute (\fBAttribute\fP attribute) const"
143
 
.PP
144
 
Check if a attribute is set.
145
 
.PP
146
 
\fBParameters:\fP
147
 
.RS 4
148
 
\fIattribute\fP Attribute to be tested 
149
 
.RE
150
 
.PP
151
 
\fBSee also:\fP
152
 
.RS 4
153
 
\fBQwtScaleEngine::setAttribute()\fP for a description of the possible options. 
154
 
.RE
155
 
.PP
156
 
 
157
 
.PP
158
 
Definition at line 354 of file qwt_scale_engine.cpp.
159
 
.PP
160
 
Referenced by QwtLog10ScaleEngine::autoScale(), and QwtLinearScaleEngine::autoScale().
161
 
.SS "void QwtScaleEngine::setAttributes (int attributes)"
162
 
.PP
163
 
Change the scale attribute
164
 
.PP
165
 
\fBParameters:\fP
166
 
.RS 4
167
 
\fIattributes\fP Set scale attributes 
168
 
.RE
169
 
.PP
170
 
\fBSee also:\fP
171
 
.RS 4
172
 
\fBQwtScaleEngine::attributes()\fP 
173
 
.RE
174
 
.PP
175
 
 
176
 
.PP
177
 
Definition at line 365 of file qwt_scale_engine.cpp.
178
 
.PP
179
 
Referenced by QwtLog10ScaleEngine::divideScale().
180
 
.SS "int QwtScaleEngine::attributes () const"
181
 
.PP
182
 
Return the scale attributes 
183
 
.PP
184
 
Definition at line 373 of file qwt_scale_engine.cpp.
185
 
.PP
186
 
Referenced by QwtLog10ScaleEngine::divideScale().
187
 
.SS "void QwtScaleEngine::setReference (double r)"
188
 
.PP
189
 
Specify a reference point. 
190
 
.PP
191
 
\fBParameters:\fP
192
 
.RS 4
193
 
\fIr\fP new reference value
194
 
.RE
195
 
.PP
196
 
The reference point is needed if options IncludeRef or Symmetric are active. Its default value is 0.0. 
197
 
.PP
198
 
Definition at line 385 of file qwt_scale_engine.cpp.
199
 
.PP
200
 
Referenced by QwtLog10ScaleEngine::divideScale().
201
 
.SS "double QwtScaleEngine::reference () const"
202
 
.PP
203
 
\fBReturns:\fP
204
 
.RS 4
205
 
the reference value 
206
 
.RE
207
 
.PP
208
 
\fBSee also:\fP
209
 
.RS 4
210
 
\fBQwtScaleEngine::setReference()\fP, QwtScaleEngine::setOptions() 
211
 
.RE
212
 
.PP
213
 
 
214
 
.PP
215
 
Definition at line 394 of file qwt_scale_engine.cpp.
216
 
.PP
217
 
Referenced by QwtLog10ScaleEngine::autoScale(), QwtLinearScaleEngine::autoScale(), and QwtLog10ScaleEngine::divideScale().
218
 
.SS "void QwtScaleEngine::setMargins (double mlo, double mhi)"
219
 
.PP
220
 
Specify margins at the scale's endpoints. 
221
 
.PP
222
 
\fBParameters:\fP
223
 
.RS 4
224
 
\fImlo\fP minimum distance between the scale's lower boundary and the smallest enclosed value 
225
 
.br
226
 
\fImhi\fP minimum distance between the scale's upper boundary and the greatest enclosed value
227
 
.RE
228
 
.PP
229
 
Margins can be used to leave a minimum amount of space between the enclosed intervals and the boundaries of the scale.
230
 
.PP
231
 
\fBWarning:\fP
232
 
.RS 4
233
 
.PD 0
234
 
.IP "\(bu" 2
235
 
\fBQwtLog10ScaleEngine\fP measures the margins in decades.
236
 
.PP
237
 
.RE
238
 
.PP
239
 
\fBSee also:\fP
240
 
.RS 4
241
 
\fBQwtScaleEngine::hiMargin\fP, \fBQwtScaleEngine::loMargin\fP 
242
 
.RE
243
 
.PP
244
 
 
245
 
.PP
246
 
Definition at line 220 of file qwt_scale_engine.cpp.
247
 
.PP
248
 
Referenced by QwtLog10ScaleEngine::divideScale().
249
 
.SS "double QwtScaleEngine::loMargin () const"
250
 
.PP
251
 
\fBReturns:\fP
252
 
.RS 4
253
 
the margin at the lower end of the scale The default margin is 0.
254
 
.RE
255
 
.PP
256
 
\fBSee also:\fP
257
 
.RS 4
258
 
\fBQwtScaleEngine::setMargins()\fP 
259
 
.RE
260
 
.PP
261
 
 
262
 
.PP
263
 
Definition at line 188 of file qwt_scale_engine.cpp.
264
 
.PP
265
 
Referenced by QwtLog10ScaleEngine::autoScale(), QwtLinearScaleEngine::autoScale(), and QwtLog10ScaleEngine::divideScale().
266
 
.SS "double QwtScaleEngine::hiMargin () const"
267
 
.PP
268
 
\fBReturns:\fP
269
 
.RS 4
270
 
the margin at the upper end of the scale The default margin is 0.
271
 
.RE
272
 
.PP
273
 
\fBSee also:\fP
274
 
.RS 4
275
 
\fBQwtScaleEngine::setMargins()\fP 
276
 
.RE
277
 
.PP
278
 
 
279
 
.PP
280
 
Definition at line 199 of file qwt_scale_engine.cpp.
281
 
.PP
282
 
Referenced by QwtLog10ScaleEngine::autoScale(), QwtLinearScaleEngine::autoScale(), and QwtLog10ScaleEngine::divideScale().
283
 
.SS "virtual void QwtScaleEngine::autoScale (int maxNumSteps, double & x1, double & x2, double & stepSize) const\fC [pure virtual]\fP"
284
 
.PP
285
 
Align and divide an interval
286
 
.PP
287
 
\fBParameters:\fP
288
 
.RS 4
289
 
\fImaxNumSteps\fP Max. number of steps 
290
 
.br
291
 
\fIx1\fP First limit of the interval (In/Out) 
292
 
.br
293
 
\fIx2\fP Second limit of the interval (In/Out) 
294
 
.br
295
 
\fIstepSize\fP Step size (Return value) 
296
 
.RE
297
 
.PP
298
 
 
299
 
.PP
300
 
Implemented in \fBQwtLinearScaleEngine\fP, and \fBQwtLog10ScaleEngine\fP.
301
 
.SS "virtual \fBQwtScaleDiv\fP QwtScaleEngine::divideScale (double x1, double x2, int maxMajSteps, int maxMinSteps, double stepSize = \fC0.0\fP) const\fC [pure virtual]\fP"
302
 
.PP
303
 
Calculate a scale division. 
304
 
.PP
305
 
\fBParameters:\fP
306
 
.RS 4
307
 
\fIx1\fP First interval limit 
308
 
.br
309
 
\fIx2\fP Second interval limit 
310
 
.br
311
 
\fImaxMajSteps\fP Maximum for the number of major steps 
312
 
.br
313
 
\fImaxMinSteps\fP Maximum number of minor steps 
314
 
.br
315
 
\fIstepSize\fP Step size. If stepSize == 0.0, the scaleEngine calculates one. 
316
 
.RE
317
 
.PP
318
 
 
319
 
.PP
320
 
Implemented in \fBQwtLinearScaleEngine\fP, and \fBQwtLog10ScaleEngine\fP.
321
 
.SS "virtual \fBQwtScaleTransformation\fP* QwtScaleEngine::transformation () const\fC [pure virtual]\fP"
322
 
.PP
323
 
\fBReturns:\fP
324
 
.RS 4
325
 
a transformation 
326
 
.RE
327
 
.PP
328
 
 
329
 
.PP
330
 
Implemented in \fBQwtLinearScaleEngine\fP, and \fBQwtLog10ScaleEngine\fP.
331
 
.SS "bool QwtScaleEngine::contains (const \fBQwtDoubleInterval\fP & interval, double value) const\fC [protected]\fP"
332
 
.PP
333
 
Check if an interval 'contains' a value
334
 
.PP
335
 
\fBParameters:\fP
336
 
.RS 4
337
 
\fIinterval\fP Interval 
338
 
.br
339
 
\fIvalue\fP Value
340
 
.RE
341
 
.PP
342
 
\fBSee also:\fP
343
 
.RS 4
344
 
\fBQwtScaleArithmetic::compareEps\fP 
345
 
.RE
346
 
.PP
347
 
 
348
 
.PP
349
 
Definition at line 252 of file qwt_scale_engine.cpp.
350
 
.PP
351
 
References QwtScaleArithmetic::compareEps(), QwtDoubleInterval::isValid(), QwtDoubleInterval::maxValue(), QwtDoubleInterval::minValue(), and QwtDoubleInterval::width().
352
 
.PP
353
 
Referenced by strip().
354
 
.SS "QwtValueList QwtScaleEngine::strip (const QwtValueList & ticks, const \fBQwtDoubleInterval\fP & interval) const\fC [protected]\fP"
355
 
.PP
356
 
Remove ticks from a list, that are not inside an interval
357
 
.PP
358
 
\fBParameters:\fP
359
 
.RS 4
360
 
\fIticks\fP Tick list 
361
 
.br
362
 
\fIinterval\fP Interval
363
 
.RE
364
 
.PP
365
 
\fBReturns:\fP
366
 
.RS 4
367
 
Stripped tick list 
368
 
.RE
369
 
.PP
370
 
 
371
 
.PP
372
 
Definition at line 281 of file qwt_scale_engine.cpp.
373
 
.PP
374
 
References contains(), and QwtDoubleInterval::isValid().
375
 
.SS "double QwtScaleEngine::divideInterval (double intervalSize, int numSteps) const\fC [protected]\fP"
376
 
.PP
377
 
Calculate a step size for an interval size
378
 
.PP
379
 
\fBParameters:\fP
380
 
.RS 4
381
 
\fIintervalSize\fP Interval size 
382
 
.br
383
 
\fInumSteps\fP Number of steps
384
 
.RE
385
 
.PP
386
 
\fBReturns:\fP
387
 
.RS 4
388
 
Step size 
389
 
.RE
390
 
.PP
391
 
 
392
 
.PP
393
 
Definition at line 234 of file qwt_scale_engine.cpp.
394
 
.PP
395
 
References QwtScaleArithmetic::ceil125(), and QwtScaleArithmetic::divideEps().
396
 
.PP
397
 
Referenced by QwtLog10ScaleEngine::autoScale(), QwtLinearScaleEngine::autoScale(), QwtLog10ScaleEngine::divideScale(), and QwtLinearScaleEngine::divideScale().
398
 
.SS "\fBQwtDoubleInterval\fP QwtScaleEngine::buildInterval (double v) const\fC [protected]\fP"
399
 
.PP
400
 
Build an interval for a value. 
401
 
.PP
402
 
In case of v == 0.0 the interval is [-0.5, 0.5], otherwide it is [0.5 * v, 1.5 * v] 
403
 
.PP
404
 
Definition at line 310 of file qwt_scale_engine.cpp.
405
 
.PP
406
 
Referenced by QwtLog10ScaleEngine::autoScale(), and QwtLinearScaleEngine::autoScale().
407
 
 
408
 
.SH "Author"
409
 
.PP 
410
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.