QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
QgsRasterIdentifyResult Class Reference

Raster identify results container. More...

#include <qgsrasteridentifyresult.h>

Public Member Functions

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

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
theFormatthe result format
theResultsthe results
QgsRasterIdentifyResult::QgsRasterIdentifyResult ( QgsError  theError)

Constructor.

Creates invalid result with error.

Parameters
theErrorthe error
QgsRasterIdentifyResult::~QgsRasterIdentifyResult ( )
virtual

Member Function Documentation

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: