Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgstemporalrangeobject.h
       3                 :            :                          ---------------
       4                 :            :     begin                : January 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 QGSTEMPORALRANGEOBJECT_H
      20                 :            : #define QGSTEMPORALRANGEOBJECT_H
      21                 :            : 
      22                 :            : #include "qgis_core.h"
      23                 :            : #include "qgis_sip.h"
      24                 :            : #include "qgsrange.h"
      25                 :            : 
      26                 :            : /**
      27                 :            :  * \class QgsTemporalRangeObject
      28                 :            :  * \ingroup core
      29                 :            :  * \brief Base class for objects with an associated (optional) temporal range.
      30                 :            :  *
      31                 :            :  * \since QGIS 3.14
      32                 :            :  */
      33                 :          0 : class CORE_EXPORT QgsTemporalRangeObject
      34                 :            : {
      35                 :            :   public:
      36                 :            : 
      37                 :            :     /**
      38                 :            :      * Constructor QgsTemporalRangeObject.
      39                 :            :      *
      40                 :            :      * The \a enabled argument specifies whether the temporal range is initially enabled or not (see isTemporal()).
      41                 :            :      */
      42                 :            :     QgsTemporalRangeObject( bool enabled = false );
      43                 :            : 
      44                 :          6 :     virtual ~QgsTemporalRangeObject() = default;
      45                 :            : 
      46                 :            :     /**
      47                 :            :      * Sets whether the temporal range is \a enabled (i.e. whether the object has a temporal range
      48                 :            :      * which will be considered when rendering maps with a specific time range set.)
      49                 :            :      *
      50                 :            :      * \see isTemporal()
      51                 :            :      */
      52                 :            :     void setIsTemporal( bool enabled );
      53                 :            : 
      54                 :            :     /**
      55                 :            :      * Returns TRUE if the object's temporal range is enabled, and the object will be filtered when rendering maps with a specific time range set.
      56                 :            :      *
      57                 :            :      * For map settings, if FALSE is returned, then any other temporal settings relating to the map will be ignored during rendering.
      58                 :            :      *
      59                 :            :      * \see setIsTemporal()
      60                 :            :     */
      61                 :            :     bool isTemporal() const;
      62                 :            : 
      63                 :            :     /**
      64                 :            :      * Sets the temporal \a range for the object.
      65                 :            :      *
      66                 :            :      * Calling setTemporalRange() automatically enables temporal properties on the
      67                 :            :      * object (see isTemporal()), regardless of its existing state.
      68                 :            :      *
      69                 :            :      * When a temporal \a range is set it can be used to filter and request time base objects.
      70                 :            :      *
      71                 :            :      * \see temporalRange()
      72                 :            :     */
      73                 :            :     void setTemporalRange( const QgsDateTimeRange &range );
      74                 :            : 
      75                 :            :     /**
      76                 :            :      * Returns the datetime range for the object.
      77                 :            :      *
      78                 :            :      * This should only be considered when isTemporal() returns TRUE.
      79                 :            :      *
      80                 :            :      * \see setTemporalRange()
      81                 :            :     */
      82                 :            :     const QgsDateTimeRange &temporalRange() const;
      83                 :            : 
      84                 :            :   private:
      85                 :            : 
      86                 :            :     //! Temporal state
      87                 :            :     bool mTemporal = false;
      88                 :            : 
      89                 :            :     //! Represents datetime range member.
      90                 :            :     QgsDateTimeRange mDateTimeRange;
      91                 :            : 
      92                 :            : };
      93                 :            : 
      94                 :            : #endif // QGSTEMPORALRANGEOBJECT_H