gdal_rat.h

/******************************************************************************
 * $Id: gdal_rat.h 2519a7eb0e1649dbf8625ae8ffc7bb7c3ef9514b 2018-07-10 12:05:23 +0100 Robert Coup $
 *
 * Project:  GDAL Core
 * Purpose:  GDALRasterAttributeTable class declarations.
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *
 ******************************************************************************
 * Copyright (c) 2005, Frank Warmerdam <warmerdam@pobox.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/

#ifndef GDAL_RAT_H_INCLUDED
#define GDAL_RAT_H_INCLUDED

#include "cpl_minixml.h"
#include "gdal_priv.h"

// 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 void          SetValue( int iRow, int iField,
                                    const char *pszValue ) = 0;

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

    virtual void          SetValue( int iRow, int iField, double dfValue) = 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 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( 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;
};

/************************************************************************/
/*                       GDALRasterAttributeField                       */
/*                                                                      */
/*      (private)                                                       */
/************************************************************************/
class GDALRasterAttributeField
{
 public:
    CPLString         sName{};

    GDALRATFieldType  eType = GFT_Integer;

    GDALRATFieldUsage eUsage = GFU_Generic;

    std::vector<GInt32> anValues{};
    std::vector<double> adfValues{};
    std::vector<CPLString> aosValues{};
};

/************************************************************************/
/*                    GDALDefaultRasterAttributeTable                   */
/************************************************************************/


class CPL_DLL GDALDefaultRasterAttributeTable : public GDALRasterAttributeTable
{
 private:
    std::vector<GDALRasterAttributeField> aoFields{};

    int bLinearBinning = false;  // TODO(schwehr): Can this be a bool?
    double dfRow0Min = -0.5;
    double dfBinSize = 1.0;

    GDALRATTableType eTableType;

    void  AnalyseColumns();
    int   bColumnsAnalysed = false;  // TODO(schwehr): Can this be a bool?
    int   nMinCol = -1;
    int   nMaxCol = -1;

    int   nRowCount = 0;

    CPLString osWorkingResult{};

 public:
    GDALDefaultRasterAttributeTable();
    ~GDALDefaultRasterAttributeTable() override;

    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;

    void SetValue( int iRow, int iField,
                   const char *pszValue ) override;
    void SetValue( int iRow, int iField, double dfValue) override;
    void SetValue( int iRow, int iField, int nValue ) 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;
};

#endif /* ndef GDAL_RAT_H_INCLUDED */