QwtInterval(3) | Qwt User's Guide | QwtInterval(3) |
NAME¶
QwtInterval - A class representing an interval.
SYNOPSIS¶
#include <qwt_interval.h>
Public Types¶
enum BorderFlag { IncludeBorders = 0x00,
ExcludeMinimum = 0x01, ExcludeMaximum = 0x02,
ExcludeBorders = ExcludeMinimum | ExcludeMaximum }
typedef QFlags< BorderFlag > BorderFlags
Border flags.
Public Member Functions¶
QwtInterval ()
Default Constructor. QwtInterval (double minValue, double
maxValue, BorderFlags=IncludeBorders)
void setInterval (double minValue, double maxValue,
BorderFlags=IncludeBorders)
QwtInterval normalized () const
Normalize the limits of the interval. QwtInterval inverted ()
const
QwtInterval limited (double lowerBound, double upperBound) const
bool operator== (const QwtInterval &) const
Compare two intervals. bool operator!= (const QwtInterval &)
const
Compare two intervals. void setBorderFlags (BorderFlags)
BorderFlags borderFlags () const
double minValue () const
double maxValue () const
double width () const
Return the width of an interval. void setMinValue (double)
void setMaxValue (double)
bool contains (double value) const
bool intersects (const QwtInterval &) const
Test if two intervals overlap. QwtInterval intersect (const
QwtInterval &) const
Intersect 2 intervals. QwtInterval unite (const
QwtInterval &) const
Unite 2 intervals. QwtInterval operator| (const
QwtInterval &) const
QwtInterval operator & (const QwtInterval &)
const
QwtInterval & operator|= (const QwtInterval &)
Unite this interval with the given interval. QwtInterval &
operator &= (const QwtInterval &)
QwtInterval extend (double value) const
Extend the interval. QwtInterval operator| (double) const
QwtInterval & operator|= (double)
bool isValid () const
bool isNull () const
void invalidate ()
QwtInterval symmetrize (double value) const
Detailed Description¶
A class representing an interval.
The interval is represented by 2 doubles, the lower and the upper limit.
Member Enumeration Documentation¶
enum QwtInterval::BorderFlag¶
Flag indicating if a border is included or excluded
See also:
Enumerator
- IncludeBorders
- Min/Max values are inside the interval.
- ExcludeMinimum
- Min value is not included in the interval.
- ExcludeMaximum
- Max value is not included in the interval.
- ExcludeBorders
- Min/Max values are not included in the interval.
Constructor & Destructor Documentation¶
QwtInterval::QwtInterval () [inline]¶
Default Constructor. Creates an invalid interval [0.0, -1.0]
See also:
QwtInterval::QwtInterval (double minValue, double maxValue, BorderFlags borderFlags = IncludeBorders) [inline]¶
Constructor
Build an interval with from min/max values
Parameters:
maxValue Maximum value
borderFlags Include/Exclude borders
Member Function Documentation¶
QwtInterval::BorderFlags QwtInterval::borderFlags () const [inline]¶
Returns:
See also:
bool QwtInterval::contains (double value) const¶
Test if a value is inside an interval
Parameters:
Returns:
QwtInterval QwtInterval::extend (double value) const¶
Extend the interval. If value is below minValue(), value becomes the lower limit. If value is above maxValue(), value becomes the upper limit.
extend() has no effect for invalid intervals
Parameters:
Returns:
See also:
QwtInterval QwtInterval::intersect (const QwtInterval & other) const¶
Intersect 2 intervals.
Parameters:
Returns:
bool QwtInterval::intersects (const QwtInterval & other) const¶
Test if two intervals overlap.
Parameters:
Returns:
void QwtInterval::invalidate () [inline]¶
Invalidate the interval
The limits are set to interval [0.0, -1.0]
See also:
QwtInterval QwtInterval::inverted () const¶
Invert the limits of the interval
Returns:
See also:
bool QwtInterval::isNull () const [inline]¶
Returns:
bool QwtInterval::isValid () const [inline]¶
A interval is valid when minValue() <= maxValue(). In case of QwtInterval::ExcludeBorders it is true when minValue() < maxValue()
Returns:
QwtInterval QwtInterval::limited (double lowerBound, double upperBound) const¶
Limit the interval, keeping the border modes
Parameters:
upperBound Upper limit
Returns:
double QwtInterval::maxValue () const [inline]¶
Returns:
double QwtInterval::minValue () const [inline]¶
Returns:
QwtInterval QwtInterval::normalized () const¶
Normalize the limits of the interval. If maxValue() < minValue() the limits will be inverted.
Returns:
See also:
bool QwtInterval::operator!= (const QwtInterval & other) const [inline]¶
Compare two intervals.
Parameters:
Returns:
bool QwtInterval::operator== (const QwtInterval & other) const [inline]¶
Compare two intervals.
Parameters:
Returns:
QwtInterval QwtInterval::operator| (const QwtInterval & other) const [inline]¶
Union of two intervals
Parameters:
Returns:
See also:
QwtInterval QwtInterval::operator| (double value) const [inline]¶
Extend an interval
Parameters:
Returns:
See also:
QwtInterval & QwtInterval::operator|= (const QwtInterval & other)¶
Unite this interval with the given interval.
Parameters:
Returns:
QwtInterval & QwtInterval::operator|= (double value)¶
Extend an interval
Parameters:
Returns:
See also:
void QwtInterval::setBorderFlags (BorderFlags borderFlags) [inline]¶
Change the border flags
Parameters:
See also:
void QwtInterval::setInterval (double minValue, double maxValue, BorderFlags borderFlags = IncludeBorders) [inline]¶
Assign the limits of the interval
Parameters:
maxValue Maximum value
borderFlags Include/Exclude borders
void QwtInterval::setMaxValue (double maxValue) [inline]¶
Assign the upper limit of the interval
Parameters:
void QwtInterval::setMinValue (double minValue) [inline]¶
Assign the lower limit of the interval
Parameters:
QwtInterval QwtInterval::symmetrize (double value) const¶
Adjust the limit that is closer to value, so that value becomes the center of the interval.
Parameters:
Returns:
double QwtInterval::width () const [inline]¶
Return the width of an interval. The width of invalid intervals is 0.0, otherwise the result is maxValue() - minValue().
Returns:
See also:
Author¶
Generated automatically by Doxygen for Qwt User's Guide from the source code.
Wed Jan 2 2019 | Version 6.1.4 |