Raster identify results container. More...

Public Member Functions
	QgsRasterIdentifyResult ()
	QgsRasterIdentifyResult (QgsRaster::IdentifyFormat theFormat, QMap< int, QVariant > theResults)
	Constructor.
	QgsRasterIdentifyResult (QgsError theError)
	Constructor.
virtual	~QgsRasterIdentifyResult ()
bool	isValid () const
	Returns true if valid.
QgsRaster::IdentifyFormat	format () const
	Get results format.
QMap< int, QVariant >	results () const
	Get results.
void	setParams (const QMap< QString, QVariant > &theParams)
	Set map of optional parameters.
QMap< QString, QVariant >	params () const
	Get map of optional parameters.
QgsError	error () const
	Get error.
void	setError (const QgsError &theError)
	Set error.

Detailed Description

Raster identify results container.

Constructor & Destructor Documentation

QgsRasterIdentifyResult::QgsRasterIdentifyResult ( )

QgsRasterIdentifyResult::QgsRasterIdentifyResult	(	QgsRaster::IdentifyFormat	theFormat,
		QMap< int, QVariant >	theResults
	)

Constructor.

Creates valid result.

Parameters

theFormat	the result format
theResults	the results

QgsRasterIdentifyResult::QgsRasterIdentifyResult ( QgsError theError )

Constructor.

Creates invalid result with error.

Parameters

theError the error

QgsRasterIdentifyResult::~QgsRasterIdentifyResult ( )

virtual

QgsError QgsRasterIdentifyResult::error ( ) const

inline

Get error.

QgsRaster::IdentifyFormat QgsRasterIdentifyResult::format ( ) const

inline

Get results format.

bool QgsRasterIdentifyResult::isValid ( ) const

inline

Returns true if valid.

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

inline

Get map of optional parameters.

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

inline

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).

void QgsRasterIdentifyResult::setError ( const QgsError & theError )

inline

Set error.

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

inline

Set map of optional parameters.

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