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

« back to all changes in this revision

Viewing changes to qwt-5.1.0/doc/man/man3/QwtLinearScaleEngine.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:
1
 
.TH "QwtLinearScaleEngine" 3 "1 May 2008" "Version 5.1.0" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtLinearScaleEngine \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
Inherits \fBQwtScaleEngine\fP.
10
 
.PP
11
 
.SH "Detailed Description"
12
 
.PP 
13
 
A scale engine for linear scales. 
14
 
 
15
 
The step size will fit into the pattern $\left\{ 1,2,5\right\} \cdot 10^{n}$, where n is an integer. 
16
 
.PP
17
 
Definition at line 126 of file qwt_scale_engine.h.
18
 
.SS "Public Member Functions"
19
 
 
20
 
.in +1c
21
 
.ti -1c
22
 
.RI "virtual void \fBautoScale\fP (int maxSteps, double &x1, double &x2, double &stepSize) const"
23
 
.br
24
 
.ti -1c
25
 
.RI "virtual \fBQwtScaleDiv\fP \fBdivideScale\fP (double x1, double x2, int numMajorSteps, int numMinorSteps, double stepSize=0.0) const"
26
 
.br
27
 
.ti -1c
28
 
.RI "virtual \fBQwtScaleTransformation\fP * \fBtransformation\fP () const"
29
 
.br
30
 
.in -1c
31
 
.SS "Protected Member Functions"
32
 
 
33
 
.in +1c
34
 
.ti -1c
35
 
.RI "\fBQwtDoubleInterval\fP \fBalign\fP (const \fBQwtDoubleInterval\fP &, double stepSize) const"
36
 
.br
37
 
.in -1c
38
 
.SH "Member Function Documentation"
39
 
.PP 
40
 
.SS "void QwtLinearScaleEngine::autoScale (int maxNumSteps, double & x1, double & x2, double & stepSize) const\fC [virtual]\fP"
41
 
.PP
42
 
Align and divide an interval
43
 
.PP
44
 
\fBParameters:\fP
45
 
.RS 4
46
 
\fImaxNumSteps\fP Max. number of steps 
47
 
.br
48
 
\fIx1\fP First limit of the interval (In/Out) 
49
 
.br
50
 
\fIx2\fP Second limit of the interval (In/Out) 
51
 
.br
52
 
\fIstepSize\fP Step size (Out)
53
 
.RE
54
 
.PP
55
 
\fBSee also:\fP
56
 
.RS 4
57
 
\fBQwtLinearScaleEngine::setAttribute\fP 
58
 
.RE
59
 
.PP
60
 
 
61
 
.PP
62
 
Implements \fBQwtScaleEngine\fP.
63
 
.PP
64
 
Definition at line 417 of file qwt_scale_engine.cpp.
65
 
.PP
66
 
References align(), QwtScaleEngine::buildInterval(), QwtScaleEngine::divideInterval(), QwtDoubleInterval::extend(), QwtScaleEngine::hiMargin(), QwtScaleEngine::loMargin(), QwtDoubleInterval::maxValue(), QwtDoubleInterval::minValue(), QwtDoubleInterval::normalized(), QwtScaleEngine::reference(), QwtDoubleInterval::setMaxValue(), QwtDoubleInterval::setMinValue(), QwtDoubleInterval::symmetrize(), QwtScaleEngine::testAttribute(), and QwtDoubleInterval::width().
67
 
.SS "\fBQwtScaleDiv\fP QwtLinearScaleEngine::divideScale (double x1, double x2, int maxMajSteps, int maxMinSteps, double stepSize = \fC0.0\fP) const\fC [virtual]\fP"
68
 
.PP
69
 
Calculate a scale division. 
70
 
.PP
71
 
\fBParameters:\fP
72
 
.RS 4
73
 
\fIx1\fP First interval limit 
74
 
.br
75
 
\fIx2\fP Second interval limit 
76
 
.br
77
 
\fImaxMajSteps\fP Maximum for the number of major steps 
78
 
.br
79
 
\fImaxMinSteps\fP Maximum number of minor steps 
80
 
.br
81
 
\fIstepSize\fP Step size. If stepSize == 0, the scaleEngine calculates one.
82
 
.RE
83
 
.PP
84
 
\fBSee also:\fP
85
 
.RS 4
86
 
QwtScaleEngine::stepSize, QwtScaleEngine::subDivide 
87
 
.RE
88
 
.PP
89
 
 
90
 
.PP
91
 
Implements \fBQwtScaleEngine\fP.
92
 
.PP
93
 
Definition at line 462 of file qwt_scale_engine.cpp.
94
 
.PP
95
 
References QwtScaleEngine::divideInterval(), and QwtDoubleInterval::width().
96
 
.PP
97
 
Referenced by QwtLog10ScaleEngine::divideScale(), and QwtDial::updateScale().
98
 
.SS "\fBQwtScaleTransformation\fP * QwtLinearScaleEngine::transformation () const\fC [virtual]\fP"
99
 
.PP
100
 
Return a transformation, for linear scales 
101
 
.PP
102
 
Implements \fBQwtScaleEngine\fP.
103
 
.PP
104
 
Definition at line 402 of file qwt_scale_engine.cpp.
105
 
.PP
106
 
Referenced by QwtDial::updateScale().
107
 
.SS "\fBQwtDoubleInterval\fP QwtLinearScaleEngine::align (const \fBQwtDoubleInterval\fP & interval, double stepSize) const\fC [protected]\fP"
108
 
.PP
109
 
Align an interval to a step size. 
110
 
.PP
111
 
The limits of an interval are aligned that both are integer multiples of the step size.
112
 
.PP
113
 
\fBParameters:\fP
114
 
.RS 4
115
 
\fIinterval\fP Interval 
116
 
.br
117
 
\fIstepSize\fP Step size
118
 
.RE
119
 
.PP
120
 
\fBReturns:\fP
121
 
.RS 4
122
 
Aligned interval 
123
 
.RE
124
 
.PP
125
 
 
126
 
.PP
127
 
Definition at line 601 of file qwt_scale_engine.cpp.
128
 
.PP
129
 
References QwtScaleArithmetic::ceilEps(), QwtScaleArithmetic::floorEps(), QwtDoubleInterval::maxValue(), and QwtDoubleInterval::minValue().
130
 
.PP
131
 
Referenced by autoScale().
132
 
 
133
 
.SH "Author"
134
 
.PP 
135
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.