qgsrasteridentifyresult.h

Go to the documentation of this file.

/***************************************************************************
      qgsrasteridentifyresult.h
     --------------------------------------
    Date                 : Apr 8, 2013
    Copyright            : (C) 2013 by Radim Blazek
    email                : radim dot blazek at gmail dot com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSRASTERIDENTIFYRESULT_H
#define QGSRASTERIDENTIFYRESULT_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsraster.h"
#include "qgserror.h"

class CORE_EXPORT QgsRasterIdentifyResult
{
  public:

    QgsRasterIdentifyResult() = default;

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

    QgsRasterIdentifyResult( const QgsError &error );

    virtual ~QgsRasterIdentifyResult() = default;

    bool isValid() const { return mValid; }

    QgsRaster::IdentifyFormat format() const { return mFormat; }

    QMap<int, QVariant> results() const { return mResults; }

    void setParams( const QMap<QString, QVariant> &params ) { mParams = params; }

    QMap<QString, QVariant> params() const { return mParams; }

    QgsError error() const { return mError; }

    void setError( const QgsError &error ) { mError = error;}

  private:
    bool mValid = false;

    QgsRaster::IdentifyFormat mFormat = QgsRaster::IdentifyFormatUndefined;

    // TODO: better hierarchy (sublayer multiple feature sets)?
    // TODO?: results are not consistent for different formats (per band x per sublayer)
    QMap<int, QVariant> mResults;

    QMap<QString, QVariant> mParams;

    QgsError mError;
};

#endif