gdal_rat.h

/******************************************************************************
 *
 * Project:  GDAL Core
 * Purpose:  GDALRasterAttributeTable class declarations.
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *
 ******************************************************************************
 * Copyright (c) 2005, Frank Warmerdam <warmerdam@pobox.com>
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/
 
#ifndef GDAL_RAT_H_INCLUDED
#define GDAL_RAT_H_INCLUDED
 
#if !defined(GDAL_COMPILATION) &&                                              \
    !defined(GDAL_RAT_SKIP_OTHER_GDAL_HEADERS) && !defined(GDAL_4_0_COMPAT)
 
#include "cpl_minixml.h"
#include "gdal_priv.h"
 
#else
 
#include "cpl_port.h"
#include "cpl_error.h"
#include "cpl_string.h"
#include "gdal.h"
 
#endif
 
#include <memory>
#include <vector>
 
class GDALColorTable;
 
// Clone and Serialize are allowed to fail if GetRowCount()*GetColCount()
// greater than this number
#define RAT_MAX_ELEM_FOR_CLONE 1000000
 
/************************************************************************/
/*                       GDALRasterAttributeTable                       */
/************************************************************************/

class GDALDefaultRasterAttributeTable;
 
class CPL_DLL GDALRasterAttributeTable
{
  public:
    virtual ~GDALRasterAttributeTable();
    virtual GDALRasterAttributeTable *Clone() const = 0;

    virtual int GetColumnCount() const = 0;

    virtual const char *GetNameOfCol(int iCol) const = 0;

    virtual GDALRATFieldUsage GetUsageOfCol(int iCol) const = 0;

    virtual GDALRATFieldType GetTypeOfCol(int iCol) const = 0;

    virtual int GetColOfUsage(GDALRATFieldUsage eUsage) const = 0;

    virtual int GetRowCount() const = 0;

    virtual const char *GetValueAsString(int iRow, int iField) const = 0;

    virtual int GetValueAsInt(int iRow, int iField) const = 0;

    virtual double GetValueAsDouble(int iRow, int iField) const = 0;

    virtual bool GetValueAsBoolean(int iRow, int iField) const = 0;

    virtual GDALRATDateTime GetValueAsDateTime(int iRow, int iField) const = 0;

    virtual const GByte *GetValueAsWKBGeometry(int iRow, int iField,
                                               size_t &nWKBSize) const = 0;

    virtual CPLErr SetValue(int iRow, int iField, const char *pszValue) = 0;

    virtual CPLErr SetValue(int iRow, int iField, int nValue) = 0;

    virtual CPLErr SetValue(int iRow, int iField, double dfValue) = 0;

    virtual CPLErr SetValue(int iRow, int iField, bool bValue) = 0;

    virtual CPLErr SetValue(int iRow, int iField,
                            const GDALRATDateTime &sDateTime) = 0;

    virtual CPLErr SetValue(int iRow, int iField, const void *pabyWKB,
                            size_t nWKBSize) = 0;

    virtual int ChangesAreWrittenToFile() = 0;

    virtual CPLErr SetTableType(const GDALRATTableType eInTableType) = 0;

    virtual GDALRATTableType GetTableType() const = 0;
 
    virtual CPLErr ValuesIO(GDALRWFlag eRWFlag, int iField, int iStartRow,
                            int iLength, double *pdfData);
    virtual CPLErr ValuesIO(GDALRWFlag eRWFlag, int iField, int iStartRow,
                            int iLength, int *pnData);
    virtual CPLErr ValuesIO(GDALRWFlag eRWFlag, int iField, int iStartRow,
                            int iLength, char **papszStrList);
    virtual CPLErr ValuesIO(GDALRWFlag eRWFlag, int iField, int iStartRow,
                            int iLength, bool *pbData);
    virtual CPLErr ValuesIO(GDALRWFlag eRWFlag, int iField, int iStartRow,
                            int iLength, GDALRATDateTime *pasDateTime);
    virtual CPLErr ValuesIO(GDALRWFlag eRWFlag, int iField, int iStartRow,
                            int iLength, GByte **ppabyWKB, size_t *pnWKBSize);
 
    virtual void SetRowCount(int iCount);
    virtual int GetRowOfValue(double dfValue) const;
    virtual int GetRowOfValue(int nValue) const;
 
    virtual CPLErr CreateColumn(const char *pszFieldName,
                                GDALRATFieldType eFieldType,
                                GDALRATFieldUsage eFieldUsage);
    virtual CPLErr SetLinearBinning(double dfRow0Min, double dfBinSize);
    virtual int GetLinearBinning(double *pdfRow0Min, double *pdfBinSize) const;

    virtual CPLXMLNode *Serialize() const;
    virtual void *SerializeJSON() const;
    virtual CPLErr XMLInit(const CPLXMLNode *, const char *);
 
    virtual CPLErr InitializeFromColorTable(const GDALColorTable *);
    virtual GDALColorTable *TranslateToColorTable(int nEntryCount = -1);
 
    virtual void DumpReadable(FILE * = nullptr);

    static inline GDALRasterAttributeTableH
    ToHandle(GDALRasterAttributeTable *poRAT)
    {
        return static_cast<GDALRasterAttributeTableH>(poRAT);
    }

    static inline GDALRasterAttributeTable *
    FromHandle(GDALRasterAttributeTableH hRAT)
    {
        return static_cast<GDALRasterAttributeTable *>(hRAT);
    }

    virtual void RemoveStatistics() = 0;

