QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | List of all members
QgsIntRange Class Reference

QgsRange which stores a range of integer values. More...

#include <qgsrange.h>

Inheritance diagram for QgsIntRange:
Inheritance graph
[legend]

Public Member Functions

 QgsIntRange (int lower=std::numeric_limits< int >::lowest(), int upper=std::numeric_limits< int >::max(), bool includeLower=true, bool includeUpper=true)
 Constructor for QgsIntRange. More...
 
bool isInfinite () const
 Returns true if the range consists of all possible values. More...
 
- Public Member Functions inherited from QgsRange< int >
 QgsRange (int lower, int upper, bool includeLower=true, bool includeUpper=true)
 Constructor for QgsRange. More...
 
bool contains (const QgsRange< int > &other) const
 Returns true if this range contains another range. More...
 
bool contains (int 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...
 
int lower () const
 Returns the lower bound of the range. More...
 
bool operator!= (const QgsRange< int > &other) const
 
bool operator== (const QgsRange< int > &other) const
 
bool overlaps (const QgsRange< int > &other) const
 Returns true if this range overlaps another range. More...
 
int upper () const
 Returns the upper bound of the range. More...
 

Additional Inherited Members

- Protected Attributes inherited from QgsRange< int >
bool mIncludeLower
 
bool mIncludeUpper
 
int mLower
 
int mUpper
 

Detailed Description

QgsRange which stores a range of integer values.

See also
QgsDoubleRange
QgsDateRange
QgsDateTimeRange
Since
QGIS 3.0

Definition at line 287 of file qgsrange.h.

Constructor & Destructor Documentation

◆ QgsIntRange()

QgsIntRange::QgsIntRange ( int  lower = std::numeric_limits< int >::lowest(),
int  upper = std::numeric_limits< int >::max(),
bool  includeLower = true,
bool  includeUpper = true 
)
inline

Constructor for QgsIntRange.

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

The default values for lower and upper construct an infinite range (see isInfinite()).

Since
QGIS 3.18

Definition at line 301 of file qgsrange.h.

Member Function Documentation

◆ isInfinite()

bool QgsIntRange::isInfinite ( ) const
inline

Returns true if the range consists of all possible values.

Since
QGIS 3.18

Definition at line 332 of file qgsrange.h.


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