Class: QgsRasterDataProviderTemporalCapabilities¶
- class qgis.core.QgsRasterDataProviderTemporalCapabilities¶
Bases:
QgsDataProviderTemporalCapabilities
Implementation of data provider temporal properties for
QgsRasterDataProviders
.Data provider temporal capabilities reflect the temporal capabilities of a
QgsDataProvider
. UnlikeQgsMapLayerTemporalProperties
, these settings are not user-configurable, and should only be set by theQgsDataProvider
itself.Added in version 3.14.
QgsRasterDataProviderTemporalCapabilities(enabled: bool = False) Constructor for
QgsRasterDataProviderTemporalProperties
.The
enabled
argument specifies whether the data provider has temporal capabilities.QgsRasterDataProviderTemporalCapabilities(
QgsRasterDataProviderTemporalCapabilities
)Enums
alias of
TemporalIntervalMatchMethod
Methods
Returns a list of all valid datetime ranges for which temporal data is available from the provider.
Returns the available reference datetime range, which indicates the maximum extent of datetime values available for reference temporal ranges from the provider.
Returns the overall datetime range extent from which temporal data is available from the provider.
Returns the default time step interval corresponding to the available datetime values for the provider.
Returns the capability flags for the provider.
Returns the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.
Returns the requested temporal range.
Sets a list of all valid datetime
ranges
for which temporal data is available from the provider.Sets the available reference datetime
range
.Sets the overall datetime
range
extent from which temporal data is available from the provider.Sets the default time step
interval
corresponding to the available datetime values for the provider.Sets the capability flags for the provider.
Sets the desired
method
to use when resolving a temporal interval to matching layers or bands in the data provider.- IntervalHandlingMethod¶
alias of
TemporalIntervalMatchMethod
- allAvailableTemporalRanges(self) List[QgsDateTimeRange] ¶
Returns a list of all valid datetime ranges for which temporal data is available from the provider.
As opposed to
availableTemporalRange()
, this method is useful when a provider contains a set of non-contiguous datetime ranges.See also
See also
Added in version 3.20.
- Return type:
List[QgsDateTimeRange]
- availableReferenceTemporalRange(self) QgsDateTimeRange ¶
Returns the available reference datetime range, which indicates the maximum extent of datetime values available for reference temporal ranges from the provider.
See also
- Return type:
- availableTemporalRange(self) QgsDateTimeRange ¶
Returns the overall datetime range extent from which temporal data is available from the provider.
See also
- Return type:
- defaultInterval(self) QgsInterval ¶
Returns the default time step interval corresponding to the available datetime values for the provider.
See also
Added in version 3.20.
- Return type:
- flags(self) Qgis.RasterTemporalCapabilityFlags ¶
Returns the capability flags for the provider.
Added in version 3.28.
- Return type:
- intervalHandlingMethod(self) Qgis.TemporalIntervalMatchMethod ¶
Returns the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.
See also
- Return type:
- requestedTemporalRange(self) QgsDateTimeRange ¶
Returns the requested temporal range. Intended to be used by the provider in fetching data.
- Return type:
- setAllAvailableTemporalRanges(self, ranges: Iterable[QgsDateTimeRange])¶
Sets a list of all valid datetime
ranges
for which temporal data is available from the provider.As opposed to
setAvailableTemporalRange()
, this method is useful when a provider contains a set of non-contiguous datetime ranges.See also
See also
Added in version 3.20.
- Parameters:
ranges (Iterable[QgsDateTimeRange])
- setAvailableReferenceTemporalRange(self, range: QgsDateTimeRange)¶
Sets the available reference datetime
range
. This is to be used for bi-temporal based data. Where data can have both nominal and reference times.See also
- Parameters:
range (QgsDateTimeRange)
- setAvailableTemporalRange(self, range: QgsDateTimeRange)¶
Sets the overall datetime
range
extent from which temporal data is available from the provider.See also
- Parameters:
range (QgsDateTimeRange)
- setDefaultInterval(self, interval: QgsInterval)¶
Sets the default time step
interval
corresponding to the available datetime values for the provider.See also
Added in version 3.20.
- Parameters:
interval (QgsInterval)
- setFlags(self, flags: Qgis.RasterTemporalCapabilityFlags | Qgis.RasterTemporalCapabilityFlag)¶
Sets the capability flags for the provider.
Added in version 3.28.
- Parameters:
flags (Union[Qgis.RasterTemporalCapabilityFlags)
- setIntervalHandlingMethod(self, method: Qgis.TemporalIntervalMatchMethod)¶
Sets the desired
method
to use when resolving a temporal interval to matching layers or bands in the data provider.See also
- Parameters:
method (Qgis.TemporalIntervalMatchMethod)