qgsrasterattributetable.h

Go to the documentation of this file.

/***************************************************************************
  qgsrasterattributetable.h - QgsRasterAttributeTable
 
 ---------------------
 begin                : 3.12.2021
 copyright            : (C) 2021 by Alessandro Pasotti
 email                : elpaso at itopen dot it
 ***************************************************************************
 *                                                                         *
 *   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 QGSRASTERATTRIBUTETABLE_H
#define QGSRASTERATTRIBUTETABLE_H
 
#include "qgsfields.h"
#include "qgsfeature.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgis.h"
#include "qgscolorrampimpl.h"
 
#include <QObject>
#include <QLinearGradient>
#include <QCoreApplication>
 
class QgsRasterLayer;
class QgsRasterRenderer;
class QgsRasterDataProvider;
 
class CORE_EXPORT QgsRasterAttributeTable
{
 
    Q_DECLARE_TR_FUNCTIONS( QgsRasterAttributeTable )
 
  public:
 
    class CORE_EXPORT UsageInformation
    {
      public:
 
        QString description;
 
        bool unique = false;
 
        bool required = false;
 
        bool isColor = false;
 
        bool isRamp = false;
 
        bool supported = false;
 
        bool maybeClass = false;
 
        QList<QMetaType::Type> allowedTypes;
    };
 
    class CORE_EXPORT Field
    {
 
      public:
 
        Field( const QString &name, const Qgis::RasterAttributeTableFieldUsage &usage, const QMetaType::Type type ): name( name ), usage( usage ), type( type ) {}
 
      Q_DECL_DEPRECATED Field( const QString &name, const Qgis::RasterAttributeTableFieldUsage &usage, const QVariant::Type type ) SIP_DEPRECATED: Field( name, usage, QgsVariantUtils::variantTypeToMetaType( type ) ) {}
 
        bool isColor( ) const;
 
        bool isRamp( ) const;
 
        QString name;
        Qgis::RasterAttributeTableFieldUsage usage;
        QMetaType::Type type;
    };
 
    class CORE_EXPORT MinMaxClass
    {
      public:
        QString name;
 
        QVector< double > minMaxValues;
        QColor color;
    };
 
    Qgis::RasterAttributeTableType type() const;
 
    bool hasColor() const;
 
    bool setColor( const int row, const QColor &color );
 
    bool hasRamp() const;
 
    bool setRamp( const int row, const QColor &colorMin, const QColor &colorMax );
 
    QList<Qgis::RasterAttributeTableFieldUsage> usages( ) const SIP_SKIP;
 
 
    QList<int> intUsages( ) const SIP_PYNAME( usages );
 
 
    QColor color( int row ) const;
 
    QgsGradientColorRamp ramp( int row ) const;
 
    QList<QgsRasterAttributeTable::Field> fields() const;
 
    QgsFields qgisFields() const;
 
    QgsFeatureList qgisFeatures( ) const;
 
    bool isDirty() const;
 
    void setDirty( bool isDirty );
 
    bool isValid( QString *errorMessage SIP_OUT = nullptr ) const;
 
    bool insertField( int position, const QgsRasterAttributeTable::Field &field, QString *errorMessage SIP_OUT = nullptr );
 
    bool insertField( int position, const QString &name, const Qgis::RasterAttributeTableFieldUsage usage, const QMetaType::Type type, QString *errorMessage SIP_OUT = nullptr );
 
    Q_DECL_DEPRECATED bool insertField( int position, const QString &name, const Qgis::RasterAttributeTableFieldUsage usage, const QVariant::Type type, QString *errorMessage SIP_OUT = nullptr ) SIP_DEPRECATED;
 
    bool insertColor( int position, QString *errorMessage SIP_OUT = nullptr );
 
    bool setFieldUsage( int fieldIndex, const Qgis::RasterAttributeTableFieldUsage usage );
 
    bool insertRamp( int position, QString *errorMessage SIP_OUT = nullptr );
 
    bool appendField( const QString &name, const Qgis::RasterAttributeTableFieldUsage usage, const QMetaType::Type type, QString *errorMessage SIP_OUT = nullptr );
 
    bool appendField( const QString &name, const Qgis::RasterAttributeTableFieldUsage usage, const QVariant::Type type, QString *errorMessage SIP_OUT = nullptr );
 
    bool appendField( const QgsRasterAttributeTable::Field &field, QString *errorMessage SIP_OUT = nullptr );
 
    bool removeField( const QString &name, QString *errorMessage SIP_OUT = nullptr );
 
    bool insertRow( int position, const QVariantList &rowData, QString *errorMessage SIP_OUT = nullptr );
 
    bool removeRow( int position = 0, QString *errorMessage SIP_OUT = nullptr );
 
    bool appendRow( const QVariantList &data, QString *errorMessage SIP_OUT = nullptr );
 
    bool writeToFile( const QString &path, QString *errorMessage SIP_OUT = nullptr );
 
    bool readFromFile( const QString &path, QString *errorMessage SIP_OUT = nullptr );
 
    const QList<QList<QVariant>> data() const;
 
    const QgsRasterAttributeTable::Field fieldByName( const QString name, bool *ok SIP_OUT = nullptr ) const;
 
    const QList<QgsRasterAttributeTable::Field> fieldsByUsage( const Qgis::RasterAttributeTableFieldUsage fieldUsage ) const;
 
    bool setValue( const int row, const int column, const QVariant &value );
 
    QVariant value( const int row, const int column ) const;
 
    double minimumValue( ) const;
 
    double maximumValue( ) const;
 
    QVariantList row( const double matchValue ) const;
 
    QList<QgsRasterAttributeTable::MinMaxClass> minMaxClasses( const int classificationColumn  = -1 ) const;
 
    QgsGradientColorRamp colorRamp( QStringList &labels SIP_OUT, const int labelColumn = -1 ) const;
 
    QgsRasterRenderer *createRenderer( QgsRasterDataProvider *provider, const int bandNumber, const int classificationColumn = -1 ) SIP_FACTORY;
 
    QList<QList<QVariant>> orderedRows( ) const;
 
    static Qgis::RasterAttributeTableFieldUsage guessFieldUsage( const QString &name, const QMetaType::Type type );
 
    static Qgis::RasterAttributeTableFieldUsage guessFieldUsage( const QString &name, const QVariant::Type type );
 
    QString filePath() const;
 
    static QString usageName( const Qgis::RasterAttributeTableFieldUsage fieldusage );
 
    static QList<Qgis::RasterAttributeTableFieldUsage> valueAndColorFieldUsages();
 
    static QgsRasterAttributeTable *createFromRaster( QgsRasterLayer *rasterLayer, int *bandNumber SIP_OUT = nullptr ) SIP_FACTORY;
 
    static QHash<Qgis::RasterAttributeTableFieldUsage, QgsRasterAttributeTable::UsageInformation> usageInformation( ) SIP_SKIP;
 
 
    static QHash<int, QgsRasterAttributeTable::UsageInformation> usageInformationInt( ) SIP_PYNAME( usageInformation );
 
    static QHash<Qgis::RasterAttributeTableFieldUsage, QgsRasterAttributeTable::UsageInformation> sUsageInformation SIP_SKIP;
 
 
  private:
 
    Qgis::RasterAttributeTableType mType = Qgis::RasterAttributeTableType::Thematic;
    QList<Field> mFields;
    QList<QVariantList> mData;
    bool mIsDirty;
    QString mFilePath;
 
    // Set type from fields.
    void setType( );
 
};
 
#endif // QGSRASTERATTRIBUTETABLE_H