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. Unlike QgsMapLayerTemporalProperties, these settings are not user-configurable, and should only be set by the QgsDataProvider itself.

New in version 3.14.

QgsRasterDataProviderTemporalCapabilities(enabled: bool = False) Constructor for QgsRasterDataProviderTemporalProperties.

The enabled argument specifies whether the data provider has temporal capabilities.

QgsRasterDataProviderTemporalCapabilities(QgsRasterDataProviderTemporalCapabilities)

Methods

allAvailableTemporalRanges

Returns a list of all valid datetime ranges for which temporal data is available from the provider.

availableReferenceTemporalRange

Returns the available reference datetime range, which indicates the maximum extent of datetime values available for reference temporal ranges from the provider.

availableTemporalRange

Returns the overall datetime range extent from which temporal data is available from the provider.

defaultInterval

Returns the default time step interval corresponding to the available datetime values for the provider.

intervalHandlingMethod

Returns the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.

requestedTemporalRange

Returns the requested temporal range.

setAllAvailableTemporalRanges

Sets a list of all valid datetime ranges for which temporal data is available from the provider.

setAvailableReferenceTemporalRange

Sets the available reference datetime range.

setAvailableTemporalRange

Sets the overall datetime range extent from which temporal data is available from the provider.

setDefaultInterval

Sets the default time step interval corresponding to the available datetime values for the provider.

setIntervalHandlingMethod

Sets the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.

Attributes

FindClosestMatchToEndOfRange

FindClosestMatchToStartOfRange

MatchExactUsingEndOfRange

MatchExactUsingStartOfRange

MatchUsingWholeRange

FindClosestMatchToEndOfRange = 4
FindClosestMatchToStartOfRange = 3
class IntervalHandlingMethod

Bases: int

MatchExactUsingEndOfRange = 2
MatchExactUsingStartOfRange = 1
MatchUsingWholeRange = 0
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.

New 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.

Return type

QgsDateTimeRange

availableTemporalRange(self)QgsDateTimeRange

Returns the overall datetime range extent from which temporal data is available from the provider.

Return type

QgsDateTimeRange

defaultInterval(self)QgsInterval

Returns the default time step interval corresponding to the available datetime values for the provider.

New in version 3.20.

Return type

QgsInterval

intervalHandlingMethod(self)QgsRasterDataProviderTemporalCapabilities.IntervalHandlingMethod

Returns the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.

Return type

QgsRasterDataProviderTemporalCapabilities.IntervalHandlingMethod

requestedTemporalRange(self)QgsDateTimeRange

Returns the requested temporal range. Intended to be used by the provider in fetching data.

Return type

QgsDateTimeRange

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.

New 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.

Parameters

range (QgsDateTimeRange) –

setAvailableTemporalRange(self, range: QgsDateTimeRange)

Sets the overall datetime range extent from which temporal data is available from the provider.

Parameters

range (QgsDateTimeRange) –

setDefaultInterval(self, interval: QgsInterval)

Sets the default time step interval corresponding to the available datetime values for the provider.

New in version 3.20.

Parameters

interval (QgsInterval) –

setIntervalHandlingMethod(self, method: QgsRasterDataProviderTemporalCapabilities.IntervalHandlingMethod)

Sets the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.

Parameters

method (QgsRasterDataProviderTemporalCapabilities.IntervalHandlingMethod) –