QgsRasterIdentifyResult class

Raster identify results container.

Contents

Constructors, destructors, conversion operators

QgsRasterIdentifyResult() defaulted
Constructor for QgsRasterIdentifyResult.
QgsRasterIdentifyResult(QgsRaster::IdentifyFormat format, const QMap<int, QVariant>& results)
Constructor.
QgsRasterIdentifyResult(const QgsError& error)
Constructor.

Public functions

auto error() const -> QgsError
Returns the last error.
auto format() const -> QgsRaster::IdentifyFormat
Returns the results format.
auto isValid() const -> bool
Returns true if valid.
auto params() const -> QMap<QString, QVariant>
Gets map of optional parameters.
auto results() const -> QMap<int, QVariant>
Returns the identify results.
void setError(const QgsError& error)
Sets the last error.
void setParams(const QMap<QString, QVariant>& params)
Sets map of optional parameters.

Function documentation

QgsRasterIdentifyResult::QgsRasterIdentifyResult(QgsRaster::IdentifyFormat format, const QMap<int, QVariant>& results)

Constructor.

Parameters
format the result format
results the results

Creates valid result.

QgsRasterIdentifyResult::QgsRasterIdentifyResult(const QgsError& error)

Constructor.

Parameters
error the error

Creates invalid result with error.

QMap<int, QVariant> QgsRasterIdentifyResult::results() const

Returns the identify 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).