QgsRasterIdentifyResult Class Reference

Raster identify results container. More...

#include <qgsrasteridentifyresult.h>

Public Member Functions
	QgsRasterIdentifyResult ()=default
	QgsRasterIdentifyResult (const QgsError &error)
	Constructor.
	QgsRasterIdentifyResult (Qgis::RasterIdentifyFormat format, const QMap< int, QVariant > &results)
	Constructor.
virtual	~QgsRasterIdentifyResult ()=default
QgsError	error () const
	Returns the last error.
Qgis::RasterIdentifyFormat	format () const
	Returns the results format.
bool	isValid () const
	Returns true if valid.
QMap< QString, QVariant >	params () const
	Gets map of optional parameters.
QMap< int, QVariant >	results () const
	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.

Detailed Description

Raster identify results container.

Definition at line 30 of file qgsrasteridentifyresult.h.

Constructor & Destructor Documentation

QgsRasterIdentifyResult() [1/3]

QgsRasterIdentifyResult::QgsRasterIdentifyResult ( )

default

QgsRasterIdentifyResult() [2/3]

QgsRasterIdentifyResult::QgsRasterIdentifyResult	(	Qgis::RasterIdentifyFormat	format,
		const QMap< int, QVariant > &	results
	)

Constructor.

Creates valid result.

Parameters

format	the result format
results	the results

Definition at line 25 of file qgsrasteridentifyresult.cpp.

QgsRasterIdentifyResult() [3/3]

QgsRasterIdentifyResult::QgsRasterIdentifyResult

(

const QgsError &

error

)

Constructor.

Creates invalid result with error.

Parameters

error

the error

Definition at line 32 of file qgsrasteridentifyresult.cpp.

~QgsRasterIdentifyResult()

virtual QgsRasterIdentifyResult::~QgsRasterIdentifyResult ( )

virtualdefault

Member Function Documentation

error()

QgsError QgsRasterIdentifyResult::error ( ) const

inline

Returns the last error.

Definition at line 73 of file qgsrasteridentifyresult.h.

format()

Qgis::RasterIdentifyFormat QgsRasterIdentifyResult::format ( ) const

inline

Returns the results format.

Definition at line 55 of file qgsrasteridentifyresult.h.

isValid()

bool QgsRasterIdentifyResult::isValid ( ) const

inline

Returns true if valid.

Definition at line 52 of file qgsrasteridentifyresult.h.

params()

QMap< QString, QVariant > QgsRasterIdentifyResult::params ( ) const

inline

Gets map of optional parameters.

Definition at line 70 of file qgsrasteridentifyresult.h.

results()

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

inline

Returns the identify results.

Results are different for each format:

• Qgis::RasterIdentifyFormat::Value: a map of values for each band, where keys are band numbers (from 1).
• Qgis::RasterIdentifyFormat::Feature: a map of WMS sublayer keys and lists of QgsFeatureStore values.
• Qgis::RasterIdentifyFormat::Html: a map of WMS sublayer keys and HTML strings.

Definition at line 64 of file qgsrasteridentifyresult.h.

setError()

void QgsRasterIdentifyResult::setError ( const QgsError &  error )

inline

Sets the last error.

Definition at line 76 of file qgsrasteridentifyresult.h.

setParams()

void QgsRasterIdentifyResult::setParams ( const QMap< QString, QVariant > &  params )

inline

Sets map of optional parameters.

Definition at line 67 of file qgsrasteridentifyresult.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.40.0+99sid/src/core/raster/qgsrasteridentifyresult.h
• /build/qgis-3.40.0+99sid/src/core/raster/qgsrasteridentifyresult.cpp