/usr/include/gdal/gdal_rat.h is in libgdal-dev 2.2.3+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 | /******************************************************************************
* $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 */
/************************************************************************/
//! Raster Attribute Table interface.
class GDALDefaultRasterAttributeTable;
class CPL_DLL GDALRasterAttributeTable
{
public:
virtual ~GDALRasterAttributeTable();
/**
* \brief Copy Raster Attribute Table
*
* Creates a new copy of an existing raster attribute table. The new copy
* becomes the responsibility of the caller to destroy.
* May fail (return NULL) if the attribute table is too large to clone
* (GetRowCount() * GetColCount() > RAT_MAX_ELEM_FOR_CLONE)
*
* This method is the same as the C function GDALRATClone().
*
* @return new copy of the RAT as an in-memory implementation.
*/
virtual GDALDefaultRasterAttributeTable *Clone() const = 0;
/**
* \brief Fetch table column count.
*
* This method is the same as the C function GDALRATGetColumnCount().
*
* @return the number of columns.
*/
virtual int GetColumnCount() const = 0;
/**
* \brief Fetch name of indicated column.
*
* This method is the same as the C function GDALRATGetNameOfCol().
*
* @param iCol the column index (zero based).
*
* @return the column name or an empty string for invalid column numbers.
*/
virtual const char *GetNameOfCol( int iCol ) const = 0;
/**
* \brief Fetch column usage value.
*
* This method is the same as the C function GDALRATGetUsageOfCol().
*
* @param iCol the column index (zero based).
*
* @return the column usage, or GFU_Generic for improper column numbers.
*/
virtual GDALRATFieldUsage GetUsageOfCol( int iCol ) const = 0;
/**
* \brief Fetch column type.
*
* This method is the same as the C function GDALRATGetTypeOfCol().
*
* @param iCol the column index (zero based).
*
* @return column type or GFT_Integer if the column index is illegal.
*/
virtual GDALRATFieldType GetTypeOfCol( int iCol ) const = 0;
/**
* \brief Fetch column index for given usage.
*
* Returns the index of the first column of the requested usage type, or -1
* if no match is found.
*
* This method is the same as the C function GDALRATGetUsageOfCol().
*
* @param eUsage usage type to search for.
*
* @return column index, or -1 on failure.
*/
virtual int GetColOfUsage( GDALRATFieldUsage eUsage ) const = 0;
/**
* \brief Fetch row count.
*
* This method is the same as the C function GDALRATGetRowCount().
*
* @return the number of rows.
*/
virtual int GetRowCount() const = 0;
/**
* \brief Fetch field value as a string.
*
* The value of the requested column in the requested row is returned
* as a string. If the field is numeric, it is formatted as a string
* using default rules, so some precision may be lost.
*
* The returned string is temporary and cannot be expected to be
* available after the next GDAL call.
*
* This method is the same as the C function GDALRATGetValueAsString().
*
* @param iRow row to fetch (zero based).
* @param iField column to fetch (zero based).
*
* @return field value.
*/
virtual const char *GetValueAsString( int iRow, int iField ) const = 0;
/**
* \brief Fetch field value as a integer.
*
* The value of the requested column in the requested row is returned
* as an integer. Non-integer fields will be converted to integer with
* the possibility of data loss.
*
* This method is the same as the C function GDALRATGetValueAsInt().
*
* @param iRow row to fetch (zero based).
* @param iField column to fetch (zero based).
*
* @return field value
*/
virtual int GetValueAsInt( int iRow, int iField ) const = 0;
/**
* \brief Fetch field value as a double.
*
* The value of the requested column in the requested row is returned
* as a double. Non double fields will be converted to double with
* the possibility of data loss.
*
* This method is the same as the C function GDALRATGetValueAsDouble().
*
* @param iRow row to fetch (zero based).
* @param iField column to fetch (zero based).
*
* @return field value
*/
virtual double GetValueAsDouble( int iRow, int iField ) const = 0;
/**
* \brief Set field value from string.
*
* The indicated field (column) on the indicated row is set from the
* passed value. The value will be automatically converted for other field
* types, with a possible loss of precision.
*
* This method is the same as the C function GDALRATSetValueAsString().
*
* @param iRow row to fetch (zero based).
* @param iField column to fetch (zero based).
* @param pszValue the value to assign.
*/
virtual void SetValue( int iRow, int iField,
const char *pszValue ) = 0;
/**
* \brief Set field value from integer.
*
* The indicated field (column) on the indicated row is set from the
* passed value. The value will be automatically converted for other field
* types, with a possible loss of precision.
*
* This method is the same as the C function GDALRATSetValueAsInteger().
*
* @param iRow row to fetch (zero based).
* @param iField column to fetch (zero based).
* @param nValue the value to assign.
*/
virtual void SetValue( int iRow, int iField, int nValue ) = 0;
/**
* \brief Set field value from double.
*
* The indicated field (column) on the indicated row is set from the
* passed value. The value will be automatically converted for other field
* types, with a possible loss of precision.
*
* This method is the same as the C function GDALRATSetValueAsDouble().
*
* @param iRow row to fetch (zero based).
* @param iField column to fetch (zero based).
* @param dfValue the value to assign.
*/
virtual void SetValue( int iRow, int iField, double dfValue) = 0;
/**
* \brief Determine whether changes made to this RAT are reflected directly
* in the dataset
*
* If this returns FALSE then GDALRasterBand.SetDefaultRAT() should be
* called. Otherwise this is unnecessary since changes to this object are
* reflected in the dataset.
*
* This method is the same as the C function
* GDALRATChangesAreWrittenToFile().
*
*/
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;
/**
* \brief Serialize
*
* May fail (return NULL) if the attribute table is too large to serialize
* (GetRowCount() * GetColCount() > RAT_MAX_ELEM_FOR_CLONE)
*/
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) */
/************************************************************************/
//! @cond Doxygen_Suppress
class GDALRasterAttributeField
{
public:
CPLString sName;
GDALRATFieldType eType;
GDALRATFieldUsage eUsage;
std::vector<GInt32> anValues;
std::vector<double> adfValues;
std::vector<CPLString> aosValues;
};
//! @endcond
/************************************************************************/
/* GDALDefaultRasterAttributeTable */
/************************************************************************/
//! Raster Attribute Table container.
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 */
|