QwtSamplingThread.3 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. .TH "QwtSamplingThread" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtSamplingThread \- A thread collecting samples at regular intervals\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_sampling_thread\&.h>\fP
  11. .PP
  12. Inherits QThread\&.
  13. .SS "Public Slots"
  14. .in +1c
  15. .ti -1c
  16. .RI "void \fBsetInterval\fP (double \fBinterval\fP)"
  17. .br
  18. .ti -1c
  19. .RI "void \fBstop\fP ()"
  20. .br
  21. .in -1c
  22. .SS "Public Member Functions"
  23. .in +1c
  24. .ti -1c
  25. .RI "virtual \fB~QwtSamplingThread\fP ()"
  26. .br
  27. .RI "Destructor\&. "
  28. .ti -1c
  29. .RI "double \fBinterval\fP () const"
  30. .br
  31. .ti -1c
  32. .RI "double \fBelapsed\fP () const"
  33. .br
  34. .in -1c
  35. .SS "Protected Member Functions"
  36. .in +1c
  37. .ti -1c
  38. .RI "\fBQwtSamplingThread\fP (QObject *parent=NULL)"
  39. .br
  40. .RI "Constructor\&. "
  41. .ti -1c
  42. .RI "virtual void \fBrun\fP ()"
  43. .br
  44. .ti -1c
  45. .RI "virtual void \fBsample\fP (double \fBelapsed\fP)=0"
  46. .br
  47. .in -1c
  48. .SH "Detailed Description"
  49. .PP
  50. A thread collecting samples at regular intervals\&.
  51. 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\&.
  52. .PP
  53. \fBQwtSamplingThread\fP starts a thread calling periodically \fBsample()\fP, to collect and store ( or emit ) a single sample\&.
  54. .PP
  55. \fBSee also\fP
  56. .RS 4
  57. \fBQwtPlotCurve\fP, \fBQwtPlotSeriesItem\fP
  58. .RE
  59. .PP
  60. .SH "Member Function Documentation"
  61. .PP
  62. .SS "double QwtSamplingThread::elapsed () const"
  63. .PP
  64. \fBReturns\fP
  65. .RS 4
  66. Time (in ms) since the thread was started
  67. .RE
  68. .PP
  69. \fBSee also\fP
  70. .RS 4
  71. QThread::start(), \fBrun()\fP
  72. .RE
  73. .PP
  74. .SS "double QwtSamplingThread::interval () const"
  75. .PP
  76. \fBReturns\fP
  77. .RS 4
  78. Interval (in ms), between 2 calls of \fBsample()\fP
  79. .RE
  80. .PP
  81. \fBSee also\fP
  82. .RS 4
  83. \fBsetInterval()\fP
  84. .RE
  85. .PP
  86. .SS "void QwtSamplingThread::run ()\fC [protected]\fP, \fC [virtual]\fP"
  87. Loop collecting samples started from QThread::start()
  88. .PP
  89. \fBSee also\fP
  90. .RS 4
  91. \fBstop()\fP
  92. .RE
  93. .PP
  94. .SS "virtual void QwtSamplingThread::sample (double elapsed)\fC [protected]\fP, \fC [pure virtual]\fP"
  95. Collect a sample
  96. .PP
  97. \fBParameters\fP
  98. .RS 4
  99. \fIelapsed\fP Time since the thread was started in milliseconds
  100. .RE
  101. .PP
  102. .SS "void QwtSamplingThread::setInterval (double interval)\fC [slot]\fP"
  103. Change the interval (in ms), when \fBsample()\fP is called\&. The default interval is 1000\&.0 ( = 1s )
  104. .PP
  105. \fBParameters\fP
  106. .RS 4
  107. \fIinterval\fP Interval
  108. .RE
  109. .PP
  110. \fBSee also\fP
  111. .RS 4
  112. \fBinterval()\fP
  113. .RE
  114. .PP
  115. .SS "void QwtSamplingThread::stop ()\fC [slot]\fP"
  116. Terminate the collecting thread
  117. .PP
  118. \fBSee also\fP
  119. .RS 4
  120. QThread::start(), \fBrun()\fP
  121. .RE
  122. .PP
  123. .SH "Author"
  124. .PP
  125. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.