    static std::string DateTimeToString(const GDALRATDateTime &sDateTime);
    static bool StringToDateTime(const char *pszStr,
                                 GDALRATDateTime &sDateTime);
 
    static std::string WKBGeometryToWKT(const void *pabyWKB, size_t nWKBSize);
    static std::vector<GByte> WKTGeometryToWKB(const char *pszWKT);
 
  protected:
    GDALRasterAttributeTable() = default;
    GDALRasterAttributeTable(const GDALRasterAttributeTable &) = default;
    GDALRasterAttributeTable &
    operator=(const GDALRasterAttributeTable &) = default;
    GDALRasterAttributeTable(GDALRasterAttributeTable &&) = default;
    GDALRasterAttributeTable &operator=(GDALRasterAttributeTable &&) = default;
 
    CPLErr ValuesIOBooleanFromIntoInt(GDALRWFlag eRWFlag, int iField,
                                      int iStartRow, int iLength, bool *pbData);
    CPLErr ValuesIODateTimeFromIntoString(GDALRWFlag eRWFlag, int iField,
                                          int iStartRow, int iLength,
                                          GDALRATDateTime *psDateTime);
    CPLErr ValuesIOWKBGeometryFromIntoString(GDALRWFlag eRWFlag, int iField,
                                             int iStartRow, int iLength,
                                             GByte **ppabyWKB,
                                             size_t *pnWKBSize);
};
 
/************************************************************************/
/*                    GDALDefaultRasterAttributeTable                   */
/************************************************************************/

 
class CPL_DLL GDALDefaultRasterAttributeTable : public GDALRasterAttributeTable
{
  private:
    struct GDALRasterAttributeField
    {
        CPLString sName{};
 
        GDALRATFieldType eType = GFT_Integer;
 
        GDALRATFieldUsage eUsage = GFU_Generic;
 
        std::vector<GInt32> anValues{};
        std::vector<double> adfValues{};
        std::vector<CPLString> aosValues{};
        std::vector<bool> abValues{};
        std::vector<GDALRATDateTime> asDateTimeValues{};
        std::vector<std::vector<GByte>> aabyWKBGeometryValues{};
    };
 
    std::vector<GDALRasterAttributeField> aoFields{};
 
    int bLinearBinning = false;  // TODO(schwehr): Can this be a bool?
    double dfRow0Min = -0.5;
    double dfBinSize = 1.0;
 
    GDALRATTableType eTableType = GRTT_THEMATIC;
 
    void AnalyseColumns();
    int bColumnsAnalysed = false;  // TODO(schwehr): Can this be a bool?
    int nMinCol = -1;
    int nMaxCol = -1;
 
    int nRowCount = 0;
 
    CPLString osWorkingResult{};
    mutable std::vector<GByte> m_abyWKB{};
 
  public:
    GDALDefaultRasterAttributeTable();
    ~GDALDefaultRasterAttributeTable() override;

    GDALDefaultRasterAttributeTable(const GDALDefaultRasterAttributeTable &) =
        default;
    GDALDefaultRasterAttributeTable &
    operator=(const GDALDefaultRasterAttributeTable &) = default;
    GDALDefaultRasterAttributeTable(GDALDefaultRasterAttributeTable &&) =
        default;
    GDALDefaultRasterAttributeTable &
    operator=(GDALDefaultRasterAttributeTable &&) = default;
 
    GDALDefaultRasterAttributeTable *Clone() const override;
 
    int GetColumnCount() const override;
 
    const char *GetNameOfCol(int) const override;
    GDALRATFieldUsage GetUsageOfCol(int) const override;
    GDALRATFieldType GetTypeOfCol(int) const override;
 
    int GetColOfUsage(GDALRATFieldUsage) const override;
 
    int GetRowCount() const override;
 
    const char *GetValueAsString(int iRow, int iField) const override;
    int GetValueAsInt(int iRow, int iField) const override;
    double GetValueAsDouble(int iRow, int iField) const override;
    bool GetValueAsBoolean(int iRow, int iField) const override;
    GDALRATDateTime GetValueAsDateTime(int iRow, int iField) const override;
    const GByte *GetValueAsWKBGeometry(int iRow, int iField,
                                       size_t &nWKBSize) const override;
 
    CPLErr SetValue(int iRow, int iField, const char *pszValue) override;
    CPLErr SetValue(int iRow, int iField, double dfValue) override;
    CPLErr SetValue(int iRow, int iField, int nValue) override;
    CPLErr SetValue(int iRow, int iField, bool bValue) override;
    CPLErr SetValue(int iRow, int iField,
                    const GDALRATDateTime &sDateTime) override;
    CPLErr SetValue(int iRow, int iField, const void *pabyWKB,
                    size_t nWKBSize) override;
 
    int ChangesAreWrittenToFile() override;
    void SetRowCount(int iCount) override;
 
    int GetRowOfValue(double dfValue) const override;
    int GetRowOfValue(int nValue) const override;
 
    CPLErr CreateColumn(const char *pszFieldName, GDALRATFieldType eFieldType,
                        GDALRATFieldUsage eFieldUsage) override;
    CPLErr SetLinearBinning(double dfRow0Min, double dfBinSize) override;
    int GetLinearBinning(double *pdfRow0Min, double *pdfBinSize) const override;
 
    CPLErr SetTableType(const GDALRATTableType eInTableType) override;
    GDALRATTableType GetTableType() const override;
 
    void RemoveStatistics() override;
};
 
std::unique_ptr<GDALRasterAttributeTable>
    CPL_DLL GDALLoadVATDBF(const char *pszFilename);
 
#endif /* ndef GDAL_RAT_H_INCLUDED */