QGIS API Documentation 3.39.0-Master (8f4da32b6b8)
|
Base class for objects with an associated (optional) temporal range. More...
#include <qgstemporalrangeobject.h>
Public Member Functions | |
QgsTemporalRangeObject (bool enabled=false) | |
Constructor QgsTemporalRangeObject. | |
virtual | ~QgsTemporalRangeObject ()=default |
bool | isTemporal () const |
Returns true if the object's temporal range is enabled, and the object will be filtered when rendering maps with a specific time range set. | |
void | setIsTemporal (bool enabled) |
Sets whether the temporal range is enabled (i.e. | |
void | setTemporalRange (const QgsDateTimeRange &range) |
Sets the temporal range for the object. | |
const QgsDateTimeRange & | temporalRange () const |
Returns the datetime range for the object. | |
Base class for objects with an associated (optional) temporal range.
Definition at line 33 of file qgstemporalrangeobject.h.
QgsTemporalRangeObject::QgsTemporalRangeObject | ( | bool | enabled = false | ) |
Constructor QgsTemporalRangeObject.
The enabled argument specifies whether the temporal range is initially enabled or not (see isTemporal()).
Definition at line 20 of file qgstemporalrangeobject.cpp.
|
virtualdefault |
bool QgsTemporalRangeObject::isTemporal | ( | ) | const |
Returns true
if the object's temporal range is enabled, and the object will be filtered when rendering maps with a specific time range set.
For map settings, if false
is returned, then any other temporal settings relating to the map will be ignored during rendering.
Definition at line 30 of file qgstemporalrangeobject.cpp.
void QgsTemporalRangeObject::setIsTemporal | ( | bool | enabled | ) |
Sets whether the temporal range is enabled (i.e.
whether the object has a temporal range which will be considered when rendering maps with a specific time range set.)
Definition at line 25 of file qgstemporalrangeobject.cpp.
void QgsTemporalRangeObject::setTemporalRange | ( | const QgsDateTimeRange & | range | ) |
Sets the temporal range for the object.
Calling setTemporalRange() automatically enables temporal properties on the object (see isTemporal()), regardless of its existing state.
When a temporal range is set it can be used to filter and request time base objects.
Definition at line 35 of file qgstemporalrangeobject.cpp.
const QgsDateTimeRange & QgsTemporalRangeObject::temporalRange | ( | ) | const |
Returns the datetime range for the object.
This should only be considered when isTemporal() returns true
.
Definition at line 43 of file qgstemporalrangeobject.cpp.