File: QwtSamplingThread.3

package info (click to toggle)
qwt 6.1.2-6
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,848 kB
  • ctags: 15,811
  • sloc: cpp: 57,382; makefile: 41
file content (142 lines) | stat: -rw-r--r-- 2,752 bytes parent folder | download
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
.TH "QwtSamplingThread" 3 "Thu Dec 11 2014" "Version 6.1.2" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtSamplingThread \- 
.PP
A thread collecting samples at regular intervals\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_sampling_thread\&.h>\fP
.PP
Inherits QThread\&.
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBsetInterval\fP (double \fBinterval\fP)"
.br
.ti -1c
.RI "void \fBstop\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fB~QwtSamplingThread\fP ()"
.br
.RI "\fIDestructor\&. \fP"
.ti -1c
.RI "double \fBinterval\fP () const "
.br
.ti -1c
.RI "double \fBelapsed\fP () const "
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtSamplingThread\fP (QObject *parent=NULL)"
.br
.RI "\fIConstructor\&. \fP"
.ti -1c
.RI "virtual void \fBrun\fP ()"
.br
.ti -1c
.RI "virtual void \fBsample\fP (double \fBelapsed\fP)=0"
.br
.in -1c
.SH "Detailed Description"
.PP 
A thread collecting samples at regular intervals\&. 

Continuous signals are converted into a discrete signal by collecting samples at regular intervals\&. A discrete signal can be displayed by a \fBQwtPlotSeriesItem\fP on a \fBQwtPlot\fP widget\&.
.PP
\fBQwtSamplingThread\fP starts a thread calling periodically \fBsample()\fP, to collect and store ( or emit ) a single sample\&.
.PP
\fBSee Also:\fP
.RS 4
\fBQwtPlotCurve\fP, \fBQwtPlotSeriesItem\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "double QwtSamplingThread::elapsed () const"

.PP
\fBReturns:\fP
.RS 4
Time (in ms) since the thread was started 
.RE
.PP
\fBSee Also:\fP
.RS 4
QThread::start(), \fBrun()\fP 
.RE
.PP

.SS "double QwtSamplingThread::interval () const"

.PP
\fBReturns:\fP
.RS 4
Interval (in ms), between 2 calls of \fBsample()\fP 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetInterval()\fP 
.RE
.PP

.SS "void QwtSamplingThread::run ()\fC [protected]\fP, \fC [virtual]\fP"
Loop collecting samples started from QThread::start() 
.PP
\fBSee Also:\fP
.RS 4
\fBstop()\fP 
.RE
.PP

.SS "virtual void QwtSamplingThread::sample (doubleelapsed)\fC [protected]\fP, \fC [pure virtual]\fP"
Collect a sample
.PP
\fBParameters:\fP
.RS 4
\fIelapsed\fP Time since the thread was started in milliseconds 
.RE
.PP

.SS "void QwtSamplingThread::setInterval (doubleinterval)\fC [slot]\fP"
Change the interval (in ms), when \fBsample()\fP is called\&. The default interval is 1000\&.0 ( = 1s )
.PP
\fBParameters:\fP
.RS 4
\fIinterval\fP Interval 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBinterval()\fP 
.RE
.PP

.SS "void QwtSamplingThread::stop ()\fC [slot]\fP"
Terminate the collecting thread 
.PP
\fBSee Also:\fP
.RS 4
QThread::start(), \fBrun()\fP 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.