SAGA API Version 9.12
Loading...
Searching...
No Matches
api_core.h File Reference
#include <math.h>
#include <memory.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <wchar.h>
#include <string>

Go to the source code of this file.

Classes

class  CSG_Buffer
class  CSG_Array
class  CSG_Array_Pointer
class  CSG_Array_Int
class  CSG_Array_sLong
class  CSG_String
class  CSG_Strings
class  CSG_String_Tokenizer
class  CSG_Text_Format_Converter
class  CSG_Bytes
class  CSG_Bytes_Array
class  CSG_Stack
class  CSG_File
class  CSG_Archive
class  CSG_ZLib
class  CSG_Colors
class  CSG_Translator
class  CSG_UI_Parameter

Macros

#define _SAGA_DLL_EXPORT
#define _SAGA_DLL_IMPORT
#define SAGA_API_DLL_EXPORT   _SAGA_DLL_IMPORT
#define SIZEOF_LONG   4
#define SG_is_NaN(x)
#define SG_GET_LONG(b0, b1, b2, b3)
#define SG_GET_BYTE_0(vLong)
#define SG_GET_BYTE_1(vLong)
#define SG_GET_BYTE_2(vLong)
#define SG_GET_BYTE_3(vLong)
#define SG_FREE_SAFE(PTR)
#define SG_DELETE_SAFE(PTR)
#define SG_DELETE_ARRAY(PTR)
#define SG_Char   wchar_t
#define SG_T(s)
#define SG_PRINTF   wprintf
#define SG_FPRINTF   fwprintf
#define SG_SSCANF   swscanf
#define SG_STR_CPY   wcscpy
#define SG_STR_LEN   wcslen
#define SG_STR_TOD   wcstod
#define SG_STR_CMP(s1, s2)
#define SG_STR_MBTOSG(s)
#define SG_DEFAULT_DELIMITERS   " \t\r\n"
#define SG_DATATYPES_Undefined   0x0000
#define SG_DATATYPES_Bit   0x0001
#define SG_DATATYPES_Byte   0x0002
#define SG_DATATYPES_Char   0x0004
#define SG_DATATYPES_Word   0x0008
#define SG_DATATYPES_Short   0x0010
#define SG_DATATYPES_DWord   0x0020
#define SG_DATATYPES_Int   0x0040
#define SG_DATATYPES_ULong   0x0080
#define SG_DATATYPES_Long   0x0100
#define SG_DATATYPES_Float   0x0200
#define SG_DATATYPES_Double   0x0400
#define SG_DATATYPES_String   0x0800
#define SG_DATATYPES_Date   0x1000
#define SG_DATATYPES_Color   0x2000
#define SG_DATATYPES_Binary   0x4000
#define SG_DATATYPES_Standard   0xFFFF
#define SG_DATATYPES_SInteger   (SG_DATATYPES_Char|SG_DATATYPES_Short|SG_DATATYPES_Int |SG_DATATYPES_Long)
#define SG_DATATYPES_UInteger   (SG_DATATYPES_Byte|SG_DATATYPES_Word |SG_DATATYPES_DWord|SG_DATATYPES_ULong)
#define SG_DATATYPES_Integer   (SG_DATATYPES_SInteger|SG_DATATYPES_UInteger)
#define SG_DATATYPES_Real   (SG_DATATYPES_Float|SG_DATATYPES_Double)
#define SG_DATATYPES_Numeric   (SG_DATATYPES_Integer|SG_DATATYPES_Real)
#define SG_DATATYPES_Table   (SG_DATATYPES_String|SG_DATATYPES_Date|SG_DATATYPES_Color|SG_DATATYPES_Numeric|SG_DATATYPES_Binary)
#define CSG_File_Zip   CSG_Archive
#define SG_GET_RGB(r, g, b)
#define SG_GET_RGBA(r, g, b, a)
#define SG_GET_R(rgb)
#define SG_GET_G(rgb)
#define SG_GET_B(rgb)
#define SG_GET_A(rgb)
#define SG_COLOR_BLACK   SG_GET_RGB( 0, 0, 0)
#define SG_COLOR_GREY   SG_GET_RGB(128, 128, 128)
#define SG_COLOR_GREY_LIGHT   SG_GET_RGB(192, 192, 192)
#define SG_COLOR_WHITE   SG_GET_RGB(255, 255, 255)
#define SG_COLOR_RED   SG_GET_RGB(255, 0, 0)
#define SG_COLOR_RED_DARK   SG_GET_RGB(128, 0, 0)
#define SG_COLOR_YELLOW   SG_GET_RGB(255, 255, 0)
#define SG_COLOR_YELLOW_DARK   SG_GET_RGB(128, 128, 0)
#define SG_COLOR_GREEN   SG_GET_RGB( 0, 255, 0)
#define SG_COLOR_GREEN_DARK   SG_GET_RGB( 0, 128, 0)
#define SG_COLOR_GREEN_LIGHT   SG_GET_RGB( 0, 255, 0)
#define SG_COLOR_BLUE   SG_GET_RGB( 0, 0, 255)
#define SG_COLOR_BLUE_DARK   SG_GET_RGB( 0, 0, 128)
#define SG_COLOR_BLUE_LIGHT   SG_GET_RGB( 0, 255, 255)
#define SG_COLOR_BLUE_GREEN   SG_GET_RGB( 0, 128, 128)
#define SG_COLOR_PURPLE   SG_GET_RGB(128, 0, 128)
#define SG_COLOR_PINK   SG_GET_RGB(255, 0, 255)
#define SG_COLOR_NONE   -1
#define SG_COLOR_RANDOM   -2
#define _TL(s)
#define _TW(s)

Typedefs

typedef signed long long sLong
typedef unsigned long long uLong
typedef int(* TSG_PFNC_UI_Callback) (TSG_UI_Callback_ID ID, CSG_UI_Parameter &Param_1, CSG_UI_Parameter &Param_2)

Enumerations

enum class  TSG_Array_Growth {
  SG_ARRAY_GROWTH_0 = 0 , SG_ARRAY_GROWTH_1 , SG_ARRAY_GROWTH_2 , SG_ARRAY_GROWTH_3 ,
  SG_ARRAY_GROWTH_FIX_8 , SG_ARRAY_GROWTH_FIX_16 , SG_ARRAY_GROWTH_FIX_32 , SG_ARRAY_GROWTH_FIX_64 ,
  SG_ARRAY_GROWTH_FIX_128 , SG_ARRAY_GROWTH_FIX_256 , SG_ARRAY_GROWTH_FIX_512 , SG_ARRAY_GROWTH_FIX_1024
}
enum  TSG_File_Flags_Encoding {
  SG_FILE_ENCODING_ANSI , SG_FILE_ENCODING_UTF7 , SG_FILE_ENCODING_UTF8 , SG_FILE_ENCODING_UTF16LE ,
  SG_FILE_ENCODING_UTF16BE , SG_FILE_ENCODING_UTF32LE , SG_FILE_ENCODING_UTF32BE , SG_FILE_ENCODING_UNDEFINED
}
enum  TSG_String_Tokenizer_Mode {
  SG_TOKEN_INVALID , SG_TOKEN_DEFAULT , SG_TOKEN_RET_EMPTY , SG_TOKEN_RET_EMPTY_ALL ,
  SG_TOKEN_RET_DELIMS , SG_TOKEN_STRTOK
}
enum  TSG_Data_Type {
  SG_DATATYPE_Bit = 0 , SG_DATATYPE_Byte , SG_DATATYPE_Char , SG_DATATYPE_Word ,
  SG_DATATYPE_Short , SG_DATATYPE_DWord , SG_DATATYPE_Int , SG_DATATYPE_ULong ,
  SG_DATATYPE_Long , SG_DATATYPE_Float , SG_DATATYPE_Double , SG_DATATYPE_String ,
  SG_DATATYPE_Date , SG_DATATYPE_Color , SG_DATATYPE_Binary , SG_DATATYPE_Undefined
}
enum  TSG_File_Type { SG_FILE_TYPE_NORMAL , SG_FILE_TYPE_ZIP , SG_FILE_TYPE_TAR }
enum  ESG_File_Flags_Open { SG_FILE_R , SG_FILE_W , SG_FILE_RW }
enum  ESG_File_Flags_Seek { SG_FILE_START , SG_FILE_CURRENT , SG_FILE_END }
enum  ESG_Colors {
  SG_COLORS_DEFAULT = 0 , SG_COLORS_DEFAULT_BRIGHT , SG_COLORS_RAINBOW , SG_COLORS_RAINBOW_2 ,
  SG_COLORS_BLACK_WHITE , SG_COLORS_BLACK_RED , SG_COLORS_BLACK_GREEN , SG_COLORS_BLACK_BLUE ,
  SG_COLORS_WHITE_RED , SG_COLORS_WHITE_GREEN , SG_COLORS_WHITE_BLUE , SG_COLORS_CYAN_WHITE ,
  SG_COLORS_MAGENTA_WHITE , SG_COLORS_YELLOW_WHITE , SG_COLORS_YELLOW_RED , SG_COLORS_YELLOW_GREEN ,
  SG_COLORS_YELLOW_BLUE , SG_COLORS_BLUE_RED , SG_COLORS_GREEN_RED , SG_COLORS_GREEN_BLUE ,
  SG_COLORS_BLUE_WHITE_RED , SG_COLORS_GREEN_WHITE_RED , SG_COLORS_GREEN_WHITE_BLUE , SG_COLORS_BLUE_GREY_RED ,
  SG_COLORS_RED_GREY_BLUE , SG_COLORS_GREEN_GREY_RED , SG_COLORS_RED_GREY_GREEN , SG_COLORS_GREEN_GREY_BLUE ,
  SG_COLORS_BLUE_YELLOW_RED , SG_COLORS_GREEN_YELLOW_RED , SG_COLORS_RED_YELLOW_GREEN , SG_COLORS_GREEN_YELLOW_BLUE ,
  SG_COLORS_RED_GREEN_BLUE , SG_COLORS_RED_BLUE_GREEN , SG_COLORS_GREEN_RED_BLUE , SG_COLORS_NEON ,
  SG_COLORS_TOPOGRAPHY , SG_COLORS_TOPOGRAPHY_2 , SG_COLORS_TOPOGRAPHY_3 , SG_COLORS_TOPOGRAPHY_4 ,
  SG_COLORS_ASPECT_1 , SG_COLORS_ASPECT_2 , SG_COLORS_ASPECT_3 , SG_COLORS_THERMAL_1 ,
  SG_COLORS_THERMAL_2 , SG_COLORS_PRECIPITATION_1 , SG_COLORS_PRECIPITATION_2 , SG_COLORS_PRECIPITATION_3 ,
  SG_COLORS_PRECIPITATION_4 , SG_COLORS_PRECIPITATION_5 , SG_COLORS_VEGETATION , SG_COLORS_SPECTRUM_1 ,
  SG_COLORS_SPECTRUM_2 , SG_COLORS_SPECTRUM_3 , SG_COLORS_COUNT
}
enum  TSG_UI_MSG_STYLE {
  SG_UI_MSG_STYLE_NORMAL = 0 , SG_UI_MSG_STYLE_BOLD , SG_UI_MSG_STYLE_ITALIC , SG_UI_MSG_STYLE_SUCCESS ,
  SG_UI_MSG_STYLE_FAILURE , SG_UI_MSG_STYLE_BIG , SG_UI_MSG_STYLE_SMALL , SG_UI_MSG_STYLE_01 ,
  SG_UI_MSG_STYLE_02 , SG_UI_MSG_STYLE_03
}
enum  TSG_UI_DataObject_Update {
  SG_UI_DATAOBJECT_UPDATE = 0 , SG_UI_DATAOBJECT_SHOW_MAP , SG_UI_DATAOBJECT_SHOW_MAP_ACTIVE , SG_UI_DATAOBJECT_SHOW_MAP_NEW ,
  SG_UI_DATAOBJECT_SHOW_MAP_LAST
}
enum  TSG_UI_Maps { SG_UI_MAP_ACTIVE = 0 , SG_UI_MAP_LAST , SG_UI_MAP_ALL }
enum  TSG_UI_Window_Arrange {
  SG_UI_WINDOW_ARRANGE_MDI_CASCADE = 0x0001 , SG_UI_WINDOW_ARRANGE_MDI_TILE_VER = 0x0002 , SG_UI_WINDOW_ARRANGE_MDI_TILE_HOR = 0x0004 , SG_UI_WINDOW_ARRANGE_TDI_TILE_VER = 0x0008 ,
  SG_UI_WINDOW_ARRANGE_TDI_TILE_HOR = 0x0010 , SG_UI_WINDOW_ARRANGE_TDI_SPLIT_LEFT = 0x0020 , SG_UI_WINDOW_ARRANGE_TDI_SPLIT_RIGHT = 0x0040 , SG_UI_WINDOW_ARRANGE_TDI_SPLIT_TOP = 0x0080 ,
  SG_UI_WINDOW_ARRANGE_TDI_SPLIT_BOTTOM = 0x0100
}
enum  TSG_UI_Callback_ID {
  CALLBACK_PROCESS_GET_OKAY , CALLBACK_PROCESS_SET_OKAY , CALLBACK_PROCESS_SET_BUSY , CALLBACK_PROCESS_SET_PROGRESS ,
  CALLBACK_PROCESS_SET_READY , CALLBACK_PROCESS_SET_TEXT , CALLBACK_STOP_EXECUTION , CALLBACK_DLG_MESSAGE ,
  CALLBACK_DLG_CONTINUE , CALLBACK_DLG_ERROR , CALLBACK_DLG_INFO , CALLBACK_DLG_PARAMETERS ,
  CALLBACK_MESSAGE_ADD , CALLBACK_MESSAGE_ADD_ERROR , CALLBACK_MESSAGE_ADD_EXECUTION , CALLBACK_DATAOBJECT_ADD ,
  CALLBACK_DATAOBJECT_DEL , CALLBACK_DATAOBJECT_UPDATE , CALLBACK_DATAOBJECT_SHOW , CALLBACK_DATAOBJECT_ASIMAGE ,
  CALLBACK_DATAOBJECT_COLORS_GET , CALLBACK_DATAOBJECT_COLORS_SET , CALLBACK_DATAOBJECT_CLASSIFY , CALLBACK_DATAOBJECT_PARAMS_GET ,
  CALLBACK_DATAOBJECT_PARAMS_SET , CALLBACK_SET_MAP_EXTENT , CALLBACK_DIAGRAM_SHOW , CALLBACK_DATABASE_UPDATE ,
  CALLBACK_WINDOW_ARRANGE , CALLBACK_GET_APP_WINDOW , CALLBACK_GET_APP_PATH
}

