Implementation of data provider temporal properties for QgsRasterDataProviders. More...

#include <qgsrasterdataprovidertemporalcapabilities.h>

Inheritance diagram for QgsRasterDataProviderTemporalCapabilities:

Public Types
enum	IntervalHandlingMethod { MatchUsingWholeRange , MatchExactUsingStartOfRange , MatchExactUsingEndOfRange , FindClosestMatchToStartOfRange , FindClosestMatchToEndOfRange }
	Method to use when resolving a temporal range to a data provider layer or band. More...

Public Member Functions
	QgsRasterDataProviderTemporalCapabilities (bool enabled=false)
	Constructor for QgsRasterDataProviderTemporalProperties. More...

QList< QgsDateTimeRange >	allAvailableTemporalRanges () const
	Returns a list of all valid datetime ranges for which temporal data is available from the provider. More...

const QgsDateTimeRange &	availableReferenceTemporalRange () const
	Returns the available reference datetime range, which indicates the maximum extent of datetime values available for reference temporal ranges from the provider. More...

const QgsDateTimeRange &	availableTemporalRange () const
	Returns the overall datetime range extent from which temporal data is available from the provider. More...

QgsInterval	defaultInterval () const
	Returns the default time step interval corresponding to the available datetime values for the provider. More...

IntervalHandlingMethod	intervalHandlingMethod () const
	Returns the desired method to use when resolving a temporal interval to matching layers or bands in the data provider. More...

const QgsDateTimeRange &	requestedTemporalRange () const
	Returns the requested temporal range. More...

void	setAllAvailableTemporalRanges (const QList< QgsDateTimeRange > &ranges)
	Sets a list of all valid datetime ranges for which temporal data is available from the provider. More...

void	setAvailableReferenceTemporalRange (const QgsDateTimeRange &range)
	Sets the available reference datetime range. More...

void	setAvailableTemporalRange (const QgsDateTimeRange &range)
	Sets the overall datetime range extent from which temporal data is available from the provider. More...

void	setDefaultInterval (const QgsInterval &interval)
	Sets the default time step interval corresponding to the available datetime values for the provider. More...

void	setIntervalHandlingMethod (IntervalHandlingMethod method)
	Sets the desired method to use when resolving a temporal interval to matching layers or bands in the data provider. More...

void	setRequestedTemporalRange (const QgsDateTimeRange &range)
	Sets the requested temporal range to retrieve when returning data from the associated data provider. More...

Public Member Functions inherited from QgsDataProviderTemporalCapabilities
	QgsDataProviderTemporalCapabilities (bool available=false)
	Constructor for QgsDataProviderTemporalCapabilities. More...

virtual	~QgsDataProviderTemporalCapabilities ()=default

bool	hasTemporalCapabilities () const
	Returns `true` if the provider has temporal capabilities available. More...

void	setHasTemporalCapabilities (bool available)
	Sets whether the provider has temporal capabilities available. More...

Friends
class	QgsRasterLayerRenderer

class	TestQgsRasterDataProviderTemporalCapabilities

Detailed Description

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.

Since: QGIS 3.14

Definition at line 38 of file qgsrasterdataprovidertemporalcapabilities.h.

Member Enumeration Documentation

◆ IntervalHandlingMethod

enum QgsRasterDataProviderTemporalCapabilities::IntervalHandlingMethod

Method to use when resolving a temporal range to a data provider layer or band.

Enumerator
MatchUsingWholeRange	Use an exact match to the whole temporal range.
MatchExactUsingStartOfRange	Match the start of the temporal range to a corresponding layer or band, and only use exact matching results.
MatchExactUsingEndOfRange	Match the end of the temporal range to a corresponding layer or band, and only use exact matching results.
FindClosestMatchToStartOfRange	Match the start of the temporal range to the least previous closest datetime.
FindClosestMatchToEndOfRange	Match the end of the temporal range to the least previous closest datetime.

Definition at line 52 of file qgsrasterdataprovidertemporalcapabilities.h.

