QCPDataSelection

Search for usage in LXR

QCPDataSelection Class Reference

Public Member Functions

 QCPDataSelection ()
 
 QCPDataSelection (const QCPDataRange &range)
 
void addDataRange (const QCPDataRange &dataRange, bool simplify=true)
 
void clear ()
 
bool contains (const QCPDataSelection &other) const
 
int dataPointCount () const
 
QCPDataRange dataRange (int index=0) const
 
int dataRangeCount () const
 
QList< QCPDataRangedataRanges () const
 
void enforceType (QCP::SelectionType type)
 
QCPDataSelection intersection (const QCPDataRange &other) const
 
QCPDataSelection intersection (const QCPDataSelection &other) const
 
QCPDataSelection inverse (const QCPDataRange &outerRange) const
 
bool isEmpty () const
 
bool operator!= (const QCPDataSelection &other) const
 
QCPDataSelectionoperator+= (const QCPDataRange &other)
 
QCPDataSelectionoperator+= (const QCPDataSelection &other)
 
QCPDataSelectionoperator-= (const QCPDataRange &other)
 
QCPDataSelectionoperator-= (const QCPDataSelection &other)
 
bool operator== (const QCPDataSelection &other) const
 
void simplify ()
 
QCPDataRange span () const
 

Related Functions

(Note that these are not member functions.)

QDebug operator<< (QDebug d, const QCPDataSelection &selection)
 

Detailed Description

Describes a data set by holding multiple QCPDataRange instances.

QCPDataSelection manages multiple instances of QCPDataRange in order to represent any (possibly disjoint) set of data selection.

The data selection can be modified with addition and subtraction operators which take QCPDataSelection and QCPDataRange instances, as well as methods such as addDataRange and clear. Read access is provided by dataRange, dataRanges, dataRangeCount, etc.

The method simplify is used to join directly adjacent or even overlapping QCPDataRange instances. QCPDataSelection automatically simplifies when using the addition/subtraction operators. The only case when simplify is left to the user, is when calling addDataRange, with the parameter simplify explicitly set to false. This is useful if many data ranges will be added to the selection successively and the overhead for simplifying after each iteration shall be avoided. In this case, you should make sure to call simplify after completing the operation.

Use enforceType to bring the data selection into a state complying with the constraints for selections defined in QCP::SelectionType.

QCustomPlot's data selection mechanism is based on QCPDataSelection and QCPDataRange.

Iterating over a data selection

As an example, the following code snippet calculates the average value of a graph's data selection:

Definition at line 933 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPDataSelection() [1/2]

QCPDataSelection::QCPDataSelection ( )
explicit

Creates an empty QCPDataSelection.

Definition at line 2397 of file qcustomplot.cpp.

◆ QCPDataSelection() [2/2]

QCPDataSelection::QCPDataSelection ( const QCPDataRange range)
explicit

Creates a QCPDataSelection containing the provided range.

Definition at line 2404 of file qcustomplot.cpp.

Member Function Documentation

◆ addDataRange()

void QCPDataSelection::addDataRange ( const QCPDataRange dataRange,
bool  simplify = true 
)

Adds the given dataRange to this data selection. This is equivalent to the += operator but allows disabling immediate simplification by setting simplify to false. This can improve performance if adding a very large amount of data ranges successively. In this case, make sure to call simplify manually, after the operation.

Definition at line 2556 of file qcustomplot.cpp.

◆ clear()

void QCPDataSelection::clear ( )

Removes all data ranges. The data selection then contains no data points.

isEmpty

Definition at line 2568 of file qcustomplot.cpp.

◆ contains()

bool QCPDataSelection::contains ( const QCPDataSelection other) const

Returns true if the data selection other is contained entirely in this data selection, i.e. all data point indices that are in other are also in this data selection.

See also
QCPDataRange::contains

Definition at line 2666 of file qcustomplot.cpp.

◆ dataPointCount()

int QCPDataSelection::dataPointCount ( ) const

Returns the total number of data points contained in all data ranges that make up this data selection.

Definition at line 2510 of file qcustomplot.cpp.

◆ dataRange()

QCPDataRange QCPDataSelection::dataRange ( int  index = 0) const

Returns the data range with the specified index.

If the data selection is simplified (the usual state of the selection, see simplify), the ranges are sorted by ascending data point index.

See also
dataRangeCount

Definition at line 2526 of file qcustomplot.cpp.

◆ dataRangeCount()

int QCPDataSelection::dataRangeCount ( ) const
inline

Returns the number of ranges that make up the data selection. The ranges can be accessed by dataRange via their index.

