A template based class for storing ranges (lower to upper values). More...

#include <qgsrange.h>

Public Member Functions
	QgsRange (T lower, T upper, bool includeLower=true, bool includeUpper=true)
	Constructor for QgsRange. More...

bool	contains (const QgsRange< T > &other) const
	Returns true if this range contains another range. More...

bool	contains (T element) const
	Returns true if this range contains a specified element. More...

bool	includeLower () const
	Returns true if the lower bound is inclusive, or false if the lower bound is exclusive. More...

bool	includeUpper () const
	Returns true if the upper bound is inclusive, or false if the upper bound is exclusive. More...

bool	isEmpty () const
	Returns true if the range is empty, ie the lower bound equals (or exceeds) the upper bound and either the bounds are exclusive. More...

bool	isSingleton () const
	Returns true if the range consists only of a single value or instant. More...

T	lower () const
	Returns the lower bound of the range. More...

bool	overlaps (const QgsRange< T > &other) const
	Returns true if this range overlaps another range. More...

T	upper () const
	Returns the upper bound of the range. More...

Detailed Description

template<typename T>
class QgsRange< T >

A template based class for storing ranges (lower to upper values).

QgsRange classes represent a range of values of some element type. For instance, ranges of int might be used to represent integer ranges.

Ranges can indicate whether the upper and lower values are inclusive or exclusive. The inclusivity or exclusivity of bounds is considered when determining things like whether ranges overlap or during calculation of range intersections.

See also: QgsDoubleRange; QgsIntRange

Note: not available in Python bindings (but class provided for template-based inheritance)

Since: QGIS 3.0

Definition at line 43 of file qgsrange.h.

Constructor & Destructor Documentation

template<typename T>

QgsRange< T >::QgsRange	(	T	lower,
		T	upper,
		bool	includeLower = `true`,
		bool	includeUpper = `true`
	)

inline

Constructor for QgsRange.

The lower and upper bounds are specified, and optionally whether or not these bounds are included in the range.

Definition at line 51 of file qgsrange.h.

Member Function Documentation

template<typename T>

bool QgsRange< T >::contains ( const QgsRange< T > & other ) const

inline

Returns true if this range contains another range.

See also: overlaps()

Definition at line 105 of file qgsrange.h.

template<typename T>

bool QgsRange< T >::contains ( T element ) const

inline

Returns true if this range contains a specified element.

Definition at line 125 of file qgsrange.h.

template<typename T>

bool QgsRange< T >::includeLower ( ) const

inline

Returns true if the lower bound is inclusive, or false if the lower bound is exclusive.

See also: lower(); includeUpper()

Definition at line 78 of file qgsrange.h.

template<typename T>

bool QgsRange< T >::includeUpper ( ) const

inline

Returns true if the upper bound is inclusive, or false if the upper bound is exclusive.

See also: upper(); includeLower()

Definition at line 86 of file qgsrange.h.

template<typename T>

bool QgsRange< T >::isEmpty ( ) const

inline

Returns true if the range is empty, ie the lower bound equals (or exceeds) the upper bound and either the bounds are exclusive.

See also: isSingleton()

Definition at line 93 of file qgsrange.h.

template<typename T>

bool QgsRange< T >::isSingleton ( ) const

inline

Returns true if the range consists only of a single value or instant.

See also: isEmpty()

Definition at line 99 of file qgsrange.h.

template<typename T>

T QgsRange< T >::lower ( ) const

inline

Returns the lower bound of the range.

See also: upper(); includeLower()

Definition at line 63 of file qgsrange.h.

template<typename T>

bool QgsRange< T >::overlaps ( const QgsRange< T > & other ) const

inline

Returns true if this range overlaps another range.

See also: contains()

Definition at line 144 of file qgsrange.h.

template<typename T>

T QgsRange< T >::upper ( ) const

inline

Returns the upper bound of the range.

See also: lower(); includeUpper()

Definition at line 70 of file qgsrange.h.

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

/build/qgis-3.4.15+24xenial/src/core/qgsrange.h

Public Member Functions

Detailed Description

template<typename T> class QgsRange< T >

Constructor & Destructor Documentation

Member Function Documentation

template<typename T>
class QgsRange< T >