A class representing an interval. More...

#include <qwt_interval.h>

Public Types
enum	BorderFlag { IncludeBorders = 0x00 , ExcludeMinimum = 0x01 , ExcludeMaximum = 0x02 , ExcludeBorders = ExcludeMinimum \| ExcludeMaximum }
	Flag indicating if a border is included or excluded. More...

Public Member Functions
	QwtInterval ()
	Border flags.

	QwtInterval (double minValue, double maxValue, BorderFlags=IncludeBorders)
	Constructor.

void	setInterval (double minValue, double maxValue, BorderFlags=IncludeBorders)
	Assign the limits of the interval.

QwtInterval	normalized () const
	Normalize the limits of the interval.

QwtInterval	inverted () const
	Invert the limits of the interval.

QwtInterval	limited (double lowerBound, double upperBound) const
	Limit the interval, keeping the border modes.

bool	operator== (const QwtInterval &) const
	Compare two intervals.

bool	operator!= (const QwtInterval &) const
	Compare two intervals.

void	setBorderFlags (BorderFlags)
	Change the border flags.

BorderFlags	borderFlags () const

double	minValue () const

double	maxValue () const

double	centerValue () const

double	width () const
	Return the width of an interval.

long double	widthL () const
	Return the width of an interval as long double.

void	setMinValue (double)
	Assign the lower limit of the interval.

void	setMaxValue (double)
	Assign the upper limit of the interval.

bool	contains (double value) const
	Test if a value is inside an interval.

bool	contains (const QwtInterval &) const
	Test if an interval is inside an interval.

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
	Union of two intervals.

QwtInterval	operator& (const QwtInterval &) const
	Intersection of two intervals.

QwtInterval &	operator\|= (const QwtInterval &)
	Unite this interval with the given interval.

QwtInterval &	operator&= (const QwtInterval &)
	Intersect this interval with the given interval.

QwtInterval	extend (double value) const
	Extend the interval.

QwtInterval	operator\| (double) const
	Extend an interval.

QwtInterval &	operator\|= (double)
	Extend an interval.

bool	isValid () const
	A interval is valid when minValue() <= maxValue().

bool	isNull () const

void	invalidate ()
	Invalidate the interval.

QwtInterval	symmetrize (double value) const
	Adjust the limit that is closer to value, so that value becomes the center of the interval.

Detailed Description

A class representing an interval.

The interval is represented by 2 doubles, the lower and the upper limit.

Member Enumeration Documentation

◆ BorderFlag

enum QwtInterval::BorderFlag

Flag indicating if a border is included or excluded.

See also: setBorderFlags(), borderFlags()

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() [1/2]

QwtInterval::QwtInterval ( )

inline

Border flags.

Default Constructor.

Creates an invalid interval [0.0, -1.0]

See also: setInterval(), isValid()

◆ QwtInterval() [2/2]

QwtInterval::QwtInterval	(	double	minValue,
		double	maxValue,
		BorderFlags	borderFlags = `IncludeBorders`
	)

inline

Constructor.

Build an interval with from min/max values

Parameters

minValue	Minimum value
maxValue	Maximum value
borderFlags	Include/Exclude borders

Member Function Documentation

◆ borderFlags()

QwtInterval::BorderFlags QwtInterval::borderFlags ( ) const

inline

Returns: Border flags

See also: setBorderFlags()

◆ centerValue()

double QwtInterval::centerValue ( ) const

inline

Returns: center the interval

◆ contains() [1/2]

bool QwtInterval::contains ( const QwtInterval & interval ) const

Test if an interval is inside an interval.

Parameters

interval Interval

Returns: true, if interval lies inside the boundaries

◆ contains() [2/2]

bool QwtInterval::contains ( double value ) const

Test if a value is inside an interval.

Parameters

value Value

Returns: true, if value lies inside the boundaries

◆ extend()

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

value Value

Returns: extended interval

See also: isValid()

◆ intersect()

QwtInterval QwtInterval::intersect ( const QwtInterval & other ) const

Intersect 2 intervals.

Parameters

other Interval to be intersect with

Returns: Intersection

◆ intersects()

bool QwtInterval::intersects ( const QwtInterval & other ) const

Test if two intervals overlap.

Parameters

other Interval

Returns: True, when the intervals are intersecting

◆ invalidate()

void QwtInterval::invalidate ( )

inline

Invalidate the interval.

The limits are set to interval [0.0, -1.0]

See also: isValid()

◆ inverted()

QwtInterval QwtInterval::inverted ( ) const

Invert the limits of the interval.

Returns: Inverted interval

See also: normalized()

◆ isNull()

bool QwtInterval::isNull ( ) const

inline

Returns: true, if isValid() && (minValue() >= maxValue())

◆ isValid()

bool QwtInterval::isValid ( ) const

inline

A interval is valid when minValue() <= maxValue().