See also
dataRange, dataPointCount

Definition at line 955 of file qcustomplot.h.

◆ dataRanges()

QList< QCPDataRange > QCPDataSelection::dataRanges ( ) const
inline

Returns all data ranges that make up the data selection. If the data selection is simplified (the usual state of the selection, see simplify), the ranges are sorted by ascending data point index.

See also
dataRange

Definition at line 958 of file qcustomplot.h.

◆ enforceType()

void QCPDataSelection::enforceType ( QCP::SelectionType  type)

Makes sure this data selection conforms to the specified type selection type. Before the type is enforced, simplify is called.

Depending on type, enforcing means adding new data points that were previously not part of the selection, or removing data points from the selection. If the current selection already conforms to type, the data selection is not changed.

See also
QCP::SelectionType

Definition at line 2619 of file qcustomplot.cpp.

◆ intersection() [1/2]

QCPDataSelection QCPDataSelection::intersection ( const QCPDataRange other) const

Returns a data selection containing the points which are both in this data selection and in the data range other.

A common use case is to limit an unknown data selection to the valid range of a data container, using QCPDataContainer::dataRange as other. One can then safely iterate over the returned data selection without exceeding the data container's bounds.

Definition at line 2690 of file qcustomplot.cpp.

◆ intersection() [2/2]

QCPDataSelection QCPDataSelection::intersection ( const QCPDataSelection other) const

Returns a data selection containing the points which are both in this data selection and in the data selection other.

Definition at line 2703 of file qcustomplot.cpp.

◆ inverse()

QCPDataSelection QCPDataSelection::inverse ( const QCPDataRange outerRange) const

Returns a data selection which is the exact inverse of this data selection, with outerRange defining the base range on which to invert. If outerRange is smaller than the span of this data selection, it is expanded accordingly.

For example, this method can be used to retrieve all unselected segments by setting outerRange to the full data range of the plottable, and calling this method on a data selection holding the selected segments.

Definition at line 2721 of file qcustomplot.cpp.

◆ isEmpty()

bool QCPDataSelection::isEmpty ( ) const
inline

Returns true if there are no data ranges, and thus no data points, in this QCPDataSelection instance.

See also
dataRangeCount

Definition at line 964 of file qcustomplot.h.

◆ operator+=() [1/2]

QCPDataSelection & QCPDataSelection::operator+= ( const QCPDataRange other)

Adds the data range other to this data selection, and then simplifies this data selection (see simplify).

Definition at line 2443 of file qcustomplot.cpp.

◆ operator+=() [2/2]

QCPDataSelection & QCPDataSelection::operator+= ( const QCPDataSelection other)

Adds the data selection of other to this data selection, and then simplifies this data selection (see simplify).

Definition at line 2432 of file qcustomplot.cpp.

◆ operator-=() [1/2]

QCPDataSelection & QCPDataSelection::operator-= ( const QCPDataRange other)

Removes all data point indices that are described by other from this data selection.

Definition at line 2463 of file qcustomplot.cpp.

◆ operator-=() [2/2]

QCPDataSelection & QCPDataSelection::operator-= ( const QCPDataSelection other)

Removes all data point indices that are described by other from this data selection.

Definition at line 2452 of file qcustomplot.cpp.

◆ operator==()

bool QCPDataSelection::operator== ( const QCPDataSelection other) const

Returns true if this selection is identical (contains the same data ranges with the same begin and end indices) to other.

Note that both data selections must be in simplified state (the usual state of the selection, see simplify) for this operator to return correct results.

Definition at line 2416 of file qcustomplot.cpp.

◆ simplify()

void QCPDataSelection::simplify ( )

Sorts all data ranges by range begin index in ascending order, and then joins directly adjacent or overlapping ranges. This can reduce the number of individual data ranges in the selection, and prevents possible double-counting when iterating over the data points held by the data ranges.

This method is automatically called when using the addition/subtraction operators. The only case when simplify is left to the user, is when calling addDataRange, with the parameter simplify explicitly set to false.

Definition at line 2582 of file qcustomplot.cpp.

◆ span()

QCPDataRange QCPDataSelection::span ( ) const

Returns a QCPDataRange which spans the entire data selection, including possible intermediate segments which are not part of the original data selection.

Definition at line 2542 of file qcustomplot.cpp.

Friends And Related Function Documentation

◆ operator<<()

QDebug operator<< ( QDebug  d,
const QCPDataSelection selection 
)
related

Prints selection in a human readable format to the qDebug output.

Definition at line 1079 of file qcustomplot.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Aug 18 2022 03:56:48 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.