gdal_rat.h

/******************************************************************************
 * $Id: gdal_rat.h 36501 2016-11-25 14:09:24Z rouault $
 *
 * 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"

// 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 GDALDefaultRasterAttributeTable *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        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 * = NULL );
};

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

    GDALRATFieldType  eType;

    GDALRATFieldUsage eUsage;

    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;  // TODO(schwehr): Can this be a bool?
    double dfRow0Min;
    double dfBinSize;

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

    int   nRowCount;

    CPLString osWorkingResult;

 public:
    GDALDefaultRasterAttributeTable();
    GDALDefaultRasterAttributeTable( const GDALDefaultRasterAttributeTable& );
    virtual ~GDALDefaultRasterAttributeTable();

    GDALDefaultRasterAttributeTable *Clone() const CPL_OVERRIDE;

    virtual int           GetColumnCount() const CPL_OVERRIDE;

    virtual const char   *GetNameOfCol( int ) const CPL_OVERRIDE;
    virtual GDALRATFieldUsage GetUsageOfCol( int ) const CPL_OVERRIDE;
    virtual GDALRATFieldType GetTypeOfCol( int ) const CPL_OVERRIDE;

    virtual int           GetColOfUsage( GDALRATFieldUsage ) const CPL_OVERRIDE;

    virtual int           GetRowCount() const CPL_OVERRIDE;

    virtual const char   *GetValueAsString( int iRow, int iField ) const CPL_OVERRIDE;
    virtual int           GetValueAsInt( int iRow, int iField ) const CPL_OVERRIDE;
    virtual double        GetValueAsDouble( int iRow, int iField ) const CPL_OVERRIDE;

    virtual void          SetValue( int iRow, int iField,
                                    const char *pszValue ) CPL_OVERRIDE;
    virtual void          SetValue( int iRow, int iField, double dfValue) CPL_OVERRIDE;
    virtual void          SetValue( int iRow, int iField, int nValue ) CPL_OVERRIDE;

    virtual int           ChangesAreWrittenToFile() CPL_OVERRIDE;
    virtual void          SetRowCount( int iCount ) CPL_OVERRIDE;

    virtual int           GetRowOfValue( double dfValue ) const CPL_OVERRIDE;
    virtual int           GetRowOfValue( int nValue ) const CPL_OVERRIDE;

    virtual CPLErr        CreateColumn( const char *pszFieldName,
                                        GDALRATFieldType eFieldType,
                                        GDALRATFieldUsage eFieldUsage ) CPL_OVERRIDE;
    virtual CPLErr        SetLinearBinning( double dfRow0Min,
                                            double dfBinSize ) CPL_OVERRIDE;
    virtual int           GetLinearBinning( double *pdfRow0Min,
                                            double *pdfBinSize ) const CPL_OVERRIDE;
};

#endif /* ndef GDAL_RAT_H_INCLUDED */