Subgroup: Date

Class: QgsDateTimeRange

class qgis.core.QgsDateTimeRange

Bases: sip.wrapper

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.

New in version 3.0.

See also

QgsDateRange

Note

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

Methods

begin	Returns the beginning of the range.
contains	Returns true if this range contains another range.
end	Returns the upper bound of the range.
includeBeginning	Returns true if the beginning is inclusive, or false if the beginning is exclusive.
includeEnd	Returns true if the end is inclusive, or false if the end is exclusive.
isEmpty	Returns true if the range is empty, ie the beginning equals (or exceeds) the end and either of the bounds are exclusive.
isInfinite	Returns true if the range consists of all possible values.
isInstant	Returns true if the range consists only of a single instant.
overlaps	Returns true if this range overlaps another range.

Attributes

begin(self) → QDateTime

Returns the beginning of the range.

See also

end()

See also

includeBeginning()

contains(self, other: QgsDateTimeRange) → bool

Returns true if this range contains another range.

contains(self, element: Union[QDateTime, datetime.datetime]) -> bool Returns true if this range contains a specified element.

end(self) → QDateTime

Returns the upper bound of the range.

See also

begin()

See also

includeEnd()

includeBeginning(self) → bool

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

See also

begin()

See also

includeEnd()

includeEnd(self) → bool

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

See also

end()

See also

includeBeginning()

isEmpty(self) → bool

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.

isInfinite(self) → bool

Returns true if the range consists of all possible values.

See also

isEmpty()

See also

isInstant()

isInstant(self) → bool

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

See also

isEmpty()

See also

isInfinite()

overlaps(self, other: QgsDateTimeRange) → bool

Returns true if this range overlaps another range.