/usr/include/saga_api/table.h is in libsaga-dev 2.1.0+dfsg-1build2.
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 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 | /**********************************************************
* Version $Id: table.h 1728 2013-06-13 09:37:08Z oconrad $
*********************************************************/
///////////////////////////////////////////////////////////
// //
// SAGA //
// //
// System for Automated Geoscientific Analyses //
// //
// Application Programming Interface //
// //
// Library: SAGA_API //
// //
//-------------------------------------------------------//
// //
// table.h //
// //
// Copyright (C) 2005 by Olaf Conrad //
// //
//-------------------------------------------------------//
// //
// This file is part of 'SAGA - System for Automated //
// Geoscientific Analyses'. //
// //
// This library is free software; you can redistribute //
// it and/or modify it under the terms of the GNU Lesser //
// General Public License as published by the Free //
// Software Foundation, version 2.1 of the License. //
// //
// This library is distributed in the hope that it will //
// be useful, but WITHOUT ANY WARRANTY; without even the //
// implied warranty of MERCHANTABILITY or FITNESS FOR A //
// PARTICULAR PURPOSE. See the GNU Lesser General Public //
// License for more details. //
// //
// You should have received a copy of the GNU Lesser //
// General Public License along with this program; if //
// not, write to the Free Software Foundation, Inc., //
// 59 Temple Place - Suite 330, Boston, MA 02111-1307, //
// USA. //
// //
//-------------------------------------------------------//
// //
// contact: Olaf Conrad //
// Institute of Geography //
// University of Goettingen //
// Goldschmidtstr. 5 //
// 37077 Goettingen //
// Germany //
// //
// e-mail: oconrad@saga-gis.org //
// //
///////////////////////////////////////////////////////////
//---------------------------------------------------------
///////////////////////////////////////////////////////////
// //
// //
// //
///////////////////////////////////////////////////////////
//---------------------------------------------------------
#ifndef HEADER_INCLUDED__SAGA_API__table_H
#define HEADER_INCLUDED__SAGA_API__table_H
///////////////////////////////////////////////////////////
// //
// //
// //
///////////////////////////////////////////////////////////
//---------------------------------------------------------
#include "dataobject.h"
#include "table_value.h"
///////////////////////////////////////////////////////////
// //
// //
// //
///////////////////////////////////////////////////////////
//---------------------------------------------------------
typedef enum ESG_Table_FileType
{
TABLE_FILETYPE_Undefined = 0,
TABLE_FILETYPE_Text,
TABLE_FILETYPE_Text_NoHeadLine,
TABLE_FILETYPE_DBase
}
TSG_Table_File_Type;
//---------------------------------------------------------
typedef enum ESG_Table_Index_Order
{
TABLE_INDEX_None = 0,
TABLE_INDEX_Ascending,
TABLE_INDEX_Descending
}
TSG_Table_Index_Order;
///////////////////////////////////////////////////////////
// //
// //
// //
///////////////////////////////////////////////////////////
//---------------------------------------------------------
#define SG_TABLE_REC_FLAG_Modified 0x01
#define SG_TABLE_REC_FLAG_Selected 0x02
///////////////////////////////////////////////////////////
// //
// //
// //
///////////////////////////////////////////////////////////
//---------------------------------------------------------
class SAGA_API_DLL_EXPORT CSG_Table_Record
{
friend class CSG_Table;
public:
class CSG_Table * Get_Table (void) { return( m_pTable ); }
int Get_Index (void) const { return( m_Index ); }
bool Set_Value (int iField, const CSG_Bytes &Value);
bool Set_Value (const CSG_String &Field, const CSG_Bytes &Value);
bool Set_Value (int iField, const CSG_String &Value);
bool Set_Value (const CSG_String &Field, const CSG_String &Value);
bool Set_Value (int iField, double Value);
bool Set_Value (const CSG_String &Field, double Value);
bool Add_Value (int iField, double Value);
bool Add_Value (const CSG_String &Field, double Value);
bool Mul_Value (int iField, double Value);
bool Mul_Value (const CSG_String &Field, double Value);
bool Set_NoData (int iField);
bool Set_NoData (const CSG_String &Field);
bool is_NoData (int iField) const;
bool is_NoData (const CSG_String &Field) const;
const SG_Char * asString (int iField, int Decimals = -1) const;
const SG_Char * asString (const CSG_String &Field, int Decimals = -1) const;
SG_Char asChar (int iField) const { return( (SG_Char)asInt (iField) ); }
SG_Char asChar (const CSG_String &Field) const { return( (SG_Char)asInt ( Field) ); }
short asShort (int iField) const { return( (short )asInt (iField) ); }
short asShort (const CSG_String &Field) const { return( (short )asInt ( Field) ); }
int asInt (int iField) const;
int asInt (const CSG_String &Field) const;
float asFloat (int iField) const { return( (float )asDouble(iField) ); }
float asFloat (const CSG_String &Field) const { return( (float )asDouble( Field) ); }
double asDouble (int iField) const;
double asDouble (const CSG_String &Field) const;
CSG_Table_Value * Get_Value (int iField) { return( m_Values[iField] ); }
CSG_Table_Value & operator [] (int iField) const { return( *m_Values[iField] ); }
virtual bool Assign (CSG_Table_Record *pRecord);
bool is_Selected (void) const { return( (m_Flags & SG_TABLE_REC_FLAG_Selected) != 0 ); }
bool is_Modified (void) const { return( (m_Flags & SG_TABLE_REC_FLAG_Modified) != 0 ); }
protected:
CSG_Table_Record(class CSG_Table *pTable, int Index);
virtual ~CSG_Table_Record(void);
char m_Flags;
int m_Index;
class CSG_Table_Value **m_Values;
class CSG_Table *m_pTable;
void Set_Selected (bool bOn = true);
void Set_Modified (bool bOn = true);
static CSG_Table_Value * _Create_Value (TSG_Data_Type Type);
bool _Add_Field (int add_Field);
bool _Del_Field (int del_Field);
int _Get_Field (const CSG_String &Field) const;
};
///////////////////////////////////////////////////////////
// //
// //
// //
///////////////////////////////////////////////////////////
//---------------------------------------------------------
class SAGA_API_DLL_EXPORT CSG_Table : public CSG_Data_Object
{
friend class CSG_Table_Record;
friend class CSG_TIN;
public:
CSG_Table(void);
CSG_Table (const CSG_Table &Table);
bool Create (const CSG_Table &Table);
CSG_Table (const CSG_String &File_Name, TSG_Table_File_Type Format = TABLE_FILETYPE_Undefined);
bool Create (const CSG_String &File_Name, TSG_Table_File_Type Format = TABLE_FILETYPE_Undefined);
CSG_Table (const CSG_String &File_Name, TSG_Table_File_Type Format, const SG_Char *Separator);
bool Create (const CSG_String &File_Name, TSG_Table_File_Type Format, const SG_Char *Separator);
CSG_Table (CSG_Table *pTemplate);
bool Create (CSG_Table *pTemplate);
virtual ~CSG_Table(void);
virtual bool Destroy (void);
virtual TSG_Data_Object_Type Get_ObjectType (void) const { return( DATAOBJECT_TYPE_Table ); }
virtual bool Assign (CSG_Data_Object *pSource);
bool Assign_Values (CSG_Table *pTable);
virtual bool Save (const CSG_String &File_Name, int Format = 0);
virtual bool Save (const CSG_String &File_Name, int Format, const SG_Char *Separator);
bool Serialize (CSG_File &Stream, bool bSave);
//-----------------------------------------------------
virtual bool is_Valid (void) const { return( m_nFields > 0 ); }
bool is_Compatible (CSG_Table *pTable, bool bExactMatch = false) const;
//-----------------------------------------------------
virtual bool Add_Field (const CSG_String &Name, TSG_Data_Type Type, int iField = -1);
virtual bool Del_Field (int iField);
int Get_Field_Count (void) const { return( m_nFields ); }
const SG_Char * Get_Field_Name (int iField) const { return( iField >= 0 && iField < m_nFields ? m_Field_Name[iField]->c_str() : NULL ); }
TSG_Data_Type Get_Field_Type (int iField) const { return( iField >= 0 && iField < m_nFields ? m_Field_Type[iField] : SG_DATATYPE_Undefined ); }
int Get_Field_Length (int iField) const; // returns the maximum number of characters for data type string and zero for all other data types.
bool Set_Field_Name (int iField, const SG_Char *Name);
bool Set_Field_Type (int iField, TSG_Data_Type Type);
double Get_Minimum (int iField) const { return( _Stats_Update(iField) ? m_Field_Stats[iField]->Get_Minimum() : 0.0 ); }
double Get_Maximum (int iField) const { return( _Stats_Update(iField) ? m_Field_Stats[iField]->Get_Maximum() : 0.0 ); }
double Get_Range (int iField) const { return( _Stats_Update(iField) ? m_Field_Stats[iField]->Get_Range() : 0.0 ); }
double Get_Mean (int iField) const { return( _Stats_Update(iField) ? m_Field_Stats[iField]->Get_Mean() : 0.0 ); }
double Get_StdDev (int iField) const { return( _Stats_Update(iField) ? m_Field_Stats[iField]->Get_StdDev() : 0.0 ); }
double Get_Variance (int iField) const { return( _Stats_Update(iField) ? m_Field_Stats[iField]->Get_Variance() : 0.0 ); }
//-----------------------------------------------------
virtual CSG_Table_Record * Add_Record ( CSG_Table_Record *pCopy = NULL);
virtual CSG_Table_Record * Ins_Record (int iRecord, CSG_Table_Record *pCopy = NULL);
virtual bool Del_Record (int iRecord);
virtual bool Del_Records (void);
virtual bool Set_Record_Count (int nRecords);
int Get_Count (void) const { return( m_nRecords ); }
int Get_Record_Count (void) const { return( m_nRecords ); }
virtual CSG_Table_Record * Get_Record (int iRecord) const { return( iRecord >= 0 && iRecord < m_nRecords ? m_Records[iRecord] : NULL ); }
virtual CSG_Table_Record & operator [] (int iRecord) const { return( *Get_Record_byIndex(iRecord) ); }
int Get_Index (int Index) const { return( Index >= 0 && Index < m_nRecords ? (m_Index ? m_Index[Index] : Index) : -1 ); }
CSG_Table_Record * Get_Record_byIndex (int Index) const
{
if( Index >= 0 && Index < m_nRecords )
{
if( m_Index != NULL )
{
return( m_Records[m_Index[Index]] );
}
return( m_Records[Index] );
}
return( NULL );
}
//-----------------------------------------------------
virtual bool Set_Value (int iRecord, int iField, const SG_Char *Value);
virtual bool Set_Value (int iRecord, int iField, double Value);
virtual bool Get_Value (int iRecord, int iField, CSG_String &Value) const;
virtual bool Get_Value (int iRecord, int iField, double &Value) const;
virtual void Set_Modified (bool bModified = true);
//-----------------------------------------------------
int Get_Selection_Count (void) const { return( m_nSelected ); }
virtual CSG_Table_Record * Get_Selection (int Index = 0) const { return( Index >= 0 && Index < m_nSelected ? Get_Record(m_Selected[Index]) : NULL ); }
virtual bool is_Selected (int iRecord) const { return( iRecord >= 0 && iRecord < m_nRecords ? m_Records[iRecord]->is_Selected() : false ); }
virtual bool Select (int iRecord , bool bInvert = false);
virtual bool Select (CSG_Table_Record *pRecord = NULL , bool bInvert = false);
virtual int Del_Selection (void);
virtual int Inv_Selection (void);
//-----------------------------------------------------
bool Set_Index (int Field_1, TSG_Table_Index_Order Order_1, int Field_2 = -1, TSG_Table_Index_Order Order_2 = TABLE_INDEX_None, int Field_3 = -1, TSG_Table_Index_Order Order_3 = TABLE_INDEX_None);
bool Del_Index (void);
bool Toggle_Index (int iField);
bool is_Indexed (void) const { return( m_Index != NULL ); }
int Get_Index_Field (int i) const { return( i >= 0 && i < 3 ? m_Index_Field[i] : -1 ); }
TSG_Table_Index_Order Get_Index_Order (int i) const { return( i >= 0 && i < 3 ? m_Index_Order[i] : TABLE_INDEX_None ); }
protected:
int m_nFields, m_nRecords, m_nBuffer, m_nSelected;
TSG_Data_Type *m_Field_Type;
CSG_String **m_Field_Name;
CSG_Simple_Statistics **m_Field_Stats;
virtual void _On_Construction (void);
virtual CSG_Table_Record * _Get_New_Record (int Index);
bool _Stats_Invalidate (void) const;
bool _Stats_Invalidate (int iField) const;
virtual bool _Stats_Update (int iField) const;
private:
int *m_Index, m_Index_Field[3], *m_Selected;
TSG_Table_Index_Order m_Index_Order[3];
CSG_Table_Record **m_Records;
bool _Destroy_Selection (void);
bool _Inc_Array (void);
bool _Dec_Array (void);
bool _Load (const CSG_String &File_Name, TSG_Table_File_Type Format, const SG_Char *Separator);
bool _Load_Text (const CSG_String &File_Name, bool bHeadline, const SG_Char *Separator);
bool _Save_Text (const CSG_String &File_Name, bool bHeadline, const SG_Char *Separator);
bool _Load_DBase (const CSG_String &File_Name);
bool _Save_DBase (const CSG_String &File_Name);
void _Index_Create (void);
void _Index_Destroy (void);
int _Index_Compare (int a, int b);
int _Index_Compare (int a, int b, int Field);
};
///////////////////////////////////////////////////////////
// //
// //
// //
///////////////////////////////////////////////////////////
//---------------------------------------------------------
/** Safe table construction */
SAGA_API_DLL_EXPORT CSG_Table * SG_Create_Table (void);
/** Safe table construction */
SAGA_API_DLL_EXPORT CSG_Table * SG_Create_Table (const CSG_Table &Table);
/** Safe table construction */
SAGA_API_DLL_EXPORT CSG_Table * SG_Create_Table (const CSG_String &File_Name);
/** Safe table construction */
SAGA_API_DLL_EXPORT CSG_Table * SG_Create_Table (CSG_Table *pTemplate);
///////////////////////////////////////////////////////////
// //
// //
// //
///////////////////////////////////////////////////////////
//---------------------------------------------------------
#endif // #ifndef HEADER_INCLUDED__SAGA_API__table_H
|