QGIS/python/core/raster/qgsrasteridentifyresult.sip
Denis Rouzaud 7812d4fb17 remove the-prefix from source code
this might result in variables having the same name as some methods
2017-02-21 18:14:58 +01:00

48 lines
1.4 KiB
Plaintext

class QgsRasterIdentifyResult
{
%TypeHeaderCode
#include <qgsrasteridentifyresult.h>
%End
public:
QgsRasterIdentifyResult();
/** \brief Constructor. Creates valid result.
* @param format the result format
* @param results the results
*/
QgsRasterIdentifyResult( QgsRaster::IdentifyFormat format, const QMap<int, QVariant>& results );
/** \brief Constructor. Creates invalid result with error.
* @param error the error
*/
QgsRasterIdentifyResult( const QgsError& error );
virtual ~QgsRasterIdentifyResult();
/** \brief Returns true if valid */
bool isValid() const;
/** \brief Get results format */
QgsRaster::IdentifyFormat format() const;
/** \brief Get results. Results are different for each format:
* QgsRaster::IdentifyFormatValue: map of values for each band, keys are band numbers (from 1).
* QgsRaster::IdentifyFormatFeature: map of QgsRasterFeatureList for each sublayer (WMS)
* QgsRaster::IdentifyFormatHtml: map of HTML strings for each sublayer (WMS).
*/
QMap<int, QVariant> results() const;
/** Set map of optional parameters */
void setParams( const QMap<QString, QVariant> & params );
/** Get map of optional parameters */
QMap<QString, QVariant> params() const;
/** \brief Get error */
QgsError error() const;
/** \brief Set error */
void setError( const QgsError & error );
};