QwtSeriesStore.3 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. .TH "QwtSeriesStore< T >" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtSeriesStore< T > \- Class storing a \fBQwtSeriesData\fP object\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_series_store\&.h>\fP
  11. .PP
  12. Inherits \fBQwtAbstractSeriesStore\fP\&.
  13. .SS "Public Member Functions"
  14. .in +1c
  15. .ti -1c
  16. .RI "\fBQwtSeriesStore\fP ()"
  17. .br
  18. .RI "Constructor The store contains no series\&. "
  19. .ti -1c
  20. .RI "\fB~QwtSeriesStore\fP ()"
  21. .br
  22. .RI "Destructor\&. "
  23. .ti -1c
  24. .RI "void \fBsetData\fP (\fBQwtSeriesData\fP< T > *series)"
  25. .br
  26. .ti -1c
  27. .RI "\fBQwtSeriesData\fP< T > * \fBdata\fP ()"
  28. .br
  29. .ti -1c
  30. .RI "const \fBQwtSeriesData\fP< T > * \fBdata\fP () const"
  31. .br
  32. .ti -1c
  33. .RI "T \fBsample\fP (int index) const"
  34. .br
  35. .ti -1c
  36. .RI "virtual size_t \fBdataSize\fP () const"
  37. .br
  38. .ti -1c
  39. .RI "virtual QRectF \fBdataRect\fP () const"
  40. .br
  41. .ti -1c
  42. .RI "virtual void \fBsetRectOfInterest\fP (const QRectF &rect)"
  43. .br
  44. .ti -1c
  45. .RI "\fBQwtSeriesData\fP< T > * \fBswapData\fP (\fBQwtSeriesData\fP< T > *series)"
  46. .br
  47. .in -1c
  48. .SS "Additional Inherited Members"
  49. .SH "Detailed Description"
  50. .PP
  51. .SS "template<typename T>
  52. .br
  53. class QwtSeriesStore< T >"
  54. Class storing a \fBQwtSeriesData\fP object\&.
  55. \fBQwtSeriesStore\fP and \fBQwtPlotSeriesItem\fP are intended as base classes for all plot items iterating over a series of samples\&. Both classes share a virtual base class ( \fBQwtAbstractSeriesStore\fP ) to bridge between them\&.
  56. .PP
  57. \fBQwtSeriesStore\fP offers the template based part for the plot item API, so that \fBQwtPlotSeriesItem\fP can be derived without any hassle with templates\&.
  58. .SH "Member Function Documentation"
  59. .PP
  60. .SS "template<typename T > \fBQwtSeriesData\fP< T > * \fBQwtSeriesStore\fP< T >::data\fC [inline]\fP"
  61. .PP
  62. \fBReturns\fP
  63. .RS 4
  64. the the series data
  65. .RE
  66. .PP
  67. .SS "template<typename T > const \fBQwtSeriesData\fP< T > * \fBQwtSeriesStore\fP< T >::data\fC [inline]\fP"
  68. .PP
  69. \fBReturns\fP
  70. .RS 4
  71. the the series data
  72. .RE
  73. .PP
  74. .SS "template<typename T > QRectF \fBQwtSeriesStore\fP< T >::dataRect\fC [virtual]\fP"
  75. .PP
  76. \fBReturns\fP
  77. .RS 4
  78. Bounding rectangle of the series or an invalid rectangle, when no series is stored
  79. .RE
  80. .PP
  81. \fBSee also\fP
  82. .RS 4
  83. \fBQwtSeriesData<T>::boundingRect()\fP
  84. .RE
  85. .PP
  86. .PP
  87. Implements \fBQwtAbstractSeriesStore\fP\&.
  88. .SS "template<typename T > size_t \fBQwtSeriesStore\fP< T >::dataSize\fC [virtual]\fP"
  89. .PP
  90. \fBReturns\fP
  91. .RS 4
  92. Number of samples of the series
  93. .RE
  94. .PP
  95. \fBSee also\fP
  96. .RS 4
  97. \fBsetData()\fP, \fBQwtSeriesData<T>::size()\fP
  98. .RE
  99. .PP
  100. .PP
  101. Implements \fBQwtAbstractSeriesStore\fP\&.
  102. .SS "template<typename T > T \fBQwtSeriesStore\fP< T >::sample (int index) const\fC [inline]\fP"
  103. .PP
  104. \fBParameters\fP
  105. .RS 4
  106. \fIindex\fP Index
  107. .RE
  108. .PP
  109. \fBReturns\fP
  110. .RS 4
  111. Sample at position index
  112. .RE
  113. .PP
  114. .SS "template<typename T > void \fBQwtSeriesStore\fP< T >::setData (\fBQwtSeriesData\fP< T > * series)"
  115. Assign a series of samples
  116. .PP
  117. \fBParameters\fP
  118. .RS 4
  119. \fIseries\fP Data
  120. .RE
  121. .PP
  122. \fBWarning\fP
  123. .RS 4
  124. The item takes ownership of the data object, deleting it when its not used anymore\&.
  125. .RE
  126. .PP
  127. .SS "template<typename T > void \fBQwtSeriesStore\fP< T >::setRectOfInterest (const QRectF & rect)\fC [virtual]\fP"
  128. Set a the 'rect of interest' for the series
  129. .PP
  130. \fBParameters\fP
  131. .RS 4
  132. \fIrect\fP Rectangle of interest
  133. .RE
  134. .PP
  135. \fBSee also\fP
  136. .RS 4
  137. \fBQwtSeriesData<T>::setRectOfInterest()\fP
  138. .RE
  139. .PP
  140. .PP
  141. Implements \fBQwtAbstractSeriesStore\fP\&.
  142. .SS "template<typename T > \fBQwtSeriesData\fP< T > * \fBQwtSeriesStore\fP< T >::swapData (\fBQwtSeriesData\fP< T > * series)"
  143. Replace a series without deleting the previous one
  144. .PP
  145. \fBParameters\fP
  146. .RS 4
  147. \fIseries\fP New series
  148. .RE
  149. .PP
  150. \fBReturns\fP
  151. .RS 4
  152. Previously assigned series
  153. .RE
  154. .PP
  155. .SH "Author"
  156. .PP
  157. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.