Functions

SAGA_API_DLL_EXPORT void SG_OMP_Set_Max_Num_Threads (int iCores)
SAGA_API_DLL_EXPORT int SG_OMP_Get_Max_Num_Threads (void)
SAGA_API_DLL_EXPORT int SG_OMP_Get_Max_Num_Procs (void)
SAGA_API_DLL_EXPORT int SG_OMP_Get_Thread_Num (void)
SAGA_API_DLL_EXPORT void * SG_Malloc (size_t size)
SAGA_API_DLL_EXPORT void * SG_Calloc (size_t num, size_t size)
SAGA_API_DLL_EXPORT void * SG_Realloc (void *memblock, size_t size)
SAGA_API_DLL_EXPORT void SG_Free (void *memblock)
SAGA_API_DLL_EXPORT void SG_Swap_Bytes (void *Buffer, int nBytes)
SAGA_API_DLL_EXPORT int SG_Mem_Get_Int (const char *Buffer, bool bSwapBytes)
SAGA_API_DLL_EXPORT void SG_Mem_Set_Int (char *Buffer, int Value, bool bSwapBytes)
SAGA_API_DLL_EXPORT double SG_Mem_Get_Double (const char *Buffer, bool bSwapBytes)
SAGA_API_DLL_EXPORT void SG_Mem_Set_Double (char *Buffer, double Value, bool bSwapBytes)
SAGA_API_DLL_EXPORT CSG_String operator+ (const char *A, const CSG_String &B)
SAGA_API_DLL_EXPORT CSG_String operator+ (const wchar_t *A, const CSG_String &B)
SAGA_API_DLL_EXPORT CSG_String operator+ (char A, const CSG_String &B)
SAGA_API_DLL_EXPORT CSG_String operator+ (wchar_t A, const CSG_String &B)
SAGA_API_DLL_EXPORT CSG_Strings SG_String_Tokenize (const CSG_String &String, const CSG_String &Delimiters=SG_DEFAULT_DELIMITERS, TSG_String_Tokenizer_Mode Mode=SG_TOKEN_DEFAULT)
SAGA_API_DLL_EXPORT bool SG_is_Character_Numeric (int Character)
SAGA_API_DLL_EXPORT CSG_String SG_Get_CurrentTimeStr (bool bWithDate=true)
SAGA_API_DLL_EXPORT double SG_Degree_To_Double (const CSG_String &String)
SAGA_API_DLL_EXPORT CSG_String SG_Double_To_Degree (double Value)
SAGA_API_DLL_EXPORT int SG_Get_Significant_Decimals (double Value, int maxDecimals=6)
SAGA_API_DLL_EXPORT void SG_Flip_Decimal_Separators (CSG_String &String)
SAGA_API_DLL_EXPORT CSG_String SG_Get_String (double Value, int Precision=-99)
SAGA_API_DLL_EXPORT CSG_String SG_Get_String (int Value, int Precision=0)
SAGA_API_DLL_EXPORT CSG_String SG_HTML_Tag_Replacer (const CSG_String &Text)
size_t SG_Data_Type_Get_Size (TSG_Data_Type Type)
SAGA_API_DLL_EXPORT CSG_String SG_Data_Type_Get_Name (TSG_Data_Type Type, bool bShort=false)
SAGA_API_DLL_EXPORT CSG_String SG_Data_Type_Get_Identifier (TSG_Data_Type Type)
SAGA_API_DLL_EXPORT TSG_Data_Type SG_Data_Type_Get_Type (const CSG_String &Identifier)
SAGA_API_DLL_EXPORT int SG_Data_Type_Get_Flag (TSG_Data_Type Type)
SAGA_API_DLL_EXPORT bool SG_Data_Type_is_Numeric (TSG_Data_Type Type)
SAGA_API_DLL_EXPORT bool SG_Data_Type_Range_Check (TSG_Data_Type Type, double &Value)
SAGA_API_DLL_EXPORT bool SG_Dir_Exists (const CSG_String &Directory)
SAGA_API_DLL_EXPORT bool SG_Dir_Create (const CSG_String &Directory, bool bFullPath=false)
SAGA_API_DLL_EXPORT bool SG_Dir_Delete (const CSG_String &Directory, bool bRecursive=false)
SAGA_API_DLL_EXPORT CSG_String SG_Dir_Get_Current (void)
SAGA_API_DLL_EXPORT bool SG_Dir_Set_Temp (const CSG_String &Directory, bool bCreate=false)
 Set the directory path returned by SG_Dir_Get_Temp(). Defaults to the user's temporary directory. To restore the default simply call the function with an empty directory string.
