Add files from zip
This commit is contained in:
193
doc/man/man3/QwtSeriesStore.3
Normal file
193
doc/man/man3/QwtSeriesStore.3
Normal file
@@ -0,0 +1,193 @@
|
||||
.TH "QwtSeriesStore< T >" 3 "Sun Jul 18 2021" "Version 6.2.0" "Qwt User's Guide" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
QwtSeriesStore< T > \- Class storing a \fBQwtSeriesData\fP object\&.
|
||||
|
||||
.SH SYNOPSIS
|
||||
.br
|
||||
.PP
|
||||
.PP
|
||||
\fC#include <qwt_series_store\&.h>\fP
|
||||
.PP
|
||||
Inherits \fBQwtAbstractSeriesStore\fP\&.
|
||||
.SS "Public Member Functions"
|
||||
|
||||
.in +1c
|
||||
.ti -1c
|
||||
.RI "\fBQwtSeriesStore\fP ()"
|
||||
.br
|
||||
.RI "Constructor The store contains no series\&. "
|
||||
.ti -1c
|
||||
.RI "\fB~QwtSeriesStore\fP ()"
|
||||
.br
|
||||
.RI "Destructor\&. "
|
||||
.ti -1c
|
||||
.RI "void \fBsetData\fP (\fBQwtSeriesData\fP< T > *series)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "\fBQwtSeriesData\fP< T > * \fBdata\fP ()"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "const \fBQwtSeriesData\fP< T > * \fBdata\fP () const"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "T \fBsample\fP (int index) const"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "virtual size_t \fBdataSize\fP () const override"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "virtual QRectF \fBdataRect\fP () const override"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "virtual void \fBsetRectOfInterest\fP (const QRectF &rect) override"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "\fBQwtSeriesData\fP< T > * \fBswapData\fP (\fBQwtSeriesData\fP< T > *series)"
|
||||
.br
|
||||
.in -1c
|
||||
.SS "Additional Inherited Members"
|
||||
.SH "Detailed Description"
|
||||
.PP
|
||||
|
||||
.SS "template<typename T>
|
||||
.br
|
||||
class QwtSeriesStore< T >"
|
||||
Class storing a \fBQwtSeriesData\fP object\&.
|
||||
|
||||
\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\&.
|
||||
.PP
|
||||
\fBQwtSeriesStore\fP offers the template based part for the plot item API, so that \fBQwtPlotSeriesItem\fP can be derived without any hassle with templates\&.
|
||||
.PP
|
||||
Definition at line 66 of file qwt_series_store\&.h\&.
|
||||
.SH "Member Function Documentation"
|
||||
.PP
|
||||
.SS "template<typename T > \fBQwtSeriesData\fP< T > * \fBQwtSeriesStore\fP< T >::data\fC [inline]\fP"
|
||||
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
the the series data
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 146 of file qwt_series_store\&.h\&.
|
||||
.SS "template<typename T > const \fBQwtSeriesData\fP< T > * \fBQwtSeriesStore\fP< T >::data\fC [inline]\fP"
|
||||
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
the the series data
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 152 of file qwt_series_store\&.h\&.
|
||||
.SS "template<typename T > QRectF \fBQwtSeriesStore\fP< T >::dataRect\fC [override]\fP, \fC [virtual]\fP"
|
||||
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
Bounding rectangle of the series or an invalid rectangle, when no series is stored
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBQwtSeriesData<T>::boundingRect()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Implements \fBQwtAbstractSeriesStore\fP\&.
|
||||
.PP
|
||||
Definition at line 184 of file qwt_series_store\&.h\&.
|
||||
.SS "template<typename T > size_t \fBQwtSeriesStore\fP< T >::dataSize\fC [override]\fP, \fC [virtual]\fP"
|
||||
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
Number of samples of the series
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBsetData()\fP, \fBQwtSeriesData<T>::size()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Implements \fBQwtAbstractSeriesStore\fP\&.
|
||||
.PP
|
||||
Definition at line 175 of file qwt_series_store\&.h\&.
|
||||
.SS "template<typename T > T \fBQwtSeriesStore\fP< T >::sample (int index) const\fC [inline]\fP"
|
||||
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIindex\fP Index
|
||||
.RE
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
Sample at position index
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 158 of file qwt_series_store\&.h\&.
|
||||
.SS "template<typename T > void \fBQwtSeriesStore\fP< T >::setData (\fBQwtSeriesData\fP< T > * series)"
|
||||
Assign a series of samples
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIseries\fP Data
|
||||
.RE
|
||||
.PP
|
||||
\fBWarning\fP
|
||||
.RS 4
|
||||
The item takes ownership of the data object, deleting it when its not used anymore\&.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 164 of file qwt_series_store\&.h\&.
|
||||
.SS "template<typename T > void \fBQwtSeriesStore\fP< T >::setRectOfInterest (const QRectF & rect)\fC [override]\fP, \fC [virtual]\fP"
|
||||
Set a the 'rect of interest' for the series
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIrect\fP Rectangle of interest
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBQwtSeriesData<T>::setRectOfInterest()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Implements \fBQwtAbstractSeriesStore\fP\&.
|
||||
.PP
|
||||
Definition at line 193 of file qwt_series_store\&.h\&.
|
||||
.SS "template<typename T > \fBQwtSeriesData\fP< T > * \fBQwtSeriesStore\fP< T >::swapData (\fBQwtSeriesData\fP< T > * series)"
|
||||
Replace a series without deleting the previous one
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIseries\fP New series
|
||||
.RE
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
Previously assigned series
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 200 of file qwt_series_store\&.h\&.
|
||||
|
||||
.SH "Author"
|
||||
.PP
|
||||
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.
|
||||
Reference in New Issue
Block a user