qgsmaplayertemporalproperties.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmaplayertemporalproperties.h
                         ---------------
    begin                : February 2020
    copyright            : (C) 2020 by Samweli Mwakisambwe
    email                : samweli at kartoza 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 QGSMAPLAYERTEMPORALPROPERTIES_H
#define QGSMAPLAYERTEMPORALPROPERTIES_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrange.h"
#include "qgsreadwritecontext.h"
#include "qgstemporalproperty.h"
 
#include <QDomElement>
 
class QgsMapLayer;
class QgsDataProviderTemporalCapabilities;

class CORE_EXPORT QgsMapLayerTemporalProperties : public QgsTemporalProperty
{
    //SIP_TYPEHEADER_INCLUDE( "qgsrasterlayertemporalproperties.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsmeshlayertemporalproperties.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsvectorlayertemporalproperties.h" );
 
    Q_OBJECT
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsRasterLayerTemporalProperties *>( sipCpp ) )
    {
      sipType = sipType_QgsRasterLayerTemporalProperties;
    }
    else if ( qobject_cast<QgsMeshLayerTemporalProperties *>( sipCpp ) )
    {
      sipType = sipType_QgsMeshLayerTemporalProperties;
    }
    else if ( qobject_cast<QgsVectorLayerTemporalProperties *>( sipCpp ) )
    {
      sipType = sipType_QgsVectorLayerTemporalProperties;
    }
    else
    {
      sipType = 0;
    }
  SIP_END
#endif
 
  public:

    QgsMapLayerTemporalProperties( QObject *parent SIP_TRANSFERTHIS, bool enabled = false );

    virtual QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context ) = 0;

    virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) = 0;

    virtual bool isVisibleInTemporalRange( const QgsDateTimeRange &range ) const;

    virtual void setDefaultsFromDataProviderTemporalCapabilities( const QgsDataProviderTemporalCapabilities *capabilities ) = 0;
 
#ifndef SIP_RUN
    // sip gets confused with this, refuses to compile

    virtual QgsDateTimeRange calculateTemporalExtent( QgsMapLayer *layer ) const;
#endif

    virtual QList< QgsDateTimeRange > allTemporalRanges( QgsMapLayer *layer ) const;
};
 
#endif // QGSMAPLAYERTEMPORALPROPERTIES_H