Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :           qgsrasterrange.h
       3                 :            :      --------------------------------------
       4                 :            :     Date                 : Oct 9, 2012
       5                 :            :     Copyright            : (C) 2012 by Radim Blazek
       6                 :            :     email                : radim dot blazek at gmail 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                 :            : #ifndef QGSRASTERRANGE_H
      19                 :            : #define QGSRASTERRANGE_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis_sip.h"
      23                 :            : #include "qgis.h"
      24                 :            : #include <QList>
      25                 :            : 
      26                 :            : class QgsRasterRange;
      27                 :            : 
      28                 :            : typedef QList<QgsRasterRange> QgsRasterRangeList;
      29                 :            : 
      30                 :            : /**
      31                 :            :  * \ingroup core
      32                 :            :  * \brief Raster values range container. Represents range of values between min and max
      33                 :            :  * including min and max value.
      34                 :            :  */
      35                 :            : class CORE_EXPORT QgsRasterRange
      36                 :            : {
      37                 :            :   public:
      38                 :            : 
      39                 :            :     //! Handling for min and max bounds
      40                 :            :     enum BoundsType
      41                 :            :     {
      42                 :            :       IncludeMinAndMax = 0, //!< Min and max values are inclusive
      43                 :            :       IncludeMax, //!< Include the max value, but not the min value, e.g. min < value <= max
      44                 :            :       IncludeMin, //!< Include the min value, but not the max value, e.g. min <= value < max
      45                 :            :       Exclusive, //!< Don't include either the min or max value, e.g. min < value < max
      46                 :            :     };
      47                 :            : 
      48                 :            :     /**
      49                 :            :      * Default constructor, both min and max value for the range will be set to NaN.
      50                 :            :      */
      51                 :          0 :     QgsRasterRange() = default;
      52                 :            : 
      53                 :            :     /**
      54                 :            :      * Constructor for a range with the given \a min and \a max values.
      55                 :            :      *
      56                 :            :      * The \a bounds argument dictates how the min and max value themselves
      57                 :            :      * will be handled by the range.
      58                 :            :      */
      59                 :            :     QgsRasterRange( double min, double max, BoundsType bounds = IncludeMinAndMax );
      60                 :            : 
      61                 :            :     /**
      62                 :            :      * Returns the minimum value for the range.
      63                 :            :      * \see setMin()
      64                 :            :      */
      65                 :          0 :     double min() const { return mMin; }
      66                 :            : 
      67                 :            :     /**
      68                 :            :      * Returns the maximum value for the range.
      69                 :            :      * \see setMax()
      70                 :            :      */
      71                 :          0 :     double max() const { return mMax; }
      72                 :            : 
      73                 :            :     /**
      74                 :            :      * Returns the bounds type for the range, which specifies
      75                 :            :      * whether or not the min and max values themselves are included
      76                 :            :      * in the range.
      77                 :            :      * \see setBounds()
      78                 :            :      * \since QGIS 3.2
      79                 :            :      */
      80                 :            :     BoundsType bounds() const { return mType; }
      81                 :            : 
      82                 :            :     /**
      83                 :            :      * Sets the minimum value for the range.
      84                 :            :      * \see min()
      85                 :            :      */
      86                 :            :     double setMin( double min ) { return mMin = min; }
      87                 :            : 
      88                 :            :     /**
      89                 :            :      * Sets the maximum value for the range.
      90                 :            :      * \see max()
      91                 :            :      */
      92                 :            :     double setMax( double max ) { return mMax = max; }
      93                 :            : 
      94                 :            :     /**
      95                 :            :      * Sets the bounds \a type for the range, which specifies
      96                 :            :      * whether or not the min and max values themselves are included
      97                 :            :      * in the range.
      98                 :            :      * \see bounds()
      99                 :            :      * \since QGIS 3.2
     100                 :            :      */
     101                 :            :     void setBounds( BoundsType type ) { mType = type; }
     102                 :            : 
     103                 :          0 :     inline bool operator==( const QgsRasterRange &o ) const
     104                 :            :     {
     105                 :          0 :       return ( ( std::isnan( mMin ) && std::isnan( o.mMin ) ) || qgsDoubleNear( mMin, o.mMin ) )
     106                 :          0 :              && ( ( std::isnan( mMax ) && std::isnan( o.mMax ) ) || qgsDoubleNear( mMax, o.mMax ) )
     107                 :          0 :              && mType == o.mType;
     108                 :            :     }
     109                 :            : 
     110                 :            :     /**
     111                 :            :      * Returns TRUE if this range contains the specified \a value.
     112                 :            :      * \since QGIS 3.2
     113                 :            :      */
     114                 :          0 :     bool contains( double value ) const
     115                 :            :     {
     116                 :          0 :       return ( value > mMin
     117                 :          0 :                || ( !std::isnan( mMin ) && qgsDoubleNear( value, mMin ) && ( mType == IncludeMinAndMax || mType == IncludeMin ) )
     118                 :          0 :                || std::isnan( mMin ) )
     119                 :          0 :              &&
     120                 :          0 :              ( value < mMax
     121                 :          0 :                || ( !std::isnan( mMax ) && qgsDoubleNear( value, mMax ) && ( mType == IncludeMinAndMax || mType == IncludeMax ) )
     122                 :          0 :                || std::isnan( mMax ) );
     123                 :            :     }
     124                 :            : 
     125                 :            :     /**
     126                 :            :      * \brief Tests if a \a value is within the list of ranges
     127                 :            :      *  \param value value
     128                 :            :      *  \param rangeList list of ranges
     129                 :            :      *  \returns TRUE if value is in at least one of ranges
     130                 :            :      */
     131                 :          0 :     static bool contains( double value, const QgsRasterRangeList &rangeList )
     132                 :            :     {
     133                 :          0 :       for ( QgsRasterRange range : rangeList )
     134                 :            :       {
     135                 :          0 :         if ( range.contains( value ) )
     136                 :            :         {
     137                 :          0 :           return true;
     138                 :            :         }
     139                 :            :       }
     140                 :          0 :       return false;
     141                 :          0 :     }
     142                 :            : 
     143                 :            :     /**
     144                 :            :      * Returns TRUE if this range overlaps another range.
     145                 :            :      * \since QGIS 3.2
     146                 :            :      */
     147                 :            :     bool overlaps( const QgsRasterRange &other ) const;
     148                 :            : 
     149                 :            :     /**
     150                 :            :      * Returns a text representation of the range.
     151                 :            :      * \since QGIS 3.2
     152                 :            :      */
     153                 :            :     QString asText() const;
     154                 :            : 
     155                 :            :   private:
     156                 :          0 :     double mMin = std::numeric_limits<double>::quiet_NaN();
     157                 :          0 :     double mMax = std::numeric_limits<double>::quiet_NaN();
     158                 :          0 :     BoundsType mType = IncludeMinAndMax;
     159                 :            : };
     160                 :            : 
     161                 :            : #endif
     162                 :            : 
     163                 :            :