Implementation of map layer temporal properties for vector layers. More...

#include <qgsvectorlayertemporalproperties.h>

Inheritance diagram for QgsVectorLayerTemporalProperties:

Public Types
enum	TemporalMode { ModeFixedTemporalRange = 0, ModeFeatureDateTimeInstantFromField, ModeFeatureDateTimeStartAndEndFromFields, ModeFeatureDateTimeStartAndDurationFromFields, ModeFeatureDateTimeStartAndEndFromExpressions, ModeRedrawLayerOnly }
	Mode of the vector temporal properties. More...

Public Types inherited from QgsTemporalProperty
enum	Flag { FlagDontInvalidateCachedRendersWhenRangeChanges = 1 }
	Flags attached to the temporal property. More...

Public Member Functions
	QgsVectorLayerTemporalProperties (QObject *parent=nullptr, bool enabled=false)
	Constructor for QgsVectorLayerTemporalProperties, with the specified parent object. More...

bool	accumulateFeatures () const
	Returns `true` if features will be accumulated over time (i.e. More...

QgsDateTimeRange	calculateTemporalExtent (QgsMapLayer *layer) const override
	Attempts to calculate the overall temporal extent for the specified layer, using the settings defined by the temporal properties object. More...

QString	createFilterString (const QgsVectorLayerTemporalContext &context, const QgsDateTimeRange &range) const
	Creates a QGIS expression filter string for filtering features within the specified context to those within the specified time range. More...

QString	durationField () const
	Returns the name of the duration field, which contains the duration of the event. More...

QgsUnitTypes::TemporalUnit	durationUnits () const
	Returns the units of the event's duration. More...

QString	endExpression () const
	Returns the expression for the end time for the feature's time spans. More...

QString	endField () const
	Returns the name of the end datetime field, which contains the end time for the feature's time spans. More...

double	fixedDuration () const
	Returns the fixed duration length, which contains the duration of the event. More...

const QgsDateTimeRange &	fixedTemporalRange () const
	Returns the fixed temporal range for the layer. More...

QgsTemporalProperty::Flags	flags () const override
	Returns flags associated to the temporal property. More...

void	guessDefaultsFromFields (const QgsFields &fields)
	Attempts to setup the temporal properties by scanning a set of fields and looking for standard naming conventions (e.g. More...

bool	isVisibleInTemporalRange (const QgsDateTimeRange &range) const override
	Returns `true` if the layer should be visible and rendered for the specified time range. More...

TemporalMode	mode () const
	Returns the temporal properties mode. More...

bool	readXml (const QDomElement &element, const QgsReadWriteContext &context) override
	Reads temporal properties from a DOM element previously written by writeXml(). More...

void	setAccumulateFeatures (bool accumulate)
	Sets whether features will be accumulated over time (i.e. More...

void	setDefaultsFromDataProviderTemporalCapabilities (const QgsDataProviderTemporalCapabilities *capabilities) override
	Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities. More...

void	setDurationField (const QString &field)
	Sets the name of the duration field, which contains the duration of the event. More...

void	setDurationUnits (QgsUnitTypes::TemporalUnit units)
	Sets the units of the event's duration. More...

void	setEndExpression (const QString &endExpression)
	Sets the expression to use for the end time for the feature's time spans. More...

void	setEndField (const QString &field)
	Sets the name of the end datetime field, which contains the end time for the feature's time spans. More...

void	setFixedDuration (double duration)
	Sets the fixed event duration, which contains the duration of the event. More...

void	setFixedTemporalRange (const QgsDateTimeRange &range)
	Sets a temporal range to apply to the whole layer. More...

void	setMode (TemporalMode mode)
	Sets the temporal properties mode. More...

void	setStartExpression (const QString &expression)
	Sets the expression to use for the start time for the feature's time spans. More...

void	setStartField (const QString &field)
	Sets the name of the start datetime field, which contains the start time for the feature's time spans. More...

QString	startExpression () const
	Returns the expression for the start time for the feature's time spans. More...

QString	startField () const
	Returns the name of the start datetime field, which contains the start time for the feature's time spans. More...

QDomElement	writeXml (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override
	Writes the properties to a DOM element, to be used later with readXml(). More...

Public Member Functions inherited from QgsMapLayerTemporalProperties
	QgsMapLayerTemporalProperties (QObject *parent, bool enabled=false)
	Constructor for QgsMapLayerTemporalProperties, with the specified parent object. More...

Public Member Functions inherited from QgsTemporalProperty
	QgsTemporalProperty (QObject *parent=nullptr, bool enabled=false)
	Constructor for QgsTemporalProperty, with the specified parent object. More...

bool	isActive () const
	Returns `true` if the temporal property is active. More...

void	setIsActive (bool active)
	Sets whether the temporal property is active. More...

Additional Inherited Members
Signals inherited from QgsTemporalProperty
void	changed ()
	Emitted when the temporal properties have changed. More...

Detailed Description

Implementation of map layer temporal properties for vector layers.

Since: QGIS 3.14

Definition at line 70 of file qgsvectorlayertemporalproperties.h.

Member Enumeration Documentation

◆ TemporalMode

enum QgsVectorLayerTemporalProperties::TemporalMode

Mode of the vector temporal properties.

Enumerator
ModeFixedTemporalRange	Mode when temporal properties have fixed start and end datetimes.
ModeFeatureDateTimeInstantFromField	Mode when features have a datetime instant taken from a single field.
ModeFeatureDateTimeStartAndEndFromFields	Mode when features have separate fields for start and end times.
ModeFeatureDateTimeStartAndDurationFromFields	Mode when features have a field for start time and a field for event duration.
ModeFeatureDateTimeStartAndEndFromExpressions	Mode when features use expressions for start and end times.
ModeRedrawLayerOnly	Redraw the layer when temporal range changes, but don't apply any filtering. Useful when symbology or rule based renderer expressions depend on the time range.

Definition at line 89 of file qgsvectorlayertemporalproperties.h.

Constructor & Destructor Documentation

◆ QgsVectorLayerTemporalProperties()

QgsVectorLayerTemporalProperties::QgsVectorLayerTemporalProperties	(	QObject *	parent = `nullptr`,
		bool	enabled = `false`
	)

Constructor for QgsVectorLayerTemporalProperties, with the specified parent object.

The enabled argument specifies whether the temporal properties are initially enabled or not (see isActive()).

Definition at line 25 of file qgsvectorlayertemporalproperties.cpp.

Member Function Documentation

◆ accumulateFeatures()

bool QgsVectorLayerTemporalProperties::accumulateFeatures ( ) const

Returns true if features will be accumulated over time (i.e.

all features which occur before or within the map's temporal range should be rendered).

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFeatureDateTimeInstantFromField

See also: setAccumulateFeatures()

Definition at line 344 of file qgsvectorlayertemporalproperties.cpp.

◆ calculateTemporalExtent()

QgsDateTimeRange QgsVectorLayerTemporalProperties::calculateTemporalExtent ( QgsMapLayer * layer ) const

overridevirtual

Attempts to calculate the overall temporal extent for the specified layer, using the settings defined by the temporal properties object.

May return an infinite range if the extent could not be calculated.

Note: Not available in Python bindings

Reimplemented from QgsMapLayerTemporalProperties.

Definition at line 50 of file qgsvectorlayertemporalproperties.cpp.

◆ createFilterString()

QString QgsVectorLayerTemporalProperties::createFilterString	(	const QgsVectorLayerTemporalContext &	context,
		const QgsDateTimeRange &	range
	)		const

Creates a QGIS expression filter string for filtering features within the specified context to those within the specified time range.

The returned expression string considers the mode() and other related settings (such as startField()) when building the filter string.

Warning: Note that ModeFixedTemporalRange is intentional NOT handled by this method and if mode() is ModeFixedTemporalRange then an empty string will be returned. Use isVisibleInTemporalRange() when testing whether features from a layer set to the ModeFixedTemporalRange should ALL be filtered out.

Definition at line 414 of file qgsvectorlayertemporalproperties.cpp.

◆ durationField()

QString QgsVectorLayerTemporalProperties::durationField ( ) const

Returns the name of the duration field, which contains the duration of the event.

Units are specified by durationUnits()

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFeatureDateTimeStartAndDurationFromFields

See also: setDurationField(); durationUnits()

Definition at line 384 of file qgsvectorlayertemporalproperties.cpp.

◆ durationUnits()

QgsUnitTypes::TemporalUnit QgsVectorLayerTemporalProperties::durationUnits ( ) const

Returns the units of the event's duration.

See also: setDurationUnits()

Definition at line 394 of file qgsvectorlayertemporalproperties.cpp.

◆ endExpression()

QString QgsVectorLayerTemporalProperties::endExpression ( ) const

Returns the expression for the end time for the feature's time spans.

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFeatureDateTimeStartAndEndFromExpressions

See also: setEndExpression(); startExpression()

Definition at line 334 of file qgsvectorlayertemporalproperties.cpp.

◆ endField()

QString QgsVectorLayerTemporalProperties::endField ( ) const

Returns the name of the end datetime field, which contains the end time for the feature's time spans.

See also: setEndField(); startField()

Definition at line 374 of file qgsvectorlayertemporalproperties.cpp.

◆ fixedDuration()

double QgsVectorLayerTemporalProperties::fixedDuration ( ) const

Returns the fixed duration length, which contains the duration of the event.

Units are specified by durationUnits()

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFeatureDateTimeInstantFromField

See also: setFixedDuration(); durationUnits()

Definition at line 354 of file qgsvectorlayertemporalproperties.cpp.

◆ fixedTemporalRange()

const QgsDateTimeRange & QgsVectorLayerTemporalProperties::fixedTemporalRange ( ) const

Returns the fixed temporal range for the layer.

Warning: To be used only when mode() is QgsVectorLayerTemporalProperties::ModeFixedTemporalRange

See also: setFixedTemporalRange()

Definition at line 225 of file qgsvectorlayertemporalproperties.cpp.

◆ flags()

QgsTemporalProperty::Flags QgsVectorLayerTemporalProperties::flags ( ) const

overridevirtual

Returns flags associated to the temporal property.

Reimplemented from QgsTemporalProperty.

Definition at line 215 of file qgsvectorlayertemporalproperties.cpp.

◆ guessDefaultsFromFields()

void QgsVectorLayerTemporalProperties::guessDefaultsFromFields ( const QgsFields & fields )

Attempts to setup the temporal properties by scanning a set of fields and looking for standard naming conventions (e.g.

"begin_date").

Definition at line 565 of file qgsvectorlayertemporalproperties.cpp.

◆ isVisibleInTemporalRange()

bool QgsVectorLayerTemporalProperties::isVisibleInTemporalRange ( const QgsDateTimeRange & range ) const

overridevirtual

Returns true if the layer should be visible and rendered for the specified time range.

Reimplemented from QgsMapLayerTemporalProperties.

Definition at line 30 of file qgsvectorlayertemporalproperties.cpp.

◆ mode()

QgsVectorLayerTemporalProperties::TemporalMode QgsVectorLayerTemporalProperties::mode ( ) const

Returns the temporal properties mode.

See also: setMode()

Definition at line 203 of file qgsvectorlayertemporalproperties.cpp.

◆ readXml()

bool QgsVectorLayerTemporalProperties::readXml	(	const QDomElement &	element,
		const QgsReadWriteContext &	context
	)

overridevirtual

Reads temporal properties from a DOM element previously written by writeXml().

See also: writeXml()

Implements QgsMapLayerTemporalProperties.

Definition at line 230 of file qgsvectorlayertemporalproperties.cpp.

◆ setAccumulateFeatures()

void QgsVectorLayerTemporalProperties::setAccumulateFeatures ( bool accumulate )

Sets whether features will be accumulated over time (i.e.

all features which occur before or within the map's temporal range should be rendered).

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFeatureDateTimeInstantFromField

See also: accumulateFeatures()

Definition at line 349 of file qgsvectorlayertemporalproperties.cpp.

◆ setDefaultsFromDataProviderTemporalCapabilities()

void QgsVectorLayerTemporalProperties::setDefaultsFromDataProviderTemporalCapabilities ( const QgsDataProviderTemporalCapabilities * capabilities )

overridevirtual

Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities.

Implements QgsMapLayerTemporalProperties.

Definition at line 301 of file qgsvectorlayertemporalproperties.cpp.

◆ setDurationField()

void QgsVectorLayerTemporalProperties::setDurationField ( const QString & field )

Sets the name of the duration field, which contains the duration of the event.

Units are specified by setDurationUnits()

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFeatureDateTimeStartAndDurationFromFields

See also: durationField(); setDurationUnits()

Definition at line 389 of file qgsvectorlayertemporalproperties.cpp.

◆ setDurationUnits()

void QgsVectorLayerTemporalProperties::setDurationUnits ( QgsUnitTypes::TemporalUnit units )

Sets the units of the event's duration.

See also: durationUnits()

Definition at line 399 of file qgsvectorlayertemporalproperties.cpp.

◆ setEndExpression()

void QgsVectorLayerTemporalProperties::setEndExpression ( const QString & endExpression )

Sets the expression to use for the end time for the feature's time spans.

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFeatureDateTimeStartAndEndFromExpressions

See also: endExpression(); setStartExpression()

Definition at line 339 of file qgsvectorlayertemporalproperties.cpp.

◆ setEndField()

void QgsVectorLayerTemporalProperties::setEndField ( const QString & field )

Sets the name of the end datetime field, which contains the end time for the feature's time spans.

See also: endField(); setStartField()

Definition at line 379 of file qgsvectorlayertemporalproperties.cpp.

◆ setFixedDuration()

void QgsVectorLayerTemporalProperties::setFixedDuration ( double duration )

Sets the fixed event duration, which contains the duration of the event.

Units are specified by setDurationUnits()

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFeatureDateTimeInstantFromField

See also: fixedDuration(); setDurationUnits()

Definition at line 359 of file qgsvectorlayertemporalproperties.cpp.

◆ setFixedTemporalRange()

void QgsVectorLayerTemporalProperties::setFixedTemporalRange ( const QgsDateTimeRange & range )

Sets a temporal range to apply to the whole layer.

All features from the layer will be rendered whenever the current datetime range of a render context intersects the specified range.

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFixedTemporalRange

See also: fixedTemporalRange()

Definition at line 220 of file qgsvectorlayertemporalproperties.cpp.

◆ setMode()

void QgsVectorLayerTemporalProperties::setMode ( QgsVectorLayerTemporalProperties::TemporalMode mode )

Sets the temporal properties mode.

See also: mode()

Definition at line 208 of file qgsvectorlayertemporalproperties.cpp.

◆ setStartExpression()

void QgsVectorLayerTemporalProperties::setStartExpression ( const QString & expression )

Sets the expression to use for the start time for the feature's time spans.

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFeatureDateTimeStartAndEndFromExpressions

See also: startExpression(); setEndExpression()

Definition at line 329 of file qgsvectorlayertemporalproperties.cpp.

◆ setStartField()

void QgsVectorLayerTemporalProperties::setStartField ( const QString & field )

Sets the name of the start datetime field, which contains the start time for the feature's time spans.

If mode() is ModeFeatureDateTimeInstantFromField, then this field represents both the start AND end times.

See also: startField(); setEndField()

Definition at line 369 of file qgsvectorlayertemporalproperties.cpp.

◆ startExpression()

QString QgsVectorLayerTemporalProperties::startExpression ( ) const

Returns the expression for the start time for the feature's time spans.

Warning: This setting is only effective when mode() is QgsVectorLayerTemporalProperties::ModeFeatureDateTimeStartAndEndFromExpressions

See also: setStartExpression(); endExpression()

Definition at line 324 of file qgsvectorlayertemporalproperties.cpp.

◆ startField()

QString QgsVectorLayerTemporalProperties::startField ( ) const

Returns the name of the start datetime field, which contains the start time for the feature's time spans.

If mode() is ModeFeatureDateTimeInstantFromField, then this field represents both the start AND end times.

See also: setStartField(); endField()

Definition at line 364 of file qgsvectorlayertemporalproperties.cpp.

◆ writeXml()

QDomElement QgsVectorLayerTemporalProperties::writeXml	(	QDomElement &	element,
		QDomDocument &	doc,
		const QgsReadWriteContext &	context
	)

overridevirtual

Writes the properties to a DOM element, to be used later with readXml().

See also: readXml()

Implements QgsMapLayerTemporalProperties.

Definition at line 263 of file qgsvectorlayertemporalproperties.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.16.0+99unstable/src/core/qgsvectorlayertemporalproperties.h
/build/qgis-3.16.0+99unstable/src/core/qgsvectorlayertemporalproperties.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TemporalMode

Constructor & Destructor Documentation

◆ QgsVectorLayerTemporalProperties()

Member Function Documentation

◆ accumulateFeatures()

◆ calculateTemporalExtent()

◆ createFilterString()

◆ durationField()

◆ durationUnits()

◆ endExpression()

◆ endField()

◆ fixedDuration()

◆ fixedTemporalRange()

◆ flags()

◆ guessDefaultsFromFields()

◆ isVisibleInTemporalRange()

◆ mode()

◆ readXml()

◆ setAccumulateFeatures()

◆ setDefaultsFromDataProviderTemporalCapabilities()

◆ setDurationField()

◆ setDurationUnits()

◆ setEndExpression()

◆ setEndField()

◆ setFixedDuration()

◆ setFixedTemporalRange()

◆ setMode()

◆ setStartExpression()

◆ setStartField()

◆ startExpression()

◆ startField()

◆ writeXml()