qgsvectorlayertemporalproperties.h

Go to the documentation of this file.

/***************************************************************************
                         qgsvectorlayertemporalproperties.h
                         ---------------
    begin                : May 2020
    copyright            : (C) 2020 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
 
#ifndef QGSVECTORLAYERTEMPORALPROPERTIES_H
#define QGSVECTORLAYERTEMPORALPROPERTIES_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmaplayertemporalproperties.h"
#include "qgsrange.h"
 
class QgsVectorLayer;
class QgsFields;

class CORE_EXPORT QgsVectorLayerTemporalContext
{
  public:

    QgsVectorLayer *layer() const;

    void setLayer( QgsVectorLayer *layer );
 
  private:
 
    QgsVectorLayer *mLayer = nullptr;
};

class CORE_EXPORT QgsVectorLayerTemporalProperties : public QgsMapLayerTemporalProperties
{
    Q_OBJECT
 
  public:

    QgsVectorLayerTemporalProperties( QObject *parent SIP_TRANSFERTHIS = nullptr, bool enabled = false );
 
    bool isVisibleInTemporalRange( const QgsDateTimeRange &range ) const override;
    QgsDateTimeRange calculateTemporalExtent( QgsMapLayer *layer ) const override SIP_SKIP;

    Qgis::VectorTemporalMode mode() const;

    void setMode( Qgis::VectorTemporalMode mode );

    Qgis::VectorTemporalLimitMode limitMode() const;

    void setLimitMode( Qgis::VectorTemporalLimitMode mode );

    QgsTemporalProperty::Flags flags() const override;

    void setFixedTemporalRange( const QgsDateTimeRange &range );

    const QgsDateTimeRange &fixedTemporalRange() const;

    QString startField() const;

    void setStartField( const QString &field );

    QString endField() const;

    void setEndField( const QString &field );

    QString startExpression() const;

    void setStartExpression( const QString &expression );

    QString endExpression() const;

    void setEndExpression( const QString &endExpression );

    QString durationField() const;

    void setDurationField( const QString &field );

    Qgis::TemporalUnit durationUnits() const;

    void setDurationUnits( Qgis::TemporalUnit units );

    double fixedDuration() const;

    void setFixedDuration( double duration );

    bool accumulateFeatures() const;

    void setAccumulateFeatures( bool accumulate );

    QString createFilterString( const QgsVectorLayerTemporalContext &context, const QgsDateTimeRange &range ) const;

    void guessDefaultsFromFields( const QgsFields &fields );
 
    QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context ) override;
    bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    void setDefaultsFromDataProviderTemporalCapabilities( const QgsDataProviderTemporalCapabilities *capabilities ) override;
 
  private:

    Qgis::VectorTemporalMode mMode = Qgis::VectorTemporalMode::FixedTemporalRange;

    Qgis::VectorTemporalLimitMode mLimitMode = Qgis::VectorTemporalLimitMode::IncludeBeginExcludeEnd;

    QgsDateTimeRange mFixedRange;
 
    QString mStartFieldName;
    QString mEndFieldName;
    QString mDurationFieldName;
    Qgis::TemporalUnit mDurationUnit = Qgis::TemporalUnit::Minutes;
 
    double mFixedDuration = 0;
 
    bool mAccumulateFeatures = false;
 
    QString mStartExpression;
    QString mEndExpression;
 
};
 
#endif // QGSVECTORLAYERTEMPORALPROPERTIES_H