SAGA_API_DLL_EXPORT CSG_String SG_Dir_Get_Temp (void)
SAGA_API_DLL_EXPORT bool SG_Dir_List_Subdirectories (CSG_Strings &List, const CSG_String &Directory, bool bRecursive=false)
SAGA_API_DLL_EXPORT bool SG_Dir_List_Files (CSG_Strings &List, const CSG_String &Directory, const CSG_String &Extension="", bool bRecursive=false)
SAGA_API_DLL_EXPORT bool SG_File_Exists (const CSG_String &FileName)
SAGA_API_DLL_EXPORT bool SG_File_Delete (const CSG_String &FileName)
SAGA_API_DLL_EXPORT bool SG_File_Copy (const CSG_String &Source, const CSG_String &Target, bool bOverwrite=true)
SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Name_Temp (const CSG_String &Prefix)
SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Name_Temp (const CSG_String &Prefix, const CSG_String &Directory)
SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Name (const CSG_String &full_Path, bool bExtension)
SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Path (const CSG_String &full_Path)
SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Path_Absolute (const CSG_String &full_Path, const CSG_String &CWD="")
SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Path_Relative (const CSG_String &Directory, const CSG_String &full_Path)
SAGA_API_DLL_EXPORT CSG_String SG_File_Make_Path (const CSG_String &Directory, const CSG_String &Name)
SAGA_API_DLL_EXPORT CSG_String SG_File_Make_Path (const CSG_String &Directory, const CSG_String &Name, const CSG_String &Extension)
SAGA_API_DLL_EXPORT bool SG_File_Cmp_Path (const CSG_String &Path1, const CSG_String &Path2)
SAGA_API_DLL_EXPORT bool SG_File_Cmp_Extension (const CSG_String &File, const CSG_String &Extension)
SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Extension (const CSG_String &File)
SAGA_API_DLL_EXPORT bool SG_File_Set_Extension (CSG_String &File, const CSG_String &Extension)
SAGA_API_DLL_EXPORT bool SG_Get_Environment (const CSG_String &Variable, CSG_String *Value=NULL)
SAGA_API_DLL_EXPORT bool SG_Set_Environment (const CSG_String &Variable, const CSG_String &Value)
SAGA_API_DLL_EXPORT CSG_String SG_Colors_Get_Name (int Index)
SAGA_API_DLL_EXPORT long SG_Color_Get_Random (void)
SAGA_API_DLL_EXPORT long SG_Color_From_RGB (int Red, int Green, int Blue, int Alpha=0)
SAGA_API_DLL_EXPORT bool SG_Color_From_Text (const CSG_String &Text, long &Color)
SAGA_API_DLL_EXPORT CSG_String SG_Color_To_Text (long Color, bool bHexadecimal=true)
SAGA_API_DLL_EXPORT CSG_TranslatorSG_Get_Translator (void)
SAGA_API_DLL_EXPORT const SG_CharSG_Translate (const CSG_String &Text)
SAGA_API_DLL_EXPORT bool SG_Set_UI_Callback (TSG_PFNC_UI_Callback Function)
SAGA_API_DLL_EXPORT TSG_PFNC_UI_Callback SG_Get_UI_Callback (void)
SAGA_API_DLL_EXPORT void SG_UI_Console_Set_UTF8 (bool bOn)
SAGA_API_DLL_EXPORT bool SG_UI_Console_Get_UTF8 (void)
SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdOut (const char *Text, SG_Char End='\n', bool bFlush=true)
SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdOut (const wchar_t *Text, SG_Char End='\n', bool bFlush=true)
SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdOut (const CSG_String &Text, SG_Char End='\n', bool bFlush=true)
SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdErr (const char *Text, SG_Char End='\n', bool bFlush=true)
SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdErr (const wchar_t *Text, SG_Char End='\n', bool bFlush=true)
SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdErr (const CSG_String &Text, SG_Char End='\n', bool bFlush=true)
SAGA_API_DLL_EXPORT int SG_UI_Progress_Lock (bool bOn)
SAGA_API_DLL_EXPORT bool SG_UI_Progress_is_Locked (void)
SAGA_API_DLL_EXPORT int SG_UI_Progress_Reset (void)
SAGA_API_DLL_EXPORT bool SG_UI_Process_Get_Okay (bool bBlink=false)
SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Okay (bool bOkay=true)
SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Busy (bool bOn=true, const CSG_String &Message="")
SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Progress (int Position, int Range)
SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Progress (sLong Position, sLong Range)
SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Progress (double Position, double Range)
SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Ready (void)
SAGA_API_DLL_EXPORT void SG_UI_Process_Set_Text (const CSG_String &Text)
SAGA_API_DLL_EXPORT bool SG_UI_Stop_Execution (bool bDialog)
SAGA_API_DLL_EXPORT void SG_UI_Dlg_Message (const CSG_String &Message, const CSG_String &Caption)
SAGA_API_DLL_EXPORT bool SG_UI_Dlg_Continue (const CSG_String &Message, const CSG_String &Caption)
SAGA_API_DLL_EXPORT int SG_UI_Dlg_Error (const CSG_String &Message, const CSG_String &Caption)
SAGA_API_DLL_EXPORT void SG_UI_Dlg_Info (const CSG_String &Message, const CSG_String &Caption)
SAGA_API_DLL_EXPORT bool SG_UI_Dlg_Parameters (class CSG_Parameters *pParameters, const CSG_String &Caption)
SAGA_API_DLL_EXPORT int SG_UI_Msg_Lock (bool bOn)
SAGA_API_DLL_EXPORT bool SG_UI_Msg_is_Locked (void)
SAGA_API_DLL_EXPORT int SG_UI_Msg_Reset (void)
SAGA_API_DLL_EXPORT void SG_UI_Msg_Add (const char *Message, bool bNewLine=true, TSG_UI_MSG_STYLE Style=SG_UI_MSG_STYLE_NORMAL)
SAGA_API_DLL_EXPORT void SG_UI_Msg_Add (const wchar_t *Message, bool bNewLine=true, TSG_UI_MSG_STYLE Style=SG_UI_MSG_STYLE_NORMAL)
SAGA_API_DLL_EXPORT void SG_UI_Msg_Add (const CSG_String &Message, bool bNewLine=true, TSG_UI_MSG_STYLE Style=SG_UI_MSG_STYLE_NORMAL)
SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Execution (const char *Message, bool bNewLine=true, TSG_UI_MSG_STYLE Style=SG_UI_MSG_STYLE_NORMAL)
SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Execution (const wchar_t *Message, bool bNewLine=true, TSG_UI_MSG_STYLE Style=SG_UI_MSG_STYLE_NORMAL)
SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Execution (const CSG_String &Message, bool bNewLine=true, TSG_UI_MSG_STYLE Style=SG_UI_MSG_STYLE_NORMAL)
SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Error (const char *Message)
SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Error (const wchar_t *Message)
SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Error (const CSG_String &Message)
SAGA_API_DLL_EXPORT void SG_UI_Msg_Flush (void)
SAGA_API_DLL_EXPORT void SG_UI_ProgressAndMsg_Lock (bool bOn)
SAGA_API_DLL_EXPORT void SG_UI_ProgressAndMsg_Reset (void)
SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Add (class CSG_Data_Object *pDataObject, int Show)
SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Del (class CSG_Data_Object *pDataObject, bool bConfirm)
SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Update (class CSG_Data_Object *pDataObject, int Show, class CSG_Parameters *pParameters)
SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Show (class CSG_Data_Object *pDataObject, int Show)
SAGA_API_DLL_EXPORT bool SG_UI_DataObject_asImage (class CSG_Data_Object *pDataObject, class CSG_Grid *pGrid)
SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Colors_Get (class CSG_Data_Object *pDataObject, class CSG_Colors *pColors)
SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Colors_Set (class CSG_Data_Object *pDataObject, class CSG_Colors *pColors)
SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Classify (class CSG_Data_Object *pDataObject, const class CSG_MetaData &Options)
SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Params_Get (class CSG_Data_Object *pDataObject, class CSG_Parameters *pParameters)
SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Params_Set (class CSG_Data_Object *pDataObject, class CSG_Parameters *pParameters)
SAGA_API_DLL_EXPORT bool SG_UI_Set_Map_Extent (double xMin, double yMin, double xMax, double yMax, int Maps=SG_UI_MAP_ACTIVE)
SAGA_API_DLL_EXPORT bool SG_UI_Diagram_Show (class CSG_Table *pTable, class CSG_Parameters *pParameters)
SAGA_API_DLL_EXPORT bool SG_UI_ODBC_Update (const CSG_String &Server)
SAGA_API_DLL_EXPORT int SG_UI_Window_Arrange (int Arrange)
SAGA_API_DLL_EXPORT void * SG_UI_Get_Window_Main (void)
SAGA_API_DLL_EXPORT CSG_String SG_UI_Get_Application_Path (bool bPathOnly=false)
SAGA_API_DLL_EXPORT CSG_String SG_UI_Get_Application_Name (void)
SAGA_API_DLL_EXPORT CSG_String SG_UI_Set_Application_Name (const CSG_String &Name="")
SAGA_API_DLL_EXPORT CSG_String SG_UI_Get_API_Path (void)
SAGA_API_DLL_EXPORT bool SG_Initialize_Environment (bool bLibraries=true, bool bProjections=true, const SG_Char *SAGA_Path=NULL, bool bInitializeWX=true)
SAGA_API_DLL_EXPORT bool SG_Uninitialize_Environment (void)

Variables

const char gSG_Data_Type_Identifier [][32]

Detailed Description

Classes, functions, type definitions for basic helpers like data types, memory allocation, string handling, file access, translations, colors and user interface communication.

See also
CSG_String
CSG_File
CSG_Array
CSG_Bytes

Definition in file api_core.h.

Macro Definition Documentation

◆ _SAGA_DLL_EXPORT

#define _SAGA_DLL_EXPORT

Definition at line 86 of file api_core.h.

◆ _SAGA_DLL_IMPORT

#define _SAGA_DLL_IMPORT

Definition at line 87 of file api_core.h.

◆ _TL

