Class: QgsDateTimeRange¶
-
class
qgis.core.
QgsDateTimeRange
(begin: Union[QDateTime, datetime.datetime], end: Union[QDateTime, datetime.datetime], includeBeginning: bool = True, includeEnd: bool = True)¶ Bases:
sip.wrapper
Constructor for
QgsTemporalRange
. Thebegin
andend
are specified, and optionally whether or not these bounds are included in the range.Note
in Python
begin
andend
must be provided.QgsDateTimeRange(
QgsDateTimeRange
)QgsRange
which stores a range of date times.Invalid QDateTimes as the beginning or end are permitted. In this case, the bound is considered to be infinite. E.g. QgsDateTimeRange(QDateTime(),QDateTime(2017,1,1)) is treated as a range containing all dates before 2017-1-1. QgsDateTimeRange(QDateTime(2017,1,1),QDateTime()) is treated as a range containing all dates after 2017-1-1.
See also
New in version 3.0.
- Parameters
begin (Union[QDateTime) –
end (Union[QDateTime) –
includeBeginning (bool = True) –
includeEnd –
-
begin
(self) → QDateTime¶ Returns the beginning of the range.
See also
See also
- Return type
QDateTime
-
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
.- Parameters
other (QgsDateTimeRange) –
- Return type
bool
-
end
(self) → QDateTime¶ Returns the upper bound of the range.
See also
See also
- Return type
QDateTime
-
includeBeginning
(self) → bool¶ Returns true if the beginning is inclusive, or false if the beginning is exclusive.
See also
See also
- Return type
bool
-
includeEnd
(self) → bool¶ Returns true if the end is inclusive, or false if the end is exclusive.
See also
See also
- Return type
bool
-
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.
- Return type
bool
-
isInfinite
(self) → bool¶ Returns true if the range consists of all possible values.
See also
See also
- Return type
bool
-
isInstant
(self) → bool¶ Returns true if the range consists only of a single instant.
See also
See also
- Return type
bool
-
overlaps
(self, other: QgsDateTimeRange) → bool¶ Returns true if this range overlaps another range.
- Parameters
other (QgsDateTimeRange) –
- Return type
bool