Class: QgsRasterDataProviderTemporalCapabilities

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.

Added in version 3.14.

Class Hierarchy

Base classes

QgsDataProviderTemporalCapabilities

Base class for handling properties relating to a data provider’s temporal capabilities.

Enums

IntervalHandlingMethod

alias of TemporalIntervalMatchMethod

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.
flags	Returns the capability flags 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.
setFlags	Sets the capability flags for the provider.
setIntervalHandlingMethod	Sets the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.

class qgis.core.QgsRasterDataProviderTemporalCapabilities

Bases: QgsDataProviderTemporalCapabilities

__init__(enabled: bool = False)

Constructor for QgsRasterDataProviderTemporalProperties.

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

Parameters:

enabled (bool = False)

__init__(a0: QgsRasterDataProviderTemporalCapabilities)

Parameters:

a0 (QgsRasterDataProviderTemporalCapabilities)

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

setAllAvailableTemporalRanges()

See also

availableTemporalRange()

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

setAvailableReferenceTemporalRange()

Return type:

QgsDateTimeRange

availableTemporalRange(self) → QgsDateTimeRange

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

See also

setAvailableTemporalRange()

Return type:

QgsDateTimeRange

defaultInterval(self) → QgsInterval

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

See also

setDefaultInterval()

Added in version 3.20.

Return type:

QgsInterval

flags(self) → Qgis.RasterTemporalCapabilityFlags

Returns the capability flags for the provider.

Added in version 3.28.

Return type:

Qgis.RasterTemporalCapabilityFlags

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

setIntervalHandlingMethod()

Return type:

Qgis.TemporalIntervalMatchMethod

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.

See also

allAvailableTemporalRanges()

See also

setAvailableTemporalRange()

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

availableReferenceTemporalRange()

Parameters:

range (QgsDateTimeRange)

setAvailableTemporalRange(self, range: QgsDateTimeRange)

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

See also

availableTemporalRange()

Parameters:

range (QgsDateTimeRange)

setDefaultInterval(self, interval: QgsInterval)

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

See also

defaultInterval()

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, Qgis.RasterTemporalCapabilityFlag])

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

intervalHandlingMethod()

Parameters:

method (Qgis.TemporalIntervalMatchMethod)