#define _TL ( s)
Value:
SG_Translate(L ## s)
SAGA_API_DLL_EXPORT const SG_Char * SG_Translate(const CSG_String &Text)

Definition at line 1610 of file api_core.h.

Referenced by CSG_Parameter_Bool::_Set_String(), CSG_Parameter_Choice::_Set_String(), CSG_Parameter_Colors::_Set_String(), CSG_Parameter_Data_Object::_Set_String(), CSG_Parameter_Fixed_Table::_Set_String(), CSG_Parameter_List::_Set_String(), CSG_Parameter_Parameters::_Set_String(), CSG_Parameter_Table_Field::_Set_String(), CSG_Parameter_Bool::_Set_Value(), CSG_Parameter_Table_Fields::_Set_Value(), CSG_Parameters_CRSPicker::Activate_GUI(), CSG_Parameter_Grid::Add_Default(), CSG_Parameter_Table_Field::Add_Default(), CSG_Formula::Add_Function(), CSG_Parameters::Add_Grid(), CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters::Add_Grid_Resampling(), CSG_Parameters::Add_Grids(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Tool_Library_Manager::Add_Library(), CSG_Distance_Weighting::Add_Parameters(), CSG_Grid_Cell_Addressor::Add_Parameters(), CSG_Shapes::Calculate_Geometry(), CSG_Grid::Create(), CSG_Parameters_CRSPicker::Create(), CSG_Parameters_Grid_Target::Create(), CSG_Parameters_Point_Search::Create(), CSG_Shapes::Create(), CSG_Table::Create(), CSG_Thin_Plate_Spline::Create(), CSG_TIN::Create(), CSG_TIN::Create(), CSG_Tool_Chain::Create(), CSG_Tool_Chain::Create(), CSG_Tool_Library_Interface::Create(), CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Parameter_File_Name::CSG_Parameter_File_Name(), CSG_Parameter_Fixed_Table::CSG_Parameter_Fixed_Table(), CSG_Tool::CSG_Tool(), CSG_Tool_Chains::CSG_Tool_Chains(), CSG_Tool_Library::CSG_Tool_Library(), CSG_Parameters::DataObjects_Check(), CSG_Projection::Destroy(), CSG_Tool::Error_Set(), CSG_Tool::Error_Set(), CSG_Tool::Execute(), CSG_Tool_Interactive_Base::Execute_Finish(), CSG_Table::from_Text(), CSG_Parameter_Table_Field::Get_Choices(), CSG_Parameters_CRSPicker::Get_CRS(), CSG_Projections::Get_CRS_Type_Name(), CSG_Parameter::Get_Description(), CSG_Projection::Get_Description(), CSG_Tool::Get_Description_Editors(), CSG_Formula::Get_Error(), CSG_Trend::Get_Error(), CSG_Grids::Get_Grid_Name(), CSG_Formula::Get_Help_Operators(), CSG_Regression_Multiple::Get_Info(), CSG_Tool_Chains::Get_Info(), CSG_DateTime::Get_Month_Choices(), CSG_Grid_System::Get_Name(), CSG_Classifier_Supervised::Get_Name_of_Method(), CSG_Classifier_Supervised::Get_Name_of_Quality(), CSG_Projections::Get_Names_List(), CSG_Parameters::Get_Parameter(), CSG_Parameters::Get_Parameter(), CSG_Colors::Get_Predefined_Name(), CSG_Data_Manager::Get_Summary(), CSG_Tool::Get_Summary(), CSG_Tool_Library::Get_Summary(), CSG_Tool_Library_Manager::Get_Summary(), CSG_Text_Format_Converter::Html_Absolute_Image_Paths(), CSG_Grids::Load(), CSG_Parameters::Msg_String(), CSG_Tool_Chain::On_Execute(), CSG_Table_DBase::Open_Read(), CSG_Table_DBase::Open_Write(), CSG_Grid::Save(), CSG_Grids::Save(), CSG_PointCloud::Save(), CSG_Shapes::Save(), CSG_Table::Save(), CSG_Tool_Chain::Save_History_to_Model(), CSG_Regression_Multiple::Set_Data(), CSG_Data_Object::Set_File_Name(), CSG_Parameter_File_Name::Set_Filter(), CSG_Data_Object::Set_Name(), SG_Data_Type_Get_Name(), SG_FTP_Download(), SG_Get_DataObject_Name(), SG_Get_ShapeType_Name(), SG_Parameter_Type_Get_Name(), SG_UI_Msg_Add_Error(), and CSG_Parameters::Use_Grid_System().

◆ _TW

#define _TW ( s)
Value:

Definition at line 1611 of file api_core.h.

◆ CSG_File_Zip

#define CSG_File_Zip   CSG_Archive

Definition at line 1299 of file api_core.h.

◆ SAGA_API_DLL_EXPORT

#define SAGA_API_DLL_EXPORT   _SAGA_DLL_IMPORT

Definition at line 94 of file api_core.h.

Referenced by SG_UI_DataObject_Classify().

◆ SG_Char

#define SG_Char   wchar_t

Definition at line 536 of file api_core.h.

Referenced by CSG_Parameter::_asString(), CSG_Table::_Save_Text(), CSG_Projections::Add(), CSG_Archive::Add_Directory(), CSG_Archive::Add_File(), CSG_Parameters::Add_FilePath(), CSG_Parameters::Add_FilePath(), CSG_Parameters::Add_Font(), CSG_Parameters::Add_Font(), CSG_Table_Value::asBinary(), CSG_Table_Record::asChar(), CSG_Table_Record::asChar(), CSG_Table_Record::asChar(), CSG_Table_Record::asChar(), CSG_Parameter::asFont(), CSG_Projection::Assign(), CSG_Table::Assign_Values(), CSG_Grid_System::asString(), CSG_Parameter::asString(), CSG_Regression::asString(), CSG_Table_Record::asString(), CSG_Table_Record::asString(), CSG_Table_Record::asString(), CSG_Table_Record::asString(), CSG_Table_Value::asString(), CSG_Table_Value_Binary::asString(), CSG_Table_Value_Date::asString(), CSG_Table_Value_Double::asString(), CSG_Table_Value_Int::asString(), CSG_Table_Value_Long::asString(), CSG_Table_Value_String::asString(), CSG_String::c_str(), CSG_MetaData::Create(), CSG_Parameters::Create(), CSG_Parameters::Create(), CSG_Projection::Create(), CSG_Shapes::Create(), CSG_Table::Create(), CSG_Table::Create(), CSG_Table::Create(), CSG_Archive::CSG_Archive(), CSG_File::CSG_File(), CSG_MetaData::CSG_HTTP, CSG_MetaData::CSG_MetaData(), CSG_Parameters::CSG_Parameters(), CSG_Parameters::CSG_Parameters(), CSG_Projection::CSG_Projection(), CSG_Projections::CSG_Projection, CSG_Shapes::CSG_Shape, CSG_Shapes::CSG_Shapes(), CSG_Strings::CSG_Strings(), CSG_Table::CSG_Table(), CSG_Table::CSG_Table(), CSG_Table::CSG_Table(), CSG_Table::CSG_TIN, CSG_Parameters::CSG_Tool, CSG_Tool::DataObject_Set_Parameter(), CSG_MetaData::Del_Children(), CSG_Archive::Extract(), CSG_Archive::Extract_All(), CSG_MetaData::from_JSON(), CSG_MetaData::from_XML(), CSG_Bytes::fromHexString(), CSG_PointCloud::Get_Attribute_Name(), CSG_String::Get_Char(), CSG_MetaData::Get_Content(), CSG_MetaData::Get_Content(), CSG_MetaData::Get_Content(), CSG_Data_Object::Get_Description(), CSG_Parameter::Get_Description(), CSG_Parameter::Get_Description(), CSG_Tool::Get_Execution_Info(), CSG_Table::Get_Field_Name(), CSG_Archive::Get_File(), CSG_Data_Object::Get_File_Name(), CSG_Parameter_File_Name::Get_Filter(), CSG_Tool::Get_Icon(), CSG_Parameter::Get_Identifier(), CSG_Parameter_Choice::Get_Item(), CSG_String_Tokenizer::Get_Last_Delimiter(), CSG_Data_Object::Get_Name(), CSG_Grid_System::Get_Name(), CSG_Parameter::Get_Name(), CSG_Regression_Multiple::Get_Name(), CSG_Projections::Get_Projection(), CSG_Projections::Get_Projection(), CSG_MetaData::Get_Property(), CSG_MetaData::Get_Property(), CSG_MetaData::Get_Property(), CSG_Translator::Get_Text(), CSG_Translator::Get_Translation(), CSG_Translator::Get_Translation(), CSG_Translator::Get_Translation(), CSG_Parameter::Get_Type(), CSG_Grids::Get_Unit(), CSG_Unique_String_Statistics::Get_Value(), CSG_Trend::Init_Parameter(), CSG_MetaData::Load(), CSG_Table::Load(), CSG_MetaData::Load_HTTP(), CSG_Tool::Message_Dlg(), CSG_Tool::Message_Dlg_Confirm(), CSG_Archive::Open(), CSG_Archive::Open(), CSG_File::Open(), CSG_Table_DBase::Open_Read(), CSG_Table_DBase::Open_Write(), CSG_Table_Value::operator const SG_Char *(), CSG_Table_Value::operator=(), CSG_Table_Value_Binary::operator=(), CSG_Table_Value_Date::operator=(), CSG_Table_Value_Double::operator=(), CSG_Table_Value_Int::operator=(), CSG_Table_Value_Long::operator=(), CSG_Table_Value_String::operator=(), CSG_String::operator[](), CSG_String::operator[](), CSG_String::Replace_Single_Char(), CSG_String::Replace_Single_Char(), CSG_HTTP::Request(), CSG_WebRequestSync::Request(), CSG_WebRequestSync::Request(), SAGA_API_Get_Version(), CSG_Classifier_Supervised::Save(), CSG_Data_Object::Save(), CSG_MetaData::Save(), CSG_Table::Save(), CSG_Table::Save(), CSG_Table::Save(), CSG_File::Scan(), CSG_File::Scan_String(), CSG_Table::Serialize(), CSG_PointCloud::Set_Attribute(), CSG_PointCloud::Set_Attribute(), CSG_Table::Set_Field_Name(), CSG_Parameter_File_Name::Set_Filter(), CSG_Parameter_Choice::Set_Items(), CSG_PointCloud::Set_Value(), CSG_PointCloud::Set_Value(), CSG_Table::Set_Value(), CSG_Table_Value::Set_Value(), CSG_Table_Value_Binary::Set_Value(), CSG_Table_Value_Date::Set_Value(), CSG_Table_Value_Date::Set_Value(), CSG_Table_Value_Double::Set_Value(), CSG_Table_Value_Double::Set_Value(), CSG_Table_Value_Int::Set_Value(), CSG_Table_Value_Int::Set_Value(), CSG_Table_Value_Long::Set_Value(), CSG_Table_Value_Long::Set_Value(), CSG_Table_Value_String::Set_Value(), CSG_Table_Value_String::Set_Value(), SG_Create_Shapes(), SG_Create_Table(), SG_Create_Table(), SG_Create_Table(), SG_Grid_Cache_Get_Directory(), SG_Grid_Cache_Set_Directory(), SG_Hex_to_Byte(), SG_Initialize_Environment(), SG_Translate(), SG_UI_Console_Print_StdErr(), SG_UI_Console_Print_StdErr(), SG_UI_Console_Print_StdErr(), SG_UI_Console_Print_StdOut(), SG_UI_Console_Print_StdOut(), SG_UI_Console_Print_StdOut(), SG_UI_DataObject_Classify(), SG_UI_Process_Get_Okay(), CSG_Matrix::to_String(), and CSG_Vector::to_String().

◆ SG_COLOR_BLACK

#define SG_COLOR_BLACK   SG_GET_RGB( 0, 0, 0)

Definition at line 1348 of file api_core.h.

◆ SG_COLOR_BLUE

#define SG_COLOR_BLUE   SG_GET_RGB( 0, 0, 255)

Definition at line 1359 of file api_core.h.

◆ SG_COLOR_BLUE_DARK

#define SG_COLOR_BLUE_DARK   SG_GET_RGB( 0, 0, 128)

Definition at line 1360 of file api_core.h.

◆ SG_COLOR_BLUE_GREEN

#define SG_COLOR_BLUE_GREEN   SG_GET_RGB( 0, 128, 128)

Definition at line 1362 of file api_core.h.

◆ SG_COLOR_BLUE_LIGHT

#define SG_COLOR_BLUE_LIGHT   SG_GET_RGB( 0, 255, 255)

Definition at line 1361 of file api_core.h.

◆ SG_COLOR_GREEN

#define SG_COLOR_GREEN   SG_GET_RGB( 0, 255, 0)

Definition at line 1356 of file api_core.h.

◆ SG_COLOR_GREEN_DARK

#define SG_COLOR_GREEN_DARK   SG_GET_RGB( 0, 128, 0)

Definition at line 1357 of file api_core.h.

◆ SG_COLOR_GREEN_LIGHT

#define SG_COLOR_GREEN_LIGHT   SG_GET_RGB( 0, 255, 0)

Definition at line 1358 of file api_core.h.

◆ SG_COLOR_GREY

#define SG_COLOR_GREY   SG_GET_RGB(128, 128, 128)

Definition at line 1349 of file api_core.h.

◆ SG_COLOR_GREY_LIGHT

#define SG_COLOR_GREY_LIGHT   SG_GET_RGB(192, 192, 192)

Definition at line 1350 of file api_core.h.

◆ SG_COLOR_NONE

#define SG_COLOR_NONE   -1

Definition at line 1365 of file api_core.h.

◆ SG_COLOR_PINK

#define SG_COLOR_PINK   SG_GET_RGB(255, 0, 255)

Definition at line 1364 of file api_core.h.

◆ SG_COLOR_PURPLE

#define SG_COLOR_PURPLE   SG_GET_RGB(128, 0, 128)

Definition at line 1363 of file api_core.h.

◆ SG_COLOR_RANDOM

#define SG_COLOR_RANDOM   -2

Definition at line 1366 of file api_core.h.

◆ SG_COLOR_RED

#define SG_COLOR_RED   SG_GET_RGB(255, 0, 0)

Definition at line 1352 of file api_core.h.

◆ SG_COLOR_RED_DARK

#define SG_COLOR_RED_DARK   SG_GET_RGB(128, 0, 0)

Definition at line 1353 of file api_core.h.

◆ SG_COLOR_WHITE

#define SG_COLOR_WHITE   SG_GET_RGB(255, 255, 255)

Definition at line 1351 of file api_core.h.

◆ SG_COLOR_YELLOW

#define SG_COLOR_YELLOW   SG_GET_RGB(255, 255, 0)

Definition at line 1354 of file api_core.h.

◆ SG_COLOR_YELLOW_DARK

#define SG_COLOR_YELLOW_DARK   SG_GET_RGB(128, 128, 0)

Definition at line 1355 of file api_core.h.

◆ SG_DATATYPES_Binary

#define SG_DATATYPES_Binary   0x4000

Definition at line 1072 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Bit

#define SG_DATATYPES_Bit   0x0001

Definition at line 1058 of file api_core.h.

Referenced by CSG_Parameter_Data_Type::Set_Data_Types(), and SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Byte

#define SG_DATATYPES_Byte   0x0002

Definition at line 1059 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Char

#define SG_DATATYPES_Char   0x0004

Definition at line 1060 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Color

#define SG_DATATYPES_Color   0x2000

Definition at line 1071 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Date

#define SG_DATATYPES_Date   0x1000

Definition at line 1070 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Double

#define SG_DATATYPES_Double   0x0400

Definition at line 1068 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_DWord

#define SG_DATATYPES_DWord   0x0020

Definition at line 1063 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Float

#define SG_DATATYPES_Float   0x0200

Definition at line 1067 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Int

#define SG_DATATYPES_Int   0x0040

Definition at line 1064 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Integer

#define SG_DATATYPES_Integer   (SG_DATATYPES_SInteger|SG_DATATYPES_UInteger)

Definition at line 1076 of file api_core.h.

Referenced by CSG_Parameter_Data_Type::Set_Data_Types().

◆ SG_DATATYPES_Long

#define SG_DATATYPES_Long   0x0100

Definition at line 1066 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Numeric

#define SG_DATATYPES_Numeric   (SG_DATATYPES_Integer|SG_DATATYPES_Real)

Definition at line 1078 of file api_core.h.

Referenced by CSG_Parameter_Data_Type::Set_Data_Types().

◆ SG_DATATYPES_Real

#define SG_DATATYPES_Real   (SG_DATATYPES_Float|SG_DATATYPES_Double)

Definition at line 1077 of file api_core.h.

◆ SG_DATATYPES_Short

#define SG_DATATYPES_Short   0x0010

Definition at line 1062 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_SInteger

Definition at line 1074 of file api_core.h.

◆ SG_DATATYPES_Standard

#define SG_DATATYPES_Standard   0xFFFF

Definition at line 1073 of file api_core.h.

Referenced by CSG_Parameter_Data_Type::Set_Data_Types().

◆ SG_DATATYPES_String

#define SG_DATATYPES_String   0x0800

Definition at line 1069 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Table

◆ SG_DATATYPES_UInteger

Definition at line 1075 of file api_core.h.

◆ SG_DATATYPES_ULong

#define SG_DATATYPES_ULong   0x0080

Definition at line 1065 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Undefined

#define SG_DATATYPES_Undefined   0x0000

Definition at line 1057 of file api_core.h.

Referenced by CSG_Parameter_Data_Type::Set_Data_Types(), and SG_Data_Type_Get_Flag().

◆ SG_DATATYPES_Word

#define SG_DATATYPES_Word   0x0008

Definition at line 1061 of file api_core.h.

Referenced by SG_Data_Type_Get_Flag().

◆ SG_DEFAULT_DELIMITERS

#define SG_DEFAULT_DELIMITERS   " \t\r\n"

Definition at line 752 of file api_core.h.

◆ SG_DELETE_ARRAY

#define SG_DELETE_ARRAY ( PTR)
Value:
{ if( PTR ) { delete[](PTR); PTR = NULL; } }

Definition at line 207 of file api_core.h.

◆ SG_DELETE_SAFE

#define SG_DELETE_SAFE ( PTR)
Value:
{ if( PTR ) { delete (PTR); PTR = NULL; } }

Definition at line 206 of file api_core.h.

Referenced by CSG_KDTree::Destroy().

◆ SG_FPRINTF

#define SG_FPRINTF   fwprintf

Definition at line 539 of file api_core.h.

◆ SG_FREE_SAFE

◆ SG_GET_A

#define SG_GET_A ( rgb)
Value:
((BYTE) ((rgb) >> 24))

Definition at line 1345 of file api_core.h.

◆ SG_GET_B

#define SG_GET_B ( rgb)

◆ SG_GET_BYTE_0

#define SG_GET_BYTE_0 ( vLong)
Value:
((BYTE) ((vLong) ))

Definition at line 194 of file api_core.h.

◆ SG_GET_BYTE_1

#define SG_GET_BYTE_1 ( vLong)
Value:
((BYTE) ((vLong) >> 8))

Definition at line 195 of file api_core.h.

◆ SG_GET_BYTE_2

#define SG_GET_BYTE_2 ( vLong)
Value:
((BYTE) ((vLong) >> 16))

Definition at line 196 of file api_core.h.

◆ SG_GET_BYTE_3

#define SG_GET_BYTE_3 ( vLong)
Value:
((BYTE) ((vLong) >> 24))

Definition at line 197 of file api_core.h.

◆ SG_GET_G

#define SG_GET_G ( rgb)

◆ SG_GET_LONG

#define SG_GET_LONG ( b0,
b1,
b2,
b3 )
Value:
((long) (((BYTE)(b0) | ((WORD)(b1) << 8)) | (((DWORD)(BYTE)(b2)) << 16) | (((DWORD)(BYTE)(b3)) << 24)))

Definition at line 192 of file api_core.h.

◆ SG_GET_R

#define SG_GET_R ( rgb)

◆ SG_GET_RGB

#define SG_GET_RGB ( r,
g,
b )