In case of QwtInterval::ExcludeBorders it is true when minValue() < maxValue()

Returns: True, when the interval is valid

◆ limited()

QwtInterval QwtInterval::limited	(	double	lowerBound,
		double	upperBound
	)		const

Limit the interval, keeping the border modes.

Parameters

lowerBound	Lower limit
upperBound	Upper limit

Returns: Limited interval

◆ maxValue()

double QwtInterval::maxValue ( ) const

inline

Returns: Upper limit of the interval

◆ minValue()

double QwtInterval::minValue ( ) const

inline

Returns: Lower limit of the interval

◆ normalized()

QwtInterval QwtInterval::normalized ( ) const

Normalize the limits of the interval.

If maxValue() < minValue() the limits will be inverted.

Returns: Normalized interval

See also: isValid(), inverted()

◆ operator!=()

bool QwtInterval::operator!= ( const QwtInterval & other ) const

inline

Compare two intervals.

Parameters

other Interval to compare with

Returns: True, when this and other are not equal

◆ operator&()

QwtInterval QwtInterval::operator& ( const QwtInterval & other ) const

inline

Intersection of two intervals.

Parameters

other Interval to intersect with

Returns: Intersection of this and other

See also: intersect()

◆ operator&=()

QwtInterval & QwtInterval::operator&= ( const QwtInterval & other )

Intersect this interval with the given interval.

Parameters

other Interval to be intersected with

Returns: This interval

◆ operator==()

bool QwtInterval::operator== ( const QwtInterval & other ) const

inline

Compare two intervals.

Parameters

other Interval to compare with

Returns: True, when this and other are equal

◆ operator|() [1/2]

QwtInterval QwtInterval::operator| ( const QwtInterval & other ) const

inline

Union of two intervals.

Parameters

other Interval to unite with

Returns: Union of this and other

See also: unite()

◆ operator|() [2/2]

QwtInterval QwtInterval::operator| ( double value ) const

inline

Extend an interval.

Parameters

value Value

Returns: Extended interval

See also: extend()

◆ operator|=() [1/2]

QwtInterval & QwtInterval::operator|= ( const QwtInterval & other )

Unite this interval with the given interval.

Parameters

other Interval to be united with

Returns: This interval

◆ operator|=() [2/2]

QwtInterval & QwtInterval::operator|= ( double value )

Extend an interval.

Parameters

value Value

Returns: Reference of the extended interval

See also: extend()

◆ setBorderFlags()

void QwtInterval::setBorderFlags ( BorderFlags borderFlags )

inline

Change the border flags.

Parameters

borderFlags Or'd BorderMode flags

See also: borderFlags()

◆ setInterval()

void QwtInterval::setInterval	(	double	minValue,
		double	maxValue,
		BorderFlags	borderFlags = `IncludeBorders`
	)

inline

Assign the limits of the interval.

Parameters

minValue	Minimum value
maxValue	Maximum value
borderFlags	Include/Exclude borders

◆ setMaxValue()

void QwtInterval::setMaxValue ( double maxValue )

inline

Assign the upper limit of the interval.

Parameters

maxValue Maximum value

◆ setMinValue()

void QwtInterval::setMinValue ( double minValue )

inline

Assign the lower limit of the interval.

Parameters

minValue Minimum value

◆ symmetrize()

QwtInterval QwtInterval::symmetrize ( double value ) const

Adjust the limit that is closer to value, so that value becomes the center of the interval.

Parameters

value Center

Returns: Interval with value as center

◆ width()

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: Interval width

See also: isValid()

◆ widthL()

long double QwtInterval::widthL ( ) const

inline

Return the width of an interval as long double.

The width of invalid intervals is 0.0, otherwise the result is maxValue() - minValue().

Returns: Interval width

See also: isValid()

The documentation for this class was generated from the following files:

/home/runner/work/QWT/QWT/src/qwt_interval.h
/home/runner/work/QWT/QWT/src/qwt_interval.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ BorderFlag

Constructor & Destructor Documentation

◆ QwtInterval() [1/2]

◆ QwtInterval() [2/2]

Member Function Documentation

◆ borderFlags()

◆ centerValue()

◆ contains() [1/2]

◆ contains() [2/2]

◆ extend()

◆ intersect()

◆ intersects()

◆ invalidate()

◆ inverted()

◆ isNull()

◆ isValid()

◆ limited()

◆ maxValue()

◆ minValue()

◆ normalized()

◆ operator!=()

◆ operator&()

◆ operator&=()

◆ operator==()

◆ operator|() [1/2]

◆ operator|() [2/2]

◆ operator|=() [1/2]

◆ operator|=() [2/2]

◆ setBorderFlags()

◆ setInterval()

◆ setMaxValue()

◆ setMinValue()

◆ symmetrize()

◆ width()

◆ widthL()