Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsdataprovidertemporalcapabilities.h
       3                 :            :                          ---------------
       4                 :            :     begin                : February 2020
       5                 :            :     copyright            : (C) 2020 by Samweli Mwakisambwe
       6                 :            :     email                : samweli at kartoza dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : 
      19                 :            : #ifndef QGSDATAPROVIDERTEMPORALCAPABILITIES_H
      20                 :            : #define QGSDATAPROVIDERTEMPORALCAPABILITIES_H
      21                 :            : 
      22                 :            : #include "qgis_core.h"
      23                 :            : #include "qgis_sip.h"
      24                 :            : #include "qgstemporalproperty.h"
      25                 :            : 
      26                 :            : /**
      27                 :            :  * \class QgsDataProviderTemporalCapabilities
      28                 :            :  * \ingroup core
      29                 :            :  * \brief Base class for handling properties relating to a data provider's temporal capabilities.
      30                 :            :  *
      31                 :            :  * \since QGIS 3.14
      32                 :            :  */
      33                 :          0 : class CORE_EXPORT QgsDataProviderTemporalCapabilities
      34                 :            : {
      35                 :            : 
      36                 :            : #ifdef SIP_RUN
      37                 :            :     SIP_CONVERT_TO_SUBCLASS_CODE
      38                 :            :     if ( dynamic_cast<QgsRasterDataProviderTemporalCapabilities *>( sipCpp ) )
      39                 :            :     {
      40                 :            :       sipType = sipType_QgsRasterDataProviderTemporalCapabilities;
      41                 :            :     }
      42                 :            :     else if ( dynamic_cast<QgsVectorDataProviderTemporalCapabilities *>( sipCpp ) )
      43                 :            :     {
      44                 :            :       sipType = sipType_QgsVectorDataProviderTemporalCapabilities;
      45                 :            :     }
      46                 :            :     else if ( dynamic_cast < QgsMeshDataProviderTemporalCapabilities * >( sipCpp ) )
      47                 :            :     {
      48                 :            :       sipType = sipType_QgsMeshDataProviderTemporalCapabilities;
      49                 :            :     }
      50                 :            :     else
      51                 :            :     {
      52                 :            :       sipType = 0;
      53                 :            :     }
      54                 :            :     SIP_END
      55                 :            : #endif
      56                 :            : 
      57                 :            :   public:
      58                 :            : 
      59                 :            :     /**
      60                 :            :      * Constructor for QgsDataProviderTemporalCapabilities.
      61                 :            :      *
      62                 :            :     * The \a available argument specifies whether the data provider has temporal capabilities. Set to
      63                 :            :     * TRUE to indicate that the provider has temporal capabilities available for use.
      64                 :            :      */
      65                 :            :     QgsDataProviderTemporalCapabilities( bool available = false );
      66                 :            : 
      67                 :         62 :     virtual ~QgsDataProviderTemporalCapabilities() = default;
      68                 :            : 
      69                 :            :     /**
      70                 :            :      * Returns TRUE if the provider has temporal capabilities available.
      71                 :            :      *
      72                 :            :      * \see setHasTemporalCapabilities()
      73                 :            :      */
      74                 :         78 :     bool hasTemporalCapabilities() const { return mHasTemporalCapabilities; }
      75                 :            : 
      76                 :            :     /**
      77                 :            :      * Sets whether the provider has temporal capabilities \a available.
      78                 :            :      *
      79                 :            :      * Set \a available to TRUE to indicate that the provider has temporal capabilities available for use.
      80                 :            :     *
      81                 :            :      * \see hasTemporalCapabilities()
      82                 :            :      */
      83                 :          0 :     void setHasTemporalCapabilities( bool available ) { mHasTemporalCapabilities = available; }
      84                 :            : 
      85                 :            :   private:
      86                 :            : 
      87                 :            :     bool mHasTemporalCapabilities = false;
      88                 :            : };
      89                 :            : 
      90                 :            : #endif // QGSDATAPROVIDERTEMPORALCAPABILITIES_H