◆ SG_GET_RGBA

#define SG_GET_RGBA ( r,
g,
b,
a )
Value:
((DWORD) (((BYTE)(r) | ((WORD)(g) << 8)) | (((DWORD)(BYTE)(b)) << 16) | (((DWORD)(BYTE)(a)) << 24)))

Definition at line 1340 of file api_core.h.

Referenced by SG_Color_From_RGB(), and SG_Color_From_Text().

◆ SG_is_NaN

#define SG_is_NaN ( x)
Value:
(x != x)

Definition at line 168 of file api_core.h.

Referenced by CSG_Data_Object::is_NoData_Value().

◆ SG_PRINTF

#define SG_PRINTF   wprintf

Definition at line 538 of file api_core.h.

◆ SG_SSCANF

#define SG_SSCANF   swscanf

Definition at line 540 of file api_core.h.

Referenced by CSG_Table::Serialize().

◆ SG_STR_CMP

#define SG_STR_CMP ( s1,
s2 )
Value:
CSG_String(s1).Cmp(s2)
int Cmp(const CSG_String &String) const

Definition at line 544 of file api_core.h.

Referenced by CSG_Parameter::is_Compatible(), CSG_Table_Value_Binary::is_Equal(), and CSG_Parameter::is_Value_Equal().

◆ SG_STR_CPY

#define SG_STR_CPY   wcscpy

Definition at line 541 of file api_core.h.

◆ SG_STR_LEN

#define SG_STR_LEN   wcslen

Definition at line 542 of file api_core.h.

Referenced by CSG_Table_Value::asBinary(), and CSG_Table_Value_Binary::Set_Value().

◆ SG_STR_MBTOSG

#define SG_STR_MBTOSG ( s)
Value:
const wchar_t * w_str(void) const

Definition at line 545 of file api_core.h.

◆ SG_STR_TOD

#define SG_STR_TOD   wcstod

Definition at line 543 of file api_core.h.

◆ SG_T

#define SG_T ( s)
Value:
L ## s

Definition at line 537 of file api_core.h.

