A template based class for storing temporal ranges (beginning to end values). More...

#include <qgsrange.h>

Public Member Functions
	QgsTemporalRange (const T &begin=T(), const T &end=T(), bool includeBeginning=true, bool includeEnd=true)
	Constructor for QgsTemporalRange. More...

T	begin () const
	Returns the beginning of the range. More...

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

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

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

bool	includeBeginning () const
	Returns true if the beginning is inclusive, or false if the beginning is exclusive. More...

bool	includeEnd () const
	Returns true if the end is inclusive, or false if the end is exclusive. More...

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

bool	isInfinite () const
	Returns true if the range consists of all possible values. More...

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

bool	operator== (const QgsTemporalRange< T > &other) const

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

Detailed Description

template<typename T>
class QgsTemporalRange< T >

A template based class for storing temporal ranges (beginning to end values).

QgsTemporalRange classes represent a range of values of some temporal type. For instance, ranges of QDateTime might be used to represent datetime 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: QgsDateRange

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

Since: QGIS 3.0

Definition at line 218 of file qgsrange.h.

Constructor & Destructor Documentation

template<typename T>

QgsTemporalRange< T >::QgsTemporalRange	(	const T &	begin = `T()`,
		const T &	end = `T()`,
		bool	includeBeginning = `true`,
		bool	includeEnd = `true`
	)

inline

Constructor for QgsTemporalRange.

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

Note: in Python begin and end must be provided.

Definition at line 228 of file qgsrange.h.

Member Function Documentation

template<typename T>

T QgsTemporalRange< T >::begin ( ) const

inline

Returns the beginning of the range.

See also: end(); includeBeginning()

Definition at line 244 of file qgsrange.h.

template<typename T>

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

inline

Returns true if this range contains another range.

Definition at line 310 of file qgsrange.h.

template<typename T>

bool QgsTemporalRange< T >::contains ( const T & element ) const

inline

Returns true if this range contains a specified element.

Definition at line 342 of file qgsrange.h.

template<typename T>

T QgsTemporalRange< T >::end ( ) const

inline

Returns the upper bound of the range.

See also: begin(); includeEnd()

Definition at line 251 of file qgsrange.h.

template<typename T>

bool QgsTemporalRange< T >::includeBeginning ( ) const

inline

Returns true if the beginning is inclusive, or false if the beginning is exclusive.

See also: begin(); includeEnd()

Definition at line 259 of file qgsrange.h.

template<typename T>

bool QgsTemporalRange< T >::includeEnd ( ) const

inline

Returns true if the end is inclusive, or false if the end is exclusive.

See also: end(); includeBeginning()

Definition at line 266 of file qgsrange.h.

template<typename T>

bool QgsTemporalRange< T >::isEmpty ( ) const

inline

Returns true if the range is empty, ie the beginning equals (or exceeds) the end and either of the bounds are exclusive.

A range with both invalid beginning and end is considered infinite and not empty.

Definition at line 290 of file qgsrange.h.

template<typename T>

bool QgsTemporalRange< T >::isInfinite ( ) const

inline

Returns true if the range consists of all possible values.

See also: isEmpty(); isInstant()

Definition at line 280 of file qgsrange.h.

template<typename T>

bool QgsTemporalRange< T >::isInstant ( ) const

inline

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

See also: isEmpty(); isInfinite()

Definition at line 273 of file qgsrange.h.

template<typename T>

bool QgsTemporalRange< T >::operator== ( const QgsTemporalRange< T > & other ) const

inline

Definition at line 396 of file qgsrange.h.

template<typename T>

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

inline

Returns true if this range overlaps another range.

Definition at line 369 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 QgsTemporalRange< T >

Constructor & Destructor Documentation

Member Function Documentation

template<typename T>
class QgsTemporalRange< T >