Constructor & Destructor Documentation

◆ QgsRasterDataProviderTemporalCapabilities()

QgsRasterDataProviderTemporalCapabilities::QgsRasterDataProviderTemporalCapabilities ( bool enabled = false )

Constructor for QgsRasterDataProviderTemporalProperties.

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

Definition at line 20 of file qgsrasterdataprovidertemporalcapabilities.cpp.

Member Function Documentation

◆ allAvailableTemporalRanges()

QList< QgsDateTimeRange > QgsRasterDataProviderTemporalCapabilities::allAvailableTemporalRanges ( ) const

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(); availableTemporalRange()

Since: QGIS 3.20

Definition at line 43 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ availableReferenceTemporalRange()

const QgsDateTimeRange & QgsRasterDataProviderTemporalCapabilities::availableReferenceTemporalRange ( ) const

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()

Definition at line 56 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ availableTemporalRange()

const QgsDateTimeRange & QgsRasterDataProviderTemporalCapabilities::availableTemporalRange ( ) const

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

See also: setAvailableTemporalRange()

Definition at line 33 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ defaultInterval()

QgsInterval QgsRasterDataProviderTemporalCapabilities::defaultInterval ( ) const

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

See also: setDefaultInterval()

Since: QGIS 3.20

Definition at line 66 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ intervalHandlingMethod()

QgsRasterDataProviderTemporalCapabilities::IntervalHandlingMethod QgsRasterDataProviderTemporalCapabilities::intervalHandlingMethod ( ) const

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

See also: setIntervalHandlingMethod()

Definition at line 81 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ requestedTemporalRange()

const QgsDateTimeRange & QgsRasterDataProviderTemporalCapabilities::requestedTemporalRange ( ) const

Returns the requested temporal range.

Intended to be used by the provider in fetching data.

Definition at line 76 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ setAllAvailableTemporalRanges()

void QgsRasterDataProviderTemporalCapabilities::setAllAvailableTemporalRanges ( const QList< QgsDateTimeRange > & ranges )

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(); setAvailableTemporalRange()

Since: QGIS 3.20

Definition at line 38 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ setAvailableReferenceTemporalRange()

void QgsRasterDataProviderTemporalCapabilities::setAvailableReferenceTemporalRange ( const QgsDateTimeRange & range )

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()

Definition at line 48 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ setAvailableTemporalRange()

void QgsRasterDataProviderTemporalCapabilities::setAvailableTemporalRange ( const QgsDateTimeRange & range )

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

See also: availableTemporalRange()

Definition at line 25 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ setDefaultInterval()

void QgsRasterDataProviderTemporalCapabilities::setDefaultInterval ( const QgsInterval & interval )

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

See also: defaultInterval()

Since: QGIS 3.20

Definition at line 71 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ setIntervalHandlingMethod()

void QgsRasterDataProviderTemporalCapabilities::setIntervalHandlingMethod ( IntervalHandlingMethod method )

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

See also: intervalHandlingMethod()

Definition at line 86 of file qgsrasterdataprovidertemporalcapabilities.cpp.

◆ setRequestedTemporalRange()

void QgsRasterDataProviderTemporalCapabilities::setRequestedTemporalRange ( const QgsDateTimeRange & range )

Sets the requested temporal range to retrieve when returning data from the associated data provider.

Note: this is not normally manually set, and is intended for use by QgsRasterLayerRenderer to automatically set the requested temporal range on a clone of the data provider during a render job.

See also: requestedTemporalRange()

Definition at line 61 of file qgsrasterdataprovidertemporalcapabilities.cpp.

Friends And Related Function Documentation

◆ QgsRasterLayerRenderer

friend class QgsRasterLayerRenderer

friend

Definition at line 199 of file qgsrasterdataprovidertemporalcapabilities.h.

◆ TestQgsRasterDataProviderTemporalCapabilities

friend class TestQgsRasterDataProviderTemporalCapabilities