Referenced by CSG_Table::_Save_Text(), CSG_Regression_Multiple::_Set_Step_Info(), CSG_Parameters::Add_Bool(), CSG_MetaData::Add_Child(), CSG_MetaData::Add_Child(), CSG_Parameters::Add_Choice(), CSG_Parameters::Add_Color(), CSG_Parameters::Add_Colors(), CSG_Parameters::Add_Date(), CSG_Parameters::Add_Degree(), CSG_Parameters::Add_Double(), CSG_PointCloud::Add_Field(), CSG_Parameters::Add_FilePath(), CSG_Parameters::Add_FixedTable(), CSG_Parameters::Add_Font(), CSG_Parameters::Add_Grid(), CSG_Parameters::Add_Grid(), CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters::Add_Grid_List(), CSG_Parameters::Add_Grid_or_Const(), CSG_Parameters::Add_Grid_Output(), CSG_Parameters::Add_Grid_System(), CSG_Parameters::Add_Grids(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Parameters::Add_Info_Range(), CSG_Parameters::Add_Info_String(), CSG_Parameters::Add_Info_Value(), CSG_Parameters::Add_Int(), CSG_Parameters::Add_Node(), CSG_Parameters::Add_Parameters(), CSG_Parameters::Add_PointCloud(), CSG_Parameters::Add_PointCloud_List(), CSG_Parameters::Add_PointCloud_Output(), CSG_MetaData::Add_Property(), CSG_MetaData::Add_Property(), CSG_MetaData::Add_Property(), CSG_Parameters::Add_Range(), CSG_Parameters::Add_Shapes(), CSG_Parameters::Add_Shapes_List(), CSG_Parameters::Add_Shapes_Output(), CSG_Parameters::Add_String(), CSG_Parameters::Add_Table(), CSG_Parameters::Add_Table_Field(), CSG_Parameters::Add_Table_Field_or_Const(), CSG_Parameters::Add_Table_Fields(), CSG_Parameters::Add_Table_List(), CSG_Parameters::Add_Table_Output(), CSG_Parameters::Add_TIN(), CSG_Parameters::Add_TIN_List(), CSG_Parameters::Add_TIN_Output(), CSG_Parameters::Add_Value(), CSG_Category_Statistics::asString(), CSG_Regression::asString(), CSG_Parameters::Create(), CSG_Parameters_Grid_Target::Create(), CSG_Projection::Create(), CSG_Tool_Chain::Create(), CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Regression_Multiple::CSG_Regression_Multiple(), CSG_Tool::CSG_Tool(), CSG_Archive::Extract(), CSG_Archive::Extract_All(), CSG_String::Get_Char(), CSG_Parameter::Get_Description(), CSG_Parameter::Get_Description(), CSG_Projection::Get_Description(), CSG_Data_Object::Get_File_Name(), CSG_Trend::Get_Formula(), CSG_PointCloud::Get_Header_Content(), CSG_Tool::Get_History(), CSG_Regression_Multiple::Get_Name(), CSG_Classifier_Supervised::Get_Name_of_Method(), CSG_Classifier_Supervised::Get_Name_of_Quality(), CSG_Projections::Get_Projection(), CSG_Projections::Get_Projection(), CSG_Tool::Get_Summary(), CSG_Tool_Library::Get_Summary(), CSG_Translator::Get_Text(), CSG_Translator::Get_Translation(), CSG_MetaData::Ins_Child(), CSG_MetaData::Ins_Child(), CSG_String::operator[](), CSG_String::operator[](), SAGA_API_Get_Version(), CSG_Grid::Save(), CSG_Table::Serialize(), CSG_Table_Record::Set_NoData(), CSG_MetaData::Set_Property(), CSG_MetaData::Set_Property(), CSG_MetaData::Set_Property(), SG_Degree_To_Double(), SG_Double_To_Degree(), SG_Flip_Decimal_Separators(), CSG_Matrix::to_String(), CSG_Vector::to_String(), CSG_Bytes::toHexString(), and CSG_Data_Object::Track().

◆ SIZEOF_LONG

#define SIZEOF_LONG   4

Definition at line 131 of file api_core.h.

Typedef Documentation

◆ sLong

typedef signed long long sLong

Definition at line 158 of file api_core.h.

◆ TSG_PFNC_UI_Callback

typedef int(* TSG_PFNC_UI_Callback) (TSG_UI_Callback_ID ID, CSG_UI_Parameter &Param_1, CSG_UI_Parameter &Param_2)

Definition at line 1744 of file api_core.h.

◆ uLong

typedef unsigned long long uLong

Definition at line 159 of file api_core.h.

Enumeration Type Documentation

◆ ESG_Colors

enum ESG_Colors
Enumerator
SG_COLORS_DEFAULT 
SG_COLORS_DEFAULT_BRIGHT 
SG_COLORS_RAINBOW 
SG_COLORS_RAINBOW_2 
SG_COLORS_BLACK_WHITE 
SG_COLORS_BLACK_RED 
SG_COLORS_BLACK_GREEN 
SG_COLORS_BLACK_BLUE 
SG_COLORS_WHITE_RED 
SG_COLORS_WHITE_GREEN 
SG_COLORS_WHITE_BLUE 
SG_COLORS_CYAN_WHITE 
SG_COLORS_MAGENTA_WHITE 
SG_COLORS_YELLOW_WHITE 
SG_COLORS_YELLOW_RED 
SG_COLORS_YELLOW_GREEN 
SG_COLORS_YELLOW_BLUE 
SG_COLORS_BLUE_RED 
SG_COLORS_GREEN_RED 
SG_COLORS_GREEN_BLUE 
SG_COLORS_BLUE_WHITE_RED 
SG_COLORS_GREEN_WHITE_RED 
SG_COLORS_GREEN_WHITE_BLUE 
SG_COLORS_BLUE_GREY_RED 
SG_COLORS_RED_GREY_BLUE 
SG_COLORS_GREEN_GREY_RED 
SG_COLORS_RED_GREY_GREEN 
SG_COLORS_GREEN_GREY_BLUE 
SG_COLORS_BLUE_YELLOW_RED 
SG_COLORS_GREEN_YELLOW_RED 
SG_COLORS_RED_YELLOW_GREEN 
SG_COLORS_GREEN_YELLOW_BLUE 
SG_COLORS_RED_GREEN_BLUE 
SG_COLORS_RED_BLUE_GREEN 
SG_COLORS_GREEN_RED_BLUE 
SG_COLORS_NEON 
SG_COLORS_TOPOGRAPHY 
SG_COLORS_TOPOGRAPHY_2 
SG_COLORS_TOPOGRAPHY_3 
SG_COLORS_TOPOGRAPHY_4 
SG_COLORS_ASPECT_1 
SG_COLORS_ASPECT_2 
SG_COLORS_ASPECT_3 
SG_COLORS_THERMAL_1 
SG_COLORS_THERMAL_2 
SG_COLORS_PRECIPITATION_1 
SG_COLORS_PRECIPITATION_2 
SG_COLORS_PRECIPITATION_3 
SG_COLORS_PRECIPITATION_4 
SG_COLORS_PRECIPITATION_5 
SG_COLORS_VEGETATION 
SG_COLORS_SPECTRUM_1 
SG_COLORS_SPECTRUM_2 
SG_COLORS_SPECTRUM_3 
SG_COLORS_COUNT 

Definition at line 1369 of file api_core.h.

◆ ESG_File_Flags_Open

Enumerator
SG_FILE_R 
SG_FILE_W 
SG_FILE_RW 

Definition at line 1151 of file api_core.h.

◆ ESG_File_Flags_Seek

Enumerator
SG_FILE_START 
SG_FILE_CURRENT 
SG_FILE_END 

Definition at line 1159 of file api_core.h.

◆ TSG_Array_Growth

enum class TSG_Array_Growth
strong
Enumerator
SG_ARRAY_GROWTH_0 
SG_ARRAY_GROWTH_1 
SG_ARRAY_GROWTH_2 
SG_ARRAY_GROWTH_3 
SG_ARRAY_GROWTH_FIX_8 
SG_ARRAY_GROWTH_FIX_16 
SG_ARRAY_GROWTH_FIX_32 
SG_ARRAY_GROWTH_FIX_64 
SG_ARRAY_GROWTH_FIX_128 
SG_ARRAY_GROWTH_FIX_256 
SG_ARRAY_GROWTH_FIX_512 
SG_ARRAY_GROWTH_FIX_1024 

Definition at line 290 of file api_core.h.

◆ TSG_Data_Type

Enumerator
SG_DATATYPE_Bit 
SG_DATATYPE_Byte 
SG_DATATYPE_Char 
SG_DATATYPE_Word 
SG_DATATYPE_Short 
SG_DATATYPE_DWord 
SG_DATATYPE_Int 
SG_DATATYPE_ULong 
SG_DATATYPE_Long 
SG_DATATYPE_Float 
SG_DATATYPE_Double 
SG_DATATYPE_String 
SG_DATATYPE_Date 
SG_DATATYPE_Color 
SG_DATATYPE_Binary 
SG_DATATYPE_Undefined 

Definition at line 1035 of file api_core.h.

◆ TSG_File_Flags_Encoding

Enumerator
SG_FILE_ENCODING_ANSI 
SG_FILE_ENCODING_UTF7 
SG_FILE_ENCODING_UTF8 
SG_FILE_ENCODING_UTF16LE 
SG_FILE_ENCODING_UTF16BE 
SG_FILE_ENCODING_UTF32LE 
SG_FILE_ENCODING_UTF32BE 
SG_FILE_ENCODING_UNDEFINED 

Definition at line 548 of file api_core.h.

◆ TSG_File_Type

Enumerator
SG_FILE_TYPE_NORMAL 
SG_FILE_TYPE_ZIP 
SG_FILE_TYPE_TAR 

Definition at line 1142 of file api_core.h.

◆ TSG_String_Tokenizer_Mode

Enumerator
SG_TOKEN_INVALID 
SG_TOKEN_DEFAULT 
SG_TOKEN_RET_EMPTY 
SG_TOKEN_RET_EMPTY_ALL 
SG_TOKEN_RET_DELIMS 
SG_TOKEN_STRTOK 

Definition at line 754 of file api_core.h.

◆ TSG_UI_Callback_ID

Enumerator
CALLBACK_PROCESS_GET_OKAY 
CALLBACK_PROCESS_SET_OKAY 
CALLBACK_PROCESS_SET_BUSY 
CALLBACK_PROCESS_SET_PROGRESS 
CALLBACK_PROCESS_SET_READY 
CALLBACK_PROCESS_SET_TEXT 
CALLBACK_STOP_EXECUTION 
CALLBACK_DLG_MESSAGE 
CALLBACK_DLG_CONTINUE 
CALLBACK_DLG_ERROR 
CALLBACK_DLG_INFO 
CALLBACK_DLG_PARAMETERS 
CALLBACK_MESSAGE_ADD 
CALLBACK_MESSAGE_ADD_ERROR 
CALLBACK_MESSAGE_ADD_EXECUTION 
CALLBACK_DATAOBJECT_ADD 
CALLBACK_DATAOBJECT_DEL 
CALLBACK_DATAOBJECT_UPDATE 
CALLBACK_DATAOBJECT_SHOW 
CALLBACK_DATAOBJECT_ASIMAGE 
CALLBACK_DATAOBJECT_COLORS_GET 
CALLBACK_DATAOBJECT_COLORS_SET 
CALLBACK_DATAOBJECT_CLASSIFY 
CALLBACK_DATAOBJECT_PARAMS_GET 
CALLBACK_DATAOBJECT_PARAMS_SET 
CALLBACK_SET_MAP_EXTENT 
CALLBACK_DIAGRAM_SHOW 
CALLBACK_DATABASE_UPDATE 
CALLBACK_WINDOW_ARRANGE 
CALLBACK_GET_APP_WINDOW 
CALLBACK_GET_APP_PATH 

Definition at line 1672 of file api_core.h.

◆ TSG_UI_DataObject_Update

Enumerator
SG_UI_DATAOBJECT_UPDATE 
SG_UI_DATAOBJECT_SHOW_MAP 
SG_UI_DATAOBJECT_SHOW_MAP_ACTIVE 
SG_UI_DATAOBJECT_SHOW_MAP_NEW 
SG_UI_DATAOBJECT_SHOW_MAP_LAST 

Definition at line 1637 of file api_core.h.

◆ TSG_UI_Maps

Enumerator
SG_UI_MAP_ACTIVE 
SG_UI_MAP_LAST 
SG_UI_MAP_ALL 

Definition at line 1648 of file api_core.h.

◆ TSG_UI_MSG_STYLE

Enumerator
SG_UI_MSG_STYLE_NORMAL 
SG_UI_MSG_STYLE_BOLD 
SG_UI_MSG_STYLE_ITALIC 
SG_UI_MSG_STYLE_SUCCESS 
SG_UI_MSG_STYLE_FAILURE 
SG_UI_MSG_STYLE_BIG 
SG_UI_MSG_STYLE_SMALL 
SG_UI_MSG_STYLE_01 
SG_UI_MSG_STYLE_02 
SG_UI_MSG_STYLE_03 

Definition at line 1621 of file api_core.h.

◆ TSG_UI_Window_Arrange

Enumerator
SG_UI_WINDOW_ARRANGE_MDI_CASCADE 
SG_UI_WINDOW_ARRANGE_MDI_TILE_VER 
SG_UI_WINDOW_ARRANGE_MDI_TILE_HOR 
SG_UI_WINDOW_ARRANGE_TDI_TILE_VER 
SG_UI_WINDOW_ARRANGE_TDI_TILE_HOR 
SG_UI_WINDOW_ARRANGE_TDI_SPLIT_LEFT 
SG_UI_WINDOW_ARRANGE_TDI_SPLIT_RIGHT 
SG_UI_WINDOW_ARRANGE_TDI_SPLIT_TOP 
SG_UI_WINDOW_ARRANGE_TDI_SPLIT_BOTTOM 

Definition at line 1657 of file api_core.h.

Function Documentation

◆ operator+() [1/4]

SAGA_API_DLL_EXPORT CSG_String operator+ ( char A,
const CSG_String & B )

Definition at line 491 of file api_string.cpp.

References A, and B.

◆ operator+() [2/4]

SAGA_API_DLL_EXPORT CSG_String operator+ ( const char * A,
const CSG_String & B )

Definition at line 473 of file api_string.cpp.

References A, and B.

◆ operator+() [3/4]

SAGA_API_DLL_EXPORT CSG_String operator+ ( const wchar_t * A,
const CSG_String & B )

Definition at line 482 of file api_string.cpp.

References A, and B.

◆ operator+() [4/4]

SAGA_API_DLL_EXPORT CSG_String operator+ ( wchar_t A,
const CSG_String & B )

Definition at line 500 of file api_string.cpp.

References A, and B.

◆ SG_Calloc()

SAGA_API_DLL_EXPORT void * SG_Calloc ( size_t num,
size_t size )

◆ SG_Color_From_RGB()

SAGA_API_DLL_EXPORT long SG_Color_From_RGB ( int Red,
int Green,
int Blue,
int Alpha = 0 )

Definition at line 79 of file api_colors.cpp.

References SG_GET_RGBA.

◆ SG_Color_From_Text()

SAGA_API_DLL_EXPORT bool SG_Color_From_Text ( const CSG_String & Text,
long & Color )

◆ SG_Color_Get_Random()

SAGA_API_DLL_EXPORT long SG_Color_Get_Random ( void )

Definition at line 73 of file api_colors.cpp.

References CSG_Random::Get_Uniform(), and SG_GET_RGB.

◆ SG_Color_To_Text()

SAGA_API_DLL_EXPORT CSG_String SG_Color_To_Text ( long Color,
bool bHexadecimal = true )

Definition at line 144 of file api_colors.cpp.

References CSG_String::Printf(), SG_GET_B, SG_GET_G, and SG_GET_R.

◆ SG_Colors_Get_Name()

SAGA_API_DLL_EXPORT CSG_String SG_Colors_Get_Name ( int Index)

Definition at line 67 of file api_colors.cpp.

References CSG_Colors::Get_Predefined_Name().

◆ SG_Data_Type_Get_Flag()

◆ SG_Data_Type_Get_Identifier()

SAGA_API_DLL_EXPORT CSG_String SG_Data_Type_Get_Identifier ( TSG_Data_Type Type)

Definition at line 147 of file api_core.cpp.

References gSG_Data_Type_Identifier.

Referenced by CSG_Parameter_Data_Type::Set_Data_Types().

◆ SG_Data_Type_Get_Name()

◆ SG_Data_Type_Get_Size()

◆ SG_Data_Type_Get_Type()

◆ SG_Data_Type_is_Numeric()

◆ SG_Data_Type_Range_Check()

◆ SG_Degree_To_Double()

SAGA_API_DLL_EXPORT double SG_Degree_To_Double ( const CSG_String & String)

◆ SG_Dir_Create()

SAGA_API_DLL_EXPORT bool SG_Dir_Create ( const CSG_String & Directory,
bool bFullPath = false )

◆ SG_Dir_Delete()

SAGA_API_DLL_EXPORT bool SG_Dir_Delete ( const CSG_String & Directory,
bool bRecursive = false )

Definition at line 993 of file api_file.cpp.

References CSG_String::c_str(), and SG_Dir_Exists().

◆ SG_Dir_Exists()

◆ SG_Dir_Get_Current()

SAGA_API_DLL_EXPORT CSG_String SG_Dir_Get_Current ( void )

Definition at line 1004 of file api_file.cpp.

◆ SG_Dir_Get_Temp()

SAGA_API_DLL_EXPORT CSG_String SG_Dir_Get_Temp ( void )

Definition at line 1047 of file api_file.cpp.

References g_Dir_Temp, and SG_Dir_Exists().

◆ SG_Dir_List_Files()

SAGA_API_DLL_EXPORT bool SG_Dir_List_Files ( CSG_Strings & List,
const CSG_String & Directory,
const CSG_String & Extension = "",
bool bRecursive = false )

◆ SG_Dir_List_Subdirectories()

SAGA_API_DLL_EXPORT bool SG_Dir_List_Subdirectories ( CSG_Strings & List,
const CSG_String & Directory,
bool bRecursive = false )

◆ SG_Dir_Set_Temp()

SAGA_API_DLL_EXPORT bool SG_Dir_Set_Temp ( const CSG_String & Directory,
bool bCreate )

Set the directory path returned by SG_Dir_Get_Temp(). Defaults to the user's temporary directory. To restore the default simply call the function with an empty directory string.

Parameters
DirectoryTemporary directory
bCreateCreate directory if it does not exist
Returns

Definition at line 1023 of file api_file.cpp.

References g_Dir_Temp, CSG_String::is_Empty(), SG_Dir_Create(), and SG_Dir_Exists().

◆ SG_Double_To_Degree()

SAGA_API_DLL_EXPORT CSG_String SG_Double_To_Degree ( double Value)

◆ SG_File_Cmp_Extension()

◆ SG_File_Cmp_Path()

SAGA_API_DLL_EXPORT bool SG_File_Cmp_Path ( const CSG_String & Path1,
const CSG_String & Path2 )

Definition at line 1227 of file api_file.cpp.

References CSG_String::c_str().

◆ SG_File_Copy()

SAGA_API_DLL_EXPORT bool SG_File_Copy ( const CSG_String & Source,
const CSG_String & Target,
bool bOverwrite = true )

Definition at line 1140 of file api_file.cpp.

References CSG_String::wx_str().

◆ SG_File_Delete()

◆ SG_File_Exists()

◆ SG_File_Get_Extension()

SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Extension ( const CSG_String & File)

◆ SG_File_Get_Name()

◆ SG_File_Get_Name_Temp() [1/2]

SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Name_Temp ( const CSG_String & Prefix)

Definition at line 1146 of file api_file.cpp.

References SG_File_Get_Name_Temp().

Referenced by SG_File_Get_Name_Temp().

◆ SG_File_Get_Name_Temp() [2/2]

SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Name_Temp ( const CSG_String & Prefix,
const CSG_String & Directory )

Definition at line 1151 of file api_file.cpp.

References CSG_String::c_str(), SG_Dir_Exists(), and SG_File_Make_Path().

◆ SG_File_Get_Path()

◆ SG_File_Get_Path_Absolute()

◆ SG_File_Get_Path_Relative()

SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Path_Relative ( const CSG_String & Directory,
const CSG_String & full_Path )

Definition at line 1193 of file api_file.cpp.

References CSG_String::c_str().

◆ SG_File_Make_Path() [1/2]

◆ SG_File_Make_Path() [2/2]

SAGA_API_DLL_EXPORT CSG_String SG_File_Make_Path ( const CSG_String & Directory,
const CSG_String & Name,
const CSG_String & Extension )

◆ SG_File_Set_Extension()

◆ SG_Flip_Decimal_Separators()

SAGA_API_DLL_EXPORT void SG_Flip_Decimal_Separators ( CSG_String & String)

Definition at line 1332 of file api_string.cpp.

References CSG_String::Length(), CSG_String::Set_Char(), and SG_T.

◆ SG_Free()

◆ SG_Get_CurrentTimeStr()

SAGA_API_DLL_EXPORT CSG_String SG_Get_CurrentTimeStr ( bool bWithDate = true)

Definition at line 1231 of file api_string.cpp.

◆ SG_Get_Environment()

SAGA_API_DLL_EXPORT bool SG_Get_Environment ( const CSG_String & Variable,
CSG_String * Value = NULL )

Definition at line 1275 of file api_file.cpp.

References CSG_String::w_str().

Referenced by CSG_Tool_Library_Manager::Add_Default_Libraries().

◆ SG_Get_Significant_Decimals()

◆ SG_Get_String() [1/2]

SAGA_API_DLL_EXPORT CSG_String SG_Get_String ( double Value,
int Precision )

Returns floating point number 'Value' as formatted string. The format depends on the 'Precision' value. If Precision is -99 (the default) it will simply use f format. If 'Precision' is -98 the string will always be formatted with the e format specification (i.e. scientific: d.dddd e dd). If 'Precision' is -97 the string will be formatted with the e or f format specification depended on which produces the shorter string. If Precision is zero (= 0) no decimals will be printed If Precision is positive (> 0) it specifies the fix number of decimals ("%.*f", Precision, Value), if negative only significant decimals will be plotted up to a maximum of the absolute value of 'Precision' digits.

Definition at line 1367 of file api_string.cpp.

References CSG_String::Left(), CSG_String::Length(), CSG_String::Printf(), CSG_String::Replace(), and SG_Get_Significant_Decimals().

Referenced by CSG_MetaData::Add_Child(), CSG_Table_Value_Double::asString(), CSG_Grids::Get_Grid_Name(), CSG_MetaData::Ins_Child(), CSG_Classifier_Supervised::Print(), and SG_Get_String().

◆ SG_Get_String() [2/2]

SAGA_API_DLL_EXPORT CSG_String SG_Get_String ( int Value,
int Precision = 0 )

Definition at line 1425 of file api_string.cpp.

References CSG_String::Format(), and SG_Get_String().

◆ SG_Get_Translator()

SAGA_API_DLL_EXPORT CSG_Translator & SG_Get_Translator ( void )

Definition at line 80 of file api_translator.cpp.

References gSG_Translator.

◆ SG_Get_UI_Callback()

SAGA_API_DLL_EXPORT TSG_PFNC_UI_Callback SG_Get_UI_Callback ( void )

Definition at line 145 of file api_callback.cpp.

References gSG_UI_Callback.

◆ SG_HTML_Tag_Replacer()

SAGA_API_DLL_EXPORT CSG_String SG_HTML_Tag_Replacer ( const CSG_String & Text)

Definition at line 1552 of file api_string.cpp.

References CSG_Text_Format_Converter::Html_to_SimpleText().

◆ SG_Initialize_Environment()

◆ SG_is_Character_Numeric()

SAGA_API_DLL_EXPORT bool SG_is_Character_Numeric ( int Character)

Definition at line 1197 of file api_string.cpp.

◆ SG_Malloc()

◆ SG_Mem_Get_Double()

SAGA_API_DLL_EXPORT double SG_Mem_Get_Double ( const char * Buffer,
bool bSwapBytes )

Definition at line 200 of file api_memory.cpp.

References SG_Swap_Bytes().

◆ SG_Mem_Get_Int()

SAGA_API_DLL_EXPORT int SG_Mem_Get_Int ( const char * Buffer,
bool bSwapBytes )

Definition at line 177 of file api_memory.cpp.

References SG_Swap_Bytes().

◆ SG_Mem_Set_Double()

SAGA_API_DLL_EXPORT void SG_Mem_Set_Double ( char * Buffer,
double Value,
bool bSwapBytes )

Definition at line 212 of file api_memory.cpp.

References SG_Swap_Bytes().

◆ SG_Mem_Set_Int()

SAGA_API_DLL_EXPORT void SG_Mem_Set_Int ( char * Buffer,
int Value,
bool bSwapBytes )

Definition at line 189 of file api_memory.cpp.

References SG_Swap_Bytes().

◆ SG_OMP_Get_Max_Num_Procs()

SAGA_API_DLL_EXPORT int SG_OMP_Get_Max_Num_Procs ( void )

Definition at line 111 of file api_core.cpp.

Referenced by CSG_PointCloud::_On_Construction().

◆ SG_OMP_Get_Max_Num_Threads()

SAGA_API_DLL_EXPORT int SG_OMP_Get_Max_Num_Threads ( void )

Definition at line 110 of file api_core.cpp.

◆ SG_OMP_Get_Thread_Num()

SAGA_API_DLL_EXPORT int SG_OMP_Get_Thread_Num ( void )

Definition at line 112 of file api_core.cpp.

◆ SG_OMP_Set_Max_Num_Threads()

SAGA_API_DLL_EXPORT void SG_OMP_Set_Max_Num_Threads ( int iCores)

Definition at line 109 of file api_core.cpp.

◆ SG_Realloc()

◆ SG_Set_Environment()

SAGA_API_DLL_EXPORT bool SG_Set_Environment ( const CSG_String & Variable,
const CSG_String & Value )

Definition at line 1295 of file api_file.cpp.

References CSG_String::w_str().

◆ SG_Set_UI_Callback()

SAGA_API_DLL_EXPORT bool SG_Set_UI_Callback ( TSG_PFNC_UI_Callback Function)

Definition at line 137 of file api_callback.cpp.

References gSG_UI_Callback.

◆ SG_String_Tokenize()

◆ SG_Swap_Bytes()

◆ SG_Translate()

SAGA_API_DLL_EXPORT const SG_Char * SG_Translate ( const CSG_String & Text)

Definition at line 93 of file api_translator.cpp.

References gSG_Translator, and SG_Char.

Referenced by CSG_Tool_Chain::Create().

◆ SG_UI_Console_Get_UTF8()

SAGA_API_DLL_EXPORT bool SG_UI_Console_Get_UTF8 ( void )

Definition at line 74 of file api_callback.cpp.

References gSG_UI_Console_bUTF8.

◆ SG_UI_Console_Print_StdErr() [1/3]

SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdErr ( const char * Text,
SG_Char End = '\n',
bool bFlush = true )

◆ SG_UI_Console_Print_StdErr() [2/3]

SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdErr ( const CSG_String & Text,
SG_Char End = '\n',
bool bFlush = true )

◆ SG_UI_Console_Print_StdErr() [3/3]

SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdErr ( const wchar_t * Text,
SG_Char End = '\n',
bool bFlush = true )

Definition at line 103 of file api_callback.cpp.

References SG_Char, and SG_UI_Console_Print_StdErr().

◆ SG_UI_Console_Print_StdOut() [1/3]

◆ SG_UI_Console_Print_StdOut() [2/3]

SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdOut ( const CSG_String & Text,
SG_Char End = '\n',
bool bFlush = true )

◆ SG_UI_Console_Print_StdOut() [3/3]

SAGA_API_DLL_EXPORT void SG_UI_Console_Print_StdOut ( const wchar_t * Text,
SG_Char End = '\n',
bool bFlush = true )

Definition at line 78 of file api_callback.cpp.

References SG_Char, and SG_UI_Console_Print_StdOut().

◆ SG_UI_Console_Set_UTF8()

SAGA_API_DLL_EXPORT void SG_UI_Console_Set_UTF8 ( bool bOn)

Definition at line 73 of file api_callback.cpp.

References gSG_UI_Console_bUTF8.

◆ SG_UI_DataObject_Add()

◆ SG_UI_DataObject_asImage()

SAGA_API_DLL_EXPORT bool SG_UI_DataObject_asImage ( class CSG_Data_Object * pDataObject,
class CSG_Grid * pGrid )

Definition at line 667 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_ASIMAGE, and gSG_UI_Callback.

◆ SG_UI_DataObject_Classify()

SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Classify ( class CSG_Data_Object * pDataObject,
const class CSG_MetaData & Options )

◆ SG_UI_DataObject_Colors_Get()

SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Colors_Get ( class CSG_Data_Object * pDataObject,
class CSG_Colors * pColors )

Definition at line 680 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_COLORS_GET, and gSG_UI_Callback.

Referenced by CSG_Tool::DataObject_Get_Colors().

◆ SG_UI_DataObject_Colors_Set()

SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Colors_Set ( class CSG_Data_Object * pDataObject,
class CSG_Colors * pColors )

◆ SG_UI_DataObject_Del()

SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Del ( class CSG_Data_Object * pDataObject,
bool bConfirm )

Definition at line 620 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_DEL, and gSG_UI_Callback.

◆ SG_UI_DataObject_Params_Get()

SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Params_Get ( class CSG_Data_Object * pDataObject,
class CSG_Parameters * pParameters )

◆ SG_UI_DataObject_Params_Set()

SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Params_Set ( class CSG_Data_Object * pDataObject,
class CSG_Parameters * pParameters )

◆ SG_UI_DataObject_Show()

SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Show ( class CSG_Data_Object * pDataObject,
int Show )

Definition at line 654 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_SHOW, and gSG_UI_Callback.

Referenced by SG_UI_DataObject_Update().

◆ SG_UI_DataObject_Update()

◆ SG_UI_Diagram_Show()

SAGA_API_DLL_EXPORT bool SG_UI_Diagram_Show ( class CSG_Table * pTable,
class CSG_Parameters * pParameters )

◆ SG_UI_Dlg_Continue()

SAGA_API_DLL_EXPORT bool SG_UI_Dlg_Continue ( const CSG_String & Message,
const CSG_String & Caption )

◆ SG_UI_Dlg_Error()

SAGA_API_DLL_EXPORT int SG_UI_Dlg_Error ( const CSG_String & Message,
const CSG_String & Caption )

◆ SG_UI_Dlg_Info()

SAGA_API_DLL_EXPORT void SG_UI_Dlg_Info ( const CSG_String & Message,
const CSG_String & Caption )

◆ SG_UI_Dlg_Message()

◆ SG_UI_Dlg_Parameters()

SAGA_API_DLL_EXPORT bool SG_UI_Dlg_Parameters ( class CSG_Parameters * pParameters,
const CSG_String & Caption )

◆ SG_UI_Get_API_Path()

◆ SG_UI_Get_Application_Name()

SAGA_API_DLL_EXPORT CSG_String SG_UI_Get_Application_Name ( void )

Definition at line 378 of file api_core.cpp.

References g_App_Name.

Referenced by CSG_Tool_Library_Interface::Create(), CSG_Tool::CSG_Tool(), and SG_UI_Get_API_Path().

◆ SG_UI_Get_Application_Path()

◆ SG_UI_Get_Window_Main()

SAGA_API_DLL_EXPORT void * SG_UI_Get_Window_Main ( void )

◆ SG_UI_Msg_Add() [1/3]

◆ SG_UI_Msg_Add() [2/3]

SAGA_API_DLL_EXPORT void SG_UI_Msg_Add ( const CSG_String & Message,
bool bNewLine = true,
TSG_UI_MSG_STYLE Style = SG_UI_MSG_STYLE_NORMAL )

◆ SG_UI_Msg_Add() [3/3]

SAGA_API_DLL_EXPORT void SG_UI_Msg_Add ( const wchar_t * Message,
bool bNewLine = true,
TSG_UI_MSG_STYLE Style = SG_UI_MSG_STYLE_NORMAL )

Definition at line 500 of file api_callback.cpp.

References SG_UI_Msg_Add().

◆ SG_UI_Msg_Add_Error() [1/3]

◆ SG_UI_Msg_Add_Error() [2/3]

◆ SG_UI_Msg_Add_Error() [3/3]

SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Error ( const wchar_t * Message)

Definition at line 554 of file api_callback.cpp.

References SG_UI_Msg_Add_Error().

◆ SG_UI_Msg_Add_Execution() [1/3]

◆ SG_UI_Msg_Add_Execution() [2/3]

SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Execution ( const CSG_String & Message,
bool bNewLine = true,
TSG_UI_MSG_STYLE Style = SG_UI_MSG_STYLE_NORMAL )

◆ SG_UI_Msg_Add_Execution() [3/3]

SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Execution ( const wchar_t * Message,
bool bNewLine = true,
TSG_UI_MSG_STYLE Style = SG_UI_MSG_STYLE_NORMAL )

Definition at line 527 of file api_callback.cpp.

References SG_UI_Msg_Add_Execution().

◆ SG_UI_Msg_Flush()

SAGA_API_DLL_EXPORT void SG_UI_Msg_Flush ( void )

Definition at line 573 of file api_callback.cpp.

◆ SG_UI_Msg_is_Locked()

SAGA_API_DLL_EXPORT bool SG_UI_Msg_is_Locked ( void )

Definition at line 483 of file api_callback.cpp.

References gSG_UI_Msg_Lock.

◆ SG_UI_Msg_Lock()

◆ SG_UI_Msg_Reset()

SAGA_API_DLL_EXPORT int SG_UI_Msg_Reset ( void )

Definition at line 489 of file api_callback.cpp.

References gSG_UI_Msg_Lock.

Referenced by SG_UI_ProgressAndMsg_Reset().

◆ SG_UI_ODBC_Update()

SAGA_API_DLL_EXPORT bool SG_UI_ODBC_Update ( const CSG_String & Server)

Definition at line 771 of file api_callback.cpp.

References CALLBACK_DATABASE_UPDATE, and gSG_UI_Callback.

◆ SG_UI_Process_Get_Okay()

◆ SG_UI_Process_Set_Busy()

SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Busy ( bool bOn = true,
const CSG_String & Message = "" )

Definition at line 242 of file api_callback.cpp.

References CALLBACK_PROCESS_SET_BUSY, and gSG_UI_Callback.

◆ SG_UI_Process_Set_Okay()

◆ SG_UI_Process_Set_Progress() [1/3]

SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Progress ( double Position,
double Range )

◆ SG_UI_Process_Set_Progress() [2/3]

◆ SG_UI_Process_Set_Progress() [3/3]

SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Progress ( sLong Position,
sLong Range )

Definition at line 261 of file api_callback.cpp.

References SG_UI_Process_Set_Progress().

◆ SG_UI_Process_Set_Ready()

◆ SG_UI_Process_Set_Text()

◆ SG_UI_Progress_is_Locked()

SAGA_API_DLL_EXPORT bool SG_UI_Progress_is_Locked ( void )

Definition at line 191 of file api_callback.cpp.

References gSG_UI_Progress_Lock.

◆ SG_UI_Progress_Lock()

SAGA_API_DLL_EXPORT int SG_UI_Progress_Lock ( bool bOn)

Definition at line 176 of file api_callback.cpp.

References gSG_UI_Progress_Lock.

Referenced by SG_UI_ProgressAndMsg_Lock().

◆ SG_UI_Progress_Reset()

SAGA_API_DLL_EXPORT int SG_UI_Progress_Reset ( void )

Definition at line 197 of file api_callback.cpp.

References gSG_UI_Progress_Lock.

Referenced by SG_UI_ProgressAndMsg_Reset().

◆ SG_UI_ProgressAndMsg_Lock()

◆ SG_UI_ProgressAndMsg_Reset()

SAGA_API_DLL_EXPORT void SG_UI_ProgressAndMsg_Reset ( void )

Definition at line 593 of file api_callback.cpp.

References SG_UI_Msg_Reset(), and SG_UI_Progress_Reset().

◆ SG_UI_Set_Application_Name()

SAGA_API_DLL_EXPORT CSG_String SG_UI_Set_Application_Name ( const CSG_String & Name = "")

Definition at line 388 of file api_core.cpp.

References g_App_Name.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox().

◆ SG_UI_Set_Map_Extent()

SAGA_API_DLL_EXPORT bool SG_UI_Set_Map_Extent ( double xMin,
double yMin,
double xMax,
double yMax,
int Maps = SG_UI_MAP_ACTIVE )

Definition at line 745 of file api_callback.cpp.

References CALLBACK_SET_MAP_EXTENT, and gSG_UI_Callback.

◆ SG_UI_Stop_Execution()

SAGA_API_DLL_EXPORT bool SG_UI_Stop_Execution ( bool bDialog)

Definition at line 348 of file api_callback.cpp.

References CALLBACK_STOP_EXECUTION, and gSG_UI_Callback.

Referenced by CSG_Tool::Stop_Execution().

◆ SG_UI_Window_Arrange()

SAGA_API_DLL_EXPORT int SG_UI_Window_Arrange ( int Arrange)

Definition at line 791 of file api_callback.cpp.

References CALLBACK_WINDOW_ARRANGE, and gSG_UI_Callback.

◆ SG_Uninitialize_Environment()

SAGA_API_DLL_EXPORT bool SG_Uninitialize_Environment ( void )

Definition at line 528 of file api_core.cpp.

References g_App_Initialize.

Variable Documentation

◆ gSG_Data_Type_Identifier

const char gSG_Data_Type_Identifier[][32]
Initial value:
=
{
"BIT",
"BYTE_UNSIGNED",
"BYTE",
"SHORTINT_UNSIGNED",
"SHORTINT",
"INTEGER_UNSIGNED",
"INTEGER",
"LONGINT_UNSIGNED",
"LONGINT",
"FLOAT",
"DOUBLE",
"STRING",
"DATE",
"COLOR",
"BINARY",
"UNDEFINED"
}

Definition at line 1082 of file api_core.h.

Referenced by CSG_Parameter_Fixed_Table::_Serialize(), CSG_Grid_File_Info::Create(), CSG_Grid_File_Info::Save(), CSG_Table::Save(), SG_Data_Type_Get_Identifier(), and SG_Data_Type_Get_Type().