Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :       qgsrasteridentifyresult.h
       3                 :            :      --------------------------------------
       4                 :            :     Date                 : Apr 8, 2013
       5                 :            :     Copyright            : (C) 2013 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 QGSRASTERIDENTIFYRESULT_H
      19                 :            : #define QGSRASTERIDENTIFYRESULT_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis_sip.h"
      23                 :            : #include "qgsraster.h"
      24                 :            : #include "qgserror.h"
      25                 :            : 
      26                 :            : /**
      27                 :            :  * \ingroup core
      28                 :            :  * \brief Raster identify results container.
      29                 :            :  */
      30                 :            : class CORE_EXPORT QgsRasterIdentifyResult
      31                 :            : {
      32                 :            :   public:
      33                 :            : 
      34                 :            :     /**
      35                 :            :      * Constructor for QgsRasterIdentifyResult.
      36                 :            :      */
      37                 :            :     QgsRasterIdentifyResult() = default;
      38                 :            : 
      39                 :            :     /**
      40                 :            :      * \brief Constructor. Creates valid result.
      41                 :            :      *  \param format the result format
      42                 :            :      *  \param results the results
      43                 :            :      */
      44                 :            :     QgsRasterIdentifyResult( QgsRaster::IdentifyFormat format, const QMap<int, QVariant> &results );
      45                 :            : 
      46                 :            :     /**
      47                 :            :      * \brief Constructor. Creates invalid result with error.
      48                 :            :      *  \param error the error
      49                 :            :      */
      50                 :            :     QgsRasterIdentifyResult( const QgsError &error );
      51                 :            : 
      52                 :          0 :     virtual ~QgsRasterIdentifyResult() = default;
      53                 :            : 
      54                 :            :     //! \brief Returns TRUE if valid
      55                 :            :     bool isValid() const { return mValid; }
      56                 :            : 
      57                 :            :     //! Returns the results format.
      58                 :            :     QgsRaster::IdentifyFormat format() const { return mFormat; }
      59                 :            : 
      60                 :            :     /**
      61                 :            :      * Returns the identify results. Results are different for each format:
      62                 :            :      *
      63                 :            :      * - QgsRaster::IdentifyFormatValue: a map of values for each band, where keys are band numbers (from 1).
      64                 :            :      * - QgsRaster::IdentifyFormatFeature: a map of WMS sublayer keys and lists of QgsFeatureStore values.
      65                 :            :      * - QgsRaster::IdentifyFormatHtml: a map of WMS sublayer keys and HTML strings.
      66                 :            :      */
      67                 :          0 :     QMap<int, QVariant> results() const { return mResults; }
      68                 :            : 
      69                 :            :     //! Sets map of optional parameters
      70                 :            :     void setParams( const QMap<QString, QVariant> &params ) { mParams = params; }
      71                 :            : 
      72                 :            :     //! Gets map of optional parameters
      73                 :            :     QMap<QString, QVariant> params() const { return mParams; }
      74                 :            : 
      75                 :            :     //! Returns the last error
      76                 :            :     QgsError error() const { return mError; }
      77                 :            : 
      78                 :            :     //! Sets the last error
      79                 :            :     void setError( const QgsError &error ) { mError = error;}
      80                 :            : 
      81                 :            :   private:
      82                 :            :     //! \brief Is valid
      83                 :            :     bool mValid = false;
      84                 :            : 
      85                 :            :     //! \brief Results format
      86                 :            :     QgsRaster::IdentifyFormat mFormat = QgsRaster::IdentifyFormatUndefined;
      87                 :            : 
      88                 :            :     // TODO: better hierarchy (sublayer multiple feature sets)?
      89                 :            :     // TODO?: results are not consistent for different formats (per band x per sublayer)
      90                 :            : 
      91                 :            :     //! \brief Results
      92                 :            :     QMap<int, QVariant> mResults;
      93                 :            : 
      94                 :            :     //! \brief Additional params (e.g. request url used by WMS)
      95                 :            :     QMap<QString, QVariant> mParams;
      96                 :            : 
      97                 :            :     //! \brief Error
      98                 :            :     QgsError mError;
      99                 :            : };
     100                 :            : 
     101                 :            : #endif
     102                 :            : 
     103                 :            :