SAGA API  v9.6
Classes | Macros | Typedefs | Enumerations | Functions | Variables
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_Bytes
 
class  CSG_Bytes_Array
 
class  CSG_Stack
 
class  CSG_File
 
class  CSG_File_Zip
 
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)   (x != x)
 
#define SG_GET_LONG(b0, b1, b2, b3)   ((long) (((BYTE)(b0) | ((WORD)(b1) << 8)) | (((DWORD)(BYTE)(b2)) << 16) | (((DWORD)(BYTE)(b3)) << 24)))
 
#define SG_GET_BYTE_0(vLong)   ((BYTE) ((vLong) ))
 
#define SG_GET_BYTE_1(vLong)   ((BYTE) ((vLong) >> 8))
 
#define SG_GET_BYTE_2(vLong)   ((BYTE) ((vLong) >> 16))
 
#define SG_GET_BYTE_3(vLong)   ((BYTE) ((vLong) >> 24))
 
#define SG_FREE_SAFE(PTR)   { if( PTR ) { SG_Free (PTR); PTR = NULL; } }
 
#define SG_DELETE_SAFE(PTR)   { if( PTR ) { delete (PTR); PTR = NULL; } }
 
#define SG_DELETE_ARRAY(PTR)   { if( PTR ) { delete[](PTR); PTR = NULL; } }
 
#define SG_Char   wchar_t
 
#define SG_T(s)   L ## 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)   CSG_String(s1).Cmp(s2)
 
#define SG_STR_MBTOSG(s)   CSG_String(s).w_str()
 
#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 SG_GET_RGB(r, g, b)   ((DWORD) (((BYTE)(r) | ((WORD)(g) << 8)) | (((DWORD)(BYTE)(b)) << 16)))
 
#define SG_GET_RGBA(r, g, b, a)   ((DWORD) (((BYTE)(r) | ((WORD)(g) << 8)) | (((DWORD)(BYTE)(b)) << 16) | (((DWORD)(BYTE)(a)) << 24)))
 
#define SG_GET_R(rgb)   ((BYTE) ((rgb) ))
 
#define SG_GET_G(rgb)   ((BYTE) ((rgb) >> 8))
 
#define SG_GET_B(rgb)   ((BYTE) ((rgb) >> 16))
 
#define SG_GET_A(rgb)   ((BYTE) ((rgb) >> 24))
 
#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)   SG_Translate(L ## s)
 
#define _TW(s)   SG_Translate(CSG_String(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  TSG_Array_Growth {
  TSG_Array_Growth::SG_ARRAY_GROWTH_0 = 0, TSG_Array_Growth::SG_ARRAY_GROWTH_1, TSG_Array_Growth::SG_ARRAY_GROWTH_2, TSG_Array_Growth::SG_ARRAY_GROWTH_3,
  TSG_Array_Growth::SG_ARRAY_GROWTH_FIX_8, TSG_Array_Growth::SG_ARRAY_GROWTH_FIX_16, TSG_Array_Growth::SG_ARRAY_GROWTH_FIX_32, TSG_Array_Growth::SG_ARRAY_GROWTH_FIX_64,
  TSG_Array_Growth::SG_ARRAY_GROWTH_FIX_128, TSG_Array_Growth::SG_ARRAY_GROWTH_FIX_256, TSG_Array_Growth::SG_ARRAY_GROWTH_FIX_512, TSG_Array_Growth::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 }
 
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_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_YELLOW_RED, SG_COLORS_YELLOW_GREEN, SG_COLORS_YELLOW_BLUE,
  SG_COLORS_GREEN_RED, SG_COLORS_RED_GREEN, SG_COLORS_RED_BLUE, SG_COLORS_GREEN_BLUE,
  SG_COLORS_RED_GREY_BLUE, SG_COLORS_RED_GREY_GREEN, SG_COLORS_GREEN_GREY_BLUE, SG_COLORS_RED_GREEN_BLUE,
  SG_COLORS_RED_BLUE_GREEN, SG_COLORS_GREEN_RED_BLUE, SG_COLORS_RAINBOW, SG_COLORS_NEON,
  SG_COLORS_TOPOGRAPHY, SG_COLORS_TOPOGRAPHY_2, SG_COLORS_TOPOGRAPHY_3, SG_COLORS_PRECIPITATION,
  SG_COLORS_ASPECT_1, SG_COLORS_ASPECT_2, SG_COLORS_ASPECT_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_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 CSG_String SG_Dir_Get_Temp (void)
 
SAGA_API_DLL_EXPORT bool SG_Dir_List_Subdirectories (CSG_Strings &List, const CSG_String &Directory)
 
SAGA_API_DLL_EXPORT bool SG_Dir_List_Files (CSG_Strings &List, const CSG_String &Directory)
 
SAGA_API_DLL_EXPORT bool SG_Dir_List_Files (CSG_Strings &List, const CSG_String &Directory, const CSG_String &Extension)
 
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 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)
 
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 &FileName, const CSG_String &Extension)
 
SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Extension (const CSG_String &FileName)
 
SAGA_API_DLL_EXPORT bool SG_File_Set_Extension (CSG_String &FileName, 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_Translator & SG_Get_Translator (void)
 
SAGA_API_DLL_EXPORT const SG_Char * SG_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_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)    SG_Translate(L ## s)

Definition at line 1489 of file api_core.h.

◆ _TW

#define _TW (   s)    SG_Translate(CSG_String(s))

Definition at line 1490 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.

◆ SG_Char

#define SG_Char   wchar_t

Definition at line 536 of file api_core.h.

◆ SG_COLOR_BLACK

#define SG_COLOR_BLACK   SG_GET_RGB( 0, 0, 0)

Definition at line 1271 of file api_core.h.

◆ SG_COLOR_BLUE

#define SG_COLOR_BLUE   SG_GET_RGB( 0, 0, 255)

Definition at line 1282 of file api_core.h.

◆ SG_COLOR_BLUE_DARK

#define SG_COLOR_BLUE_DARK   SG_GET_RGB( 0, 0, 128)

Definition at line 1283 of file api_core.h.

◆ SG_COLOR_BLUE_GREEN

#define SG_COLOR_BLUE_GREEN   SG_GET_RGB( 0, 128, 128)

Definition at line 1285 of file api_core.h.

◆ SG_COLOR_BLUE_LIGHT

#define SG_COLOR_BLUE_LIGHT   SG_GET_RGB( 0, 255, 255)

Definition at line 1284 of file api_core.h.

◆ SG_COLOR_GREEN

#define SG_COLOR_GREEN   SG_GET_RGB( 0, 255, 0)

Definition at line 1279 of file api_core.h.

◆ SG_COLOR_GREEN_DARK

#define SG_COLOR_GREEN_DARK   SG_GET_RGB( 0, 128, 0)

Definition at line 1280 of file api_core.h.

◆ SG_COLOR_GREEN_LIGHT

#define SG_COLOR_GREEN_LIGHT   SG_GET_RGB( 0, 255, 0)

Definition at line 1281 of file api_core.h.

◆ SG_COLOR_GREY

#define SG_COLOR_GREY   SG_GET_RGB(128, 128, 128)

Definition at line 1272 of file api_core.h.

◆ SG_COLOR_GREY_LIGHT

#define SG_COLOR_GREY_LIGHT   SG_GET_RGB(192, 192, 192)

Definition at line 1273 of file api_core.h.

◆ SG_COLOR_NONE

#define SG_COLOR_NONE   -1

Definition at line 1288 of file api_core.h.

◆ SG_COLOR_PINK

#define SG_COLOR_PINK   SG_GET_RGB(255, 0, 255)

Definition at line 1287 of file api_core.h.

◆ SG_COLOR_PURPLE

#define SG_COLOR_PURPLE   SG_GET_RGB(128, 0, 128)

Definition at line 1286 of file api_core.h.

◆ SG_COLOR_RANDOM

#define SG_COLOR_RANDOM   -2

Definition at line 1289 of file api_core.h.

◆ SG_COLOR_RED

#define SG_COLOR_RED   SG_GET_RGB(255, 0, 0)

Definition at line 1275 of file api_core.h.

◆ SG_COLOR_RED_DARK

#define SG_COLOR_RED_DARK   SG_GET_RGB(128, 0, 0)

Definition at line 1276 of file api_core.h.

◆ SG_COLOR_WHITE

#define SG_COLOR_WHITE   SG_GET_RGB(255, 255, 255)

Definition at line 1274 of file api_core.h.

◆ SG_COLOR_YELLOW

#define SG_COLOR_YELLOW   SG_GET_RGB(255, 255, 0)

Definition at line 1277 of file api_core.h.

◆ SG_COLOR_YELLOW_DARK

#define SG_COLOR_YELLOW_DARK   SG_GET_RGB(128, 128, 0)

Definition at line 1278 of file api_core.h.

◆ SG_DATATYPES_Binary

#define SG_DATATYPES_Binary   0x4000

Definition at line 1029 of file api_core.h.

◆ SG_DATATYPES_Bit

#define SG_DATATYPES_Bit   0x0001

Definition at line 1015 of file api_core.h.

◆ SG_DATATYPES_Byte

#define SG_DATATYPES_Byte   0x0002

Definition at line 1016 of file api_core.h.

◆ SG_DATATYPES_Char

#define SG_DATATYPES_Char   0x0004

Definition at line 1017 of file api_core.h.

◆ SG_DATATYPES_Color

#define SG_DATATYPES_Color   0x2000

Definition at line 1028 of file api_core.h.

◆ SG_DATATYPES_Date

#define SG_DATATYPES_Date   0x1000

Definition at line 1027 of file api_core.h.

◆ SG_DATATYPES_Double

#define SG_DATATYPES_Double   0x0400

Definition at line 1025 of file api_core.h.

◆ SG_DATATYPES_DWord

#define SG_DATATYPES_DWord   0x0020

Definition at line 1020 of file api_core.h.

◆ SG_DATATYPES_Float

#define SG_DATATYPES_Float   0x0200

Definition at line 1024 of file api_core.h.

◆ SG_DATATYPES_Int

#define SG_DATATYPES_Int   0x0040

Definition at line 1021 of file api_core.h.

◆ SG_DATATYPES_Integer

#define SG_DATATYPES_Integer   (SG_DATATYPES_SInteger|SG_DATATYPES_UInteger)

Definition at line 1033 of file api_core.h.

◆ SG_DATATYPES_Long

#define SG_DATATYPES_Long   0x0100

Definition at line 1023 of file api_core.h.

◆ SG_DATATYPES_Numeric

#define SG_DATATYPES_Numeric   (SG_DATATYPES_Integer|SG_DATATYPES_Real)

Definition at line 1035 of file api_core.h.

◆ SG_DATATYPES_Real

#define SG_DATATYPES_Real   (SG_DATATYPES_Float|SG_DATATYPES_Double)

Definition at line 1034 of file api_core.h.

◆ SG_DATATYPES_Short

#define SG_DATATYPES_Short   0x0010

Definition at line 1019 of file api_core.h.

◆ SG_DATATYPES_SInteger

#define SG_DATATYPES_SInteger   (SG_DATATYPES_Char|SG_DATATYPES_Short|SG_DATATYPES_Int |SG_DATATYPES_Long)

Definition at line 1031 of file api_core.h.

◆ SG_DATATYPES_Standard

#define SG_DATATYPES_Standard   0xFFFF

Definition at line 1030 of file api_core.h.

◆ SG_DATATYPES_String

#define SG_DATATYPES_String   0x0800

Definition at line 1026 of file api_core.h.

◆ SG_DATATYPES_Table

#define SG_DATATYPES_Table   (SG_DATATYPES_String|SG_DATATYPES_Date|SG_DATATYPES_Color|SG_DATATYPES_Numeric|SG_DATATYPES_Binary)

Definition at line 1036 of file api_core.h.

◆ SG_DATATYPES_UInteger

#define SG_DATATYPES_UInteger   (SG_DATATYPES_Byte|SG_DATATYPES_Word |SG_DATATYPES_DWord|SG_DATATYPES_ULong)

Definition at line 1032 of file api_core.h.

◆ SG_DATATYPES_ULong

#define SG_DATATYPES_ULong   0x0080

Definition at line 1022 of file api_core.h.

◆ SG_DATATYPES_Undefined

#define SG_DATATYPES_Undefined   0x0000

Definition at line 1014 of file api_core.h.

◆ SG_DATATYPES_Word

#define SG_DATATYPES_Word   0x0008

Definition at line 1018 of file api_core.h.

◆ SG_DEFAULT_DELIMITERS

#define SG_DEFAULT_DELIMITERS   " \t\r\n"

Definition at line 745 of file api_core.h.

◆ SG_DELETE_ARRAY

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

Definition at line 207 of file api_core.h.

◆ SG_DELETE_SAFE

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

Definition at line 206 of file api_core.h.

◆ SG_FPRINTF

#define SG_FPRINTF   fwprintf

Definition at line 539 of file api_core.h.

◆ SG_FREE_SAFE

#define SG_FREE_SAFE (   PTR)    { if( PTR ) { SG_Free (PTR); PTR = NULL; } }

Definition at line 205 of file api_core.h.

◆ SG_GET_A

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

Definition at line 1268 of file api_core.h.

◆ SG_GET_B

#define SG_GET_B (   rgb)    ((BYTE) ((rgb) >> 16))

Definition at line 1267 of file api_core.h.

◆ SG_GET_BYTE_0

#define SG_GET_BYTE_0 (   vLong)    ((BYTE) ((vLong) ))

Definition at line 194 of file api_core.h.

◆ SG_GET_BYTE_1

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

Definition at line 195 of file api_core.h.

◆ SG_GET_BYTE_2

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

Definition at line 196 of file api_core.h.

◆ SG_GET_BYTE_3

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

Definition at line 197 of file api_core.h.

◆ SG_GET_G

#define SG_GET_G (   rgb)    ((BYTE) ((rgb) >> 8))

Definition at line 1266 of file api_core.h.

◆ SG_GET_LONG

#define SG_GET_LONG (   b0,
  b1,
  b2,
  b3 
)    ((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)    ((BYTE) ((rgb) ))

Definition at line 1265 of file api_core.h.

◆ SG_GET_RGB

#define SG_GET_RGB (   r,
  g,
  b 
)    ((DWORD) (((BYTE)(r) | ((WORD)(g) << 8)) | (((DWORD)(BYTE)(b)) << 16)))

Definition at line 1262 of file api_core.h.

◆ SG_GET_RGBA

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

Definition at line 1263 of file api_core.h.

◆ SG_is_NaN

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

Definition at line 168 of file api_core.h.

◆ 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.

◆ SG_STR_CMP

#define SG_STR_CMP (   s1,
  s2 
)    CSG_String(s1).Cmp(s2)

Definition at line 544 of file api_core.h.

◆ 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.

◆ SG_STR_MBTOSG

#define SG_STR_MBTOSG (   s)    CSG_String(s).w_str()

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)    L ## s

Definition at line 537 of file api_core.h.

◆ 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 1620 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_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_YELLOW_RED 
SG_COLORS_YELLOW_GREEN 
SG_COLORS_YELLOW_BLUE 
SG_COLORS_GREEN_RED 
SG_COLORS_RED_GREEN 
SG_COLORS_RED_BLUE 
SG_COLORS_GREEN_BLUE 
SG_COLORS_RED_GREY_BLUE 
SG_COLORS_RED_GREY_GREEN 
SG_COLORS_GREEN_GREY_BLUE 
SG_COLORS_RED_GREEN_BLUE 
SG_COLORS_RED_BLUE_GREEN 
SG_COLORS_GREEN_RED_BLUE 
SG_COLORS_RAINBOW 
SG_COLORS_NEON 
SG_COLORS_TOPOGRAPHY 
SG_COLORS_TOPOGRAPHY_2 
SG_COLORS_TOPOGRAPHY_3 
SG_COLORS_PRECIPITATION 
SG_COLORS_ASPECT_1 
SG_COLORS_ASPECT_2 
SG_COLORS_ASPECT_3 
SG_COLORS_COUNT 

Definition at line 1292 of file api_core.h.

◆ ESG_File_Flags_Open

enum ESG_File_Flags_Open
Enumerator
SG_FILE_R 
SG_FILE_W 
SG_FILE_RW 

Definition at line 1107 of file api_core.h.

◆ ESG_File_Flags_Seek

enum ESG_File_Flags_Seek
Enumerator
SG_FILE_START 
SG_FILE_CURRENT 
SG_FILE_END 

Definition at line 1115 of file api_core.h.

◆ TSG_Array_Growth

enum 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

enum 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 992 of file api_core.h.

◆ TSG_File_Flags_Encoding

enum 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

enum TSG_File_Type
Enumerator
SG_FILE_TYPE_NORMAL 
SG_FILE_TYPE_ZIP 

Definition at line 1099 of file api_core.h.

◆ TSG_String_Tokenizer_Mode

enum 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 747 of file api_core.h.

◆ TSG_UI_Callback_ID

enum 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_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 1551 of file api_core.h.

◆ TSG_UI_DataObject_Update

enum 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 1516 of file api_core.h.

◆ TSG_UI_Maps

enum TSG_UI_Maps
Enumerator
SG_UI_MAP_ACTIVE 
SG_UI_MAP_LAST 
SG_UI_MAP_ALL 

Definition at line 1527 of file api_core.h.

◆ TSG_UI_MSG_STYLE

enum 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 1500 of file api_core.h.

◆ TSG_UI_Window_Arrange

enum 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 1536 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 
)

Definition at line 71 of file api_memory.cpp.

Referenced by CSG_Grid_Radius::Create(), CSG_Formula::CSG_Formula(), and CSG_Table_DBase::Open_Write().

◆ 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 
)

Definition at line 85 of file api_colors.cpp.

References CSG_String::b_str(), CSG_String::Get_Char(), CSG_String::is_Empty(), CSG_String::Length(), SG_GET_RGB, and SG_GET_RGBA.

Referenced by CSG_Parameter_Color::_Set_Value().

◆ 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()

SAGA_API_DLL_EXPORT int SG_Data_Type_Get_Flag ( TSG_Data_Type  Type)

Definition at line 174 of file api_core.cpp.

References SG_DATATYPE_Binary, SG_DATATYPE_Bit, SG_DATATYPE_Byte, SG_DATATYPE_Char, SG_DATATYPE_Color, SG_DATATYPE_Date, SG_DATATYPE_Double, SG_DATATYPE_DWord, SG_DATATYPE_Float, SG_DATATYPE_Int, SG_DATATYPE_Long, SG_DATATYPE_Short, SG_DATATYPE_String, SG_DATATYPE_ULong, SG_DATATYPE_Word, SG_DATATYPES_Binary, SG_DATATYPES_Bit, SG_DATATYPES_Byte, SG_DATATYPES_Char, SG_DATATYPES_Color, SG_DATATYPES_Date, SG_DATATYPES_Double, SG_DATATYPES_DWord, SG_DATATYPES_Float, SG_DATATYPES_Int, SG_DATATYPES_Long, SG_DATATYPES_Short, SG_DATATYPES_String, SG_DATATYPES_ULong, SG_DATATYPES_Undefined, and SG_DATATYPES_Word.

◆ 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()

SAGA_API_DLL_EXPORT CSG_String SG_Data_Type_Get_Name ( TSG_Data_Type  Type,
bool  bShort = false 
)

Definition at line 123 of file api_core.cpp.

References _TL, SG_DATATYPE_Binary, SG_DATATYPE_Bit, SG_DATATYPE_Byte, SG_DATATYPE_Char, SG_DATATYPE_Color, SG_DATATYPE_Date, SG_DATATYPE_Double, SG_DATATYPE_DWord, SG_DATATYPE_Float, SG_DATATYPE_Int, SG_DATATYPE_Long, SG_DATATYPE_Short, SG_DATATYPE_String, SG_DATATYPE_ULong, and SG_DATATYPE_Word.

Referenced by CSG_Parameter::Get_Description(), and SG_XML_Add_Parameter().

◆ SG_Data_Type_Get_Size()

size_t SG_Data_Type_Get_Size ( TSG_Data_Type  Type)
inline

Definition at line 1060 of file api_core.h.

References SG_DATATYPE_Binary, SG_DATATYPE_Bit, SG_DATATYPE_Byte, SG_DATATYPE_Char, SG_DATATYPE_Color, SG_DATATYPE_Date, SG_DATATYPE_Double, SG_DATATYPE_DWord, SG_DATATYPE_Float, SG_DATATYPE_Int, SG_DATATYPE_Long, SG_DATATYPE_Short, SG_DATATYPE_String, SG_DATATYPE_ULong, and SG_DATATYPE_Word.

Referenced by CSG_Grid::Create().

◆ SG_Data_Type_Get_Type()

SAGA_API_DLL_EXPORT TSG_Data_Type SG_Data_Type_Get_Type ( const CSG_String &  Identifier)

Definition at line 153 of file api_core.cpp.

References CSG_String::Cmp(), gSG_Data_Type_Identifier, SG_DATATYPE_Bit, SG_DATATYPE_Byte, SG_DATATYPE_Char, SG_DATATYPE_Color, SG_DATATYPE_Date, SG_DATATYPE_Double, SG_DATATYPE_DWord, SG_DATATYPE_Float, SG_DATATYPE_Int, SG_DATATYPE_Long, SG_DATATYPE_Short, SG_DATATYPE_String, SG_DATATYPE_ULong, SG_DATATYPE_Undefined, and SG_DATATYPE_Word.

Referenced by CSG_Parameter_Fixed_Table::_Serialize(), CSG_Parameter_Data_Type::Get_Data_Type(), and CSG_Parameter_Data_Type::Set_Data_Type().

◆ SG_Data_Type_is_Numeric()

SAGA_API_DLL_EXPORT bool SG_Data_Type_is_Numeric ( TSG_Data_Type  Type)

Definition at line 198 of file api_core.cpp.

References SG_DATATYPE_Binary, SG_DATATYPE_Bit, SG_DATATYPE_Byte, SG_DATATYPE_Char, SG_DATATYPE_Color, SG_DATATYPE_Date, SG_DATATYPE_Double, SG_DATATYPE_DWord, SG_DATATYPE_Float, SG_DATATYPE_Int, SG_DATATYPE_Long, SG_DATATYPE_Short, SG_DATATYPE_String, SG_DATATYPE_ULong, and SG_DATATYPE_Word.

Referenced by CSG_PointCloud::Add_Shape().

◆ SG_Data_Type_Range_Check()

SAGA_API_DLL_EXPORT bool SG_Data_Type_Range_Check ( TSG_Data_Type  Type,
double &  Value 
)

Definition at line 224 of file api_core.cpp.

References SG_DATATYPE_Bit, SG_DATATYPE_Byte, SG_DATATYPE_Char, SG_DATATYPE_Double, SG_DATATYPE_DWord, SG_DATATYPE_Float, SG_DATATYPE_Int, SG_DATATYPE_Short, and SG_DATATYPE_Word.

◆ SG_Degree_To_Double()

SAGA_API_DLL_EXPORT double SG_Degree_To_Double ( const CSG_String &  String)

Definition at line 1226 of file api_string.cpp.

References CSG_String::AfterFirst(), CSG_String::asDouble(), CSG_String::BeforeFirst(), and SG_T.

Referenced by CSG_Parameter_Degree::_Set_Value().

◆ SG_Dir_Create()

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

Definition at line 749 of file api_file.cpp.

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

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), and CSG_Tool_Library_Manager::Get_Summary().

◆ SG_Dir_Delete()

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

Definition at line 760 of file api_file.cpp.

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

◆ SG_Dir_Exists()

SAGA_API_DLL_EXPORT bool SG_Dir_Exists ( const CSG_String &  Directory)

Definition at line 743 of file api_file.cpp.

References CSG_String::c_str().

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_File::Open(), CSG_File_Zip::Open(), SG_Dir_Create(), SG_Dir_Delete(), SG_File_Get_Name_Temp(), SG_Grid_Cache_Set_Directory(), and SG_Initialize_Environment().

◆ SG_Dir_Get_Current()

SAGA_API_DLL_EXPORT CSG_String SG_Dir_Get_Current ( void  )

Definition at line 771 of file api_file.cpp.

◆ SG_Dir_Get_Temp()

SAGA_API_DLL_EXPORT CSG_String SG_Dir_Get_Temp ( void  )

Definition at line 779 of file api_file.cpp.

◆ SG_Dir_List_Files() [1/2]

SAGA_API_DLL_EXPORT bool SG_Dir_List_Files ( CSG_Strings &  List,
const CSG_String &  Directory 
)

Definition at line 811 of file api_file.cpp.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox().

◆ SG_Dir_List_Files() [2/2]

SAGA_API_DLL_EXPORT bool SG_Dir_List_Files ( CSG_Strings &  List,
const CSG_String &  Directory,
const CSG_String &  Extension 
)

Definition at line 816 of file api_file.cpp.

References CSG_String::c_str(), CSG_Strings::Clear(), CSG_Strings::Get_Count(), CSG_String::is_Empty(), SG_File_Cmp_Extension(), and SG_File_Make_Path().

◆ SG_Dir_List_Subdirectories()

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

Definition at line 787 of file api_file.cpp.

References CSG_String::c_str(), CSG_Strings::Clear(), CSG_Strings::Get_Count(), and SG_File_Make_Path().

◆ SG_Double_To_Degree()

SAGA_API_DLL_EXPORT CSG_String SG_Double_To_Degree ( double  Value)

Definition at line 1206 of file api_string.cpp.

References CSG_String::Format(), SG_Get_Significant_Decimals(), and SG_T.

Referenced by CSG_Parameter_Degree::_Set_String().

◆ SG_File_Cmp_Extension()

SAGA_API_DLL_EXPORT bool SG_File_Cmp_Extension ( const CSG_String &  FileName,
const CSG_String &  Extension 
)

Definition at line 952 of file api_file.cpp.

References SG_File_Get_Extension().

Referenced by CSG_Data_Manager::Add(), CSG_Tool_Library_Manager::Add_Library(), CSG_Grid_File_Info::Create(), CSG_Shapes::Create(), CSG_Tool_Chain::Create(), CSG_PointCloud::Get_Header_Content(), CSG_MetaData::Load(), CSG_Table::Load(), CSG_Table::Save(), CSG_Grid::Save(), CSG_Grids::Save(), CSG_PointCloud::Save(), CSG_Shapes::Save(), and SG_Dir_List_Files().

◆ SG_File_Cmp_Path()

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

Definition at line 944 of file api_file.cpp.

References CSG_String::c_str().

◆ SG_File_Delete()

SAGA_API_DLL_EXPORT bool SG_File_Delete ( const CSG_String &  FileName)

Definition at line 856 of file api_file.cpp.

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

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Data_Object::Delete(), CSG_Grid::On_Delete(), CSG_Grids::On_Delete(), CSG_PointCloud::On_Delete(), CSG_Shapes::On_Delete(), CSG_Table::On_Delete(), and CSG_Projection::Save().

◆ SG_File_Exists()

SAGA_API_DLL_EXPORT bool SG_File_Exists ( const CSG_String &  FileName)

Definition at line 850 of file api_file.cpp.

References CSG_String::c_str().

Referenced by CSG_Parameter_List::_Serialize(), CSG_Tool_Library_Manager::Add_Library(), CSG_Projections::Create(), CSG_Table::Create(), CSG_Translator::Create(), CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Data_Collection::Delete(), CSG_Data_Object::Delete(), CSG_MetaData::Load(), CSG_Table::Load(), CSG_File::Open(), CSG_File_Zip::Open(), CSG_Data_Object::Reload(), CSG_Projection::Save(), and SG_File_Delete().

◆ SG_File_Get_Extension()

SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Extension ( const CSG_String &  FileName)

Definition at line 977 of file api_file.cpp.

References CSG_String::c_str().

Referenced by CSG_Data_Object::Load_MetaData(), and SG_File_Cmp_Extension().

◆ SG_File_Get_Name()

SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Name ( const CSG_String &  full_Path,
bool  bExtension 
)

Definition at line 878 of file api_file.cpp.

References CSG_String::c_str().

Referenced by CSG_Grid_File_Info::Create(), CSG_Tool_Library_Interface::Create(), CSG_PointCloud::Get_Header_Content(), CSG_Grids::Load(), CSG_Table::Load(), CSG_PointCloud::Save(), CSG_Data_Object::Set_File_Name(), and SG_File_Make_Path().

◆ 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 862 of file api_file.cpp.

◆ 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 867 of file api_file.cpp.

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

◆ SG_File_Get_Path()

SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Path ( const CSG_String &  full_Path)

Definition at line 891 of file api_file.cpp.

References CSG_String::c_str().

Referenced by CSG_Grid_File_Info::Create(), CSG_Tool_Library_Manager::Get_Summary(), CSG_File::Open(), CSG_File_Zip::Open(), SG_File_Make_Path(), and SG_UI_Get_Application_Path().

◆ SG_File_Get_Path_Absolute()

SAGA_API_DLL_EXPORT CSG_String SG_File_Get_Path_Absolute ( const CSG_String &  full_Path)

Definition at line 899 of file api_file.cpp.

References CSG_String::c_str().

Referenced by CSG_Tool_Library_Interface::Create(), CSG_Tool_Library::CSG_Tool_Library(), and SG_UI_Get_Application_Path().

◆ 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 909 of file api_file.cpp.

References CSG_String::c_str().

◆ SG_File_Make_Path() [1/2]

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

Definition at line 919 of file api_file.cpp.

Referenced by CSG_Tool_Library_Manager::Add_Default_Libraries(), CSG_Tool_Library_Manager::Add_Directory(), CSG_Projections::Create(), CSG_Translator::Create(), CSG_Grid_File_Info::Create(), CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Tool_Library::Get_Summary(), CSG_Tool_Library_Manager::Get_Summary(), CSG_MetaData::Load(), CSG_MetaData::Save(), CSG_PointCloud::Save(), CSG_Grid::Set_Cache(), SG_Dir_List_Files(), SG_Dir_List_Subdirectories(), SG_File_Get_Name_Temp(), and SG_FTP_Download().

◆ 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 
)

Definition at line 924 of file api_file.cpp.

References CSG_String::c_str(), CSG_String::is_Empty(), SG_File_Get_Name(), and SG_File_Get_Path().

◆ SG_File_Set_Extension()

SAGA_API_DLL_EXPORT bool SG_File_Set_Extension ( CSG_String &  FileName,
const CSG_String &  Extension 
)

Definition at line 958 of file api_file.cpp.

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

Referenced by CSG_Data_Object::Delete(), CSG_Data_Object::Load_MetaData(), CSG_Grid::On_Delete(), CSG_Grids::On_Delete(), CSG_Shapes::On_Delete(), CSG_PointCloud::Save(), and CSG_Data_Object::Save_MetaData().

◆ SG_Flip_Decimal_Separators()

SAGA_API_DLL_EXPORT void SG_Flip_Decimal_Separators ( CSG_String &  String)

Definition at line 1285 of file api_string.cpp.

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

◆ SG_Free()

SAGA_API_DLL_EXPORT void SG_Free ( void *  memblock)

Definition at line 83 of file api_memory.cpp.

Referenced by CSG_TIN::_Destroy_Edges(), CSG_TIN::_Destroy_Triangles(), CSG_TIN::_Triangulate(), CSG_PriorityQueue::Add(), CSG_Rects::Clear(), CSG_Rects_Int::Clear(), CSG_Parameters::Del_Parameters(), CSG_PointCloud::Del_Points(), CSG_PointCloud::Del_Selection(), CSG_Buffer::Destroy(), CSG_Bytes::Destroy(), CSG_Bytes_Array::Destroy(), CSG_Colors::Destroy(), CSG_Translator::Destroy(), CSG_Grid_Pyramid::Destroy(), CSG_Index::Destroy(), CSG_PriorityQueue::Destroy(), CSG_Matrix::Destroy(), CSG_Grid_Radius::Destroy(), CSG_PointCloud::Destroy(), CSG_Shape_Part::Destroy(), CSG_Table::Destroy(), CSG_Tool_Library_Manager::Destroy(), CSG_Colors::Load(), CSG_Formula::~CSG_Formula(), CSG_Parameter::~CSG_Parameter(), and CSG_Table_Record::~CSG_Table_Record().

◆ SG_Get_CurrentTimeStr()

SAGA_API_DLL_EXPORT CSG_String SG_Get_CurrentTimeStr ( bool  bWithDate = true)

Definition at line 1184 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 992 of file api_file.cpp.

References CSG_String::w_str().

Referenced by CSG_Tool_Library_Manager::Add_Default_Libraries().

◆ SG_Get_Significant_Decimals()

SAGA_API_DLL_EXPORT int SG_Get_Significant_Decimals ( double  Value,
int  maxDecimals = 6 
)

Definition at line 1256 of file api_string.cpp.

Referenced by CSG_Parameter_Double::_Serialize(), CSG_Parameter_Range::_Serialize(), CSG_Parameter_Double::_Set_String(), CSG_Parameter_Range::_Set_String(), CSG_Grid_System::Get_Name(), SG_Double_To_Degree(), and SG_Get_String().

◆ 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 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 1318 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 1368 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 1389 of file api_string.cpp.

References CSG_String::AfterFirst(), CSG_String::BeforeFirst(), CSG_String::Find(), CSG_String::is_Empty(), CSG_String::Left(), CSG_String::Length(), CSG_String::Replace(), and CSG_String::Right().

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Tool::Get_Summary(), and CSG_Tool_Library::Get_Summary().

◆ SG_Initialize_Environment()

SAGA_API_DLL_EXPORT bool SG_Initialize_Environment ( bool  bLibraries = true,
bool  bProjections = true,
const SG_Char *  SAGA_Path = NULL,
bool  bInitializeWX = true 
)

Definition at line 452 of file api_core.cpp.

References CSG_Tool_Library_Manager::Add_Default_Libraries(), CSG_String::c_str(), CSG_Projections::Create(), g_App_Initialize, g_SAGA_API_Path, SG_Add_Dll_Paths(), SG_Dir_Exists(), SG_Get_Projections(), SG_Get_Tool_Library_Manager(), SG_UI_Console_Print_StdOut(), SG_UI_Get_Application_Path(), and SG_UI_ProgressAndMsg_Lock().

◆ SG_is_Character_Numeric()

SAGA_API_DLL_EXPORT bool SG_is_Character_Numeric ( int  Character)

Definition at line 1150 of file api_string.cpp.

◆ SG_Malloc()

SAGA_API_DLL_EXPORT void* SG_Malloc ( size_t  size)

Definition at line 65 of file api_memory.cpp.

Referenced by CSG_TIN::_Triangulate(), CSG_Translator::Create(), CSG_PriorityQueue::Create(), CSG_Matrix::Create(), CSG_Table_Record::CSG_Table_Record(), CSG_Colors::Load(), CSG_String::to_ASCII(), CSG_String::to_MBChar(), and CSG_String::to_UTF8().

◆ 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()

SAGA_API_DLL_EXPORT void* SG_Realloc ( void *  memblock,
size_t  size 
)

Definition at line 77 of file api_memory.cpp.

Referenced by CSG_TIN::_Add_Edge(), CSG_Table_Record::_Add_Field(), CSG_Shape_Points::_Add_Part(), CSG_TIN::_Add_Triangle(), CSG_Shape_Part::_Alloc_Memory(), CSG_Table_Record::_Del_Field(), CSG_Parameter_Table_Fields::_Set_Value(), CSG_TIN::_Triangulate(), CSG_Rects::Add(), CSG_Rects_Int::Add(), CSG_Bytes_Array::Add(), CSG_Classifier_Supervised::Add_Class(), CSG_Table::Add_Field(), CSG_Tool_Library_Manager::Add_Library(), CSG_Matrix::Add_Rows(), CSG_Translator::Create(), CSG_Colors::Create(), CSG_PointCloud::Del_Field(), CSG_Table::Del_Field(), CSG_Tool_Library_Manager::Del_Library(), CSG_Parameters::Del_Parameter(), CSG_Shape_Points::Del_Part(), CSG_Matrix::Del_Rows(), CSG_Classifier_Supervised::Load(), CSG_Array::Set_Array(), CSG_Colors::Set_Count(), CSG_Colors::Set_Default(), CSG_Buffer::Set_Size(), and CSG_Classifier_Supervised::Train_Add_Sample().

◆ SG_Set_Environment()

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

Definition at line 1012 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()

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 
)

Definition at line 1540 of file api_string.cpp.

References CSG_String_Tokenizer::Get_Next_Token(), and CSG_String_Tokenizer::Has_More_Tokens().

Referenced by CSG_Tool_Library_Manager::Add_Default_Libraries(), CSG_Projection::Create(), CSG_Tool::Get_MenuPath(), and CSG_Parameter_Choice::Set_Items().

◆ SG_Swap_Bytes()

SAGA_API_DLL_EXPORT void SG_Swap_Bytes ( void *  Buffer,
int  nBytes 
)

Definition at line 154 of file api_memory.cpp.

Referenced by CSG_Bytes::Add(), CSG_Bytes::asDouble(), CSG_Buffer::asDouble(), CSG_Bytes::asDWord(), CSG_Bytes::asFloat(), CSG_Buffer::asFloat(), CSG_Bytes::asInt(), CSG_Buffer::asInt(), CSG_Bytes::asShort(), CSG_Buffer::asShort(), CSG_Bytes::asWord(), CSG_File::Read_Double(), CSG_File::Read_Int(), CSG_Buffer::Set_Value(), SG_Mem_Get_Double(), SG_Mem_Get_Int(), SG_Mem_Set_Double(), SG_Mem_Set_Int(), CSG_File::Write_Double(), and CSG_File::Write_Int().

◆ 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 CSG_Translator::Get_Translation(), and gSG_Translator.

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 
)

Definition at line 102 of file api_callback.cpp.

References SG_UI_Console_Print_StdErr().

Referenced by SG_UI_Console_Print_StdErr(), and SG_UI_Msg_Add_Error().

◆ 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 
)

Definition at line 104 of file api_callback.cpp.

References gSG_UI_Console_bUTF8, CSG_String::to_ASCII(), and CSG_String::to_UTF8().

◆ 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_UI_Console_Print_StdErr().

◆ SG_UI_Console_Print_StdOut() [1/3]

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

Definition at line 77 of file api_callback.cpp.

References SG_UI_Console_Print_StdOut().

Referenced by CSG_Data_Object::CSG_Data_Object(), SG_Initialize_Environment(), SG_UI_Console_Print_StdOut(), SG_UI_Dlg_Info(), SG_UI_Dlg_Message(), SG_UI_Msg_Add(), SG_UI_Msg_Add_Execution(), SG_UI_Process_Get_Okay(), SG_UI_Process_Set_Progress(), SG_UI_Process_Set_Text(), CSG_Data_Object::Track(), and CSG_Data_Object::~CSG_Data_Object().

◆ 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 
)

Definition at line 79 of file api_callback.cpp.

References gSG_UI_Console_bUTF8, CSG_String::to_ASCII(), and CSG_String::to_UTF8().

◆ 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_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()

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

Definition at line 610 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_ADD, and gSG_UI_Callback.

Referenced by CSG_Parameter_Data_Object_Output::_Set_Value(), CSG_Data_Manager::Add(), and CSG_Tool::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 670 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_ASIMAGE, and gSG_UI_Callback.

◆ 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 683 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 
)

Definition at line 696 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_COLORS_SET, gSG_UI_Callback, and gSG_UI_Progress_Lock.

Referenced by CSG_Tool::DataObject_Set_Colors().

◆ SG_UI_DataObject_Del()

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

Definition at line 623 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 
)

Definition at line 709 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_PARAMS_GET, and gSG_UI_Callback.

Referenced by CSG_Tool::DataObject_Get_Parameters().

◆ SG_UI_DataObject_Params_Set()

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

Definition at line 722 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_PARAMS_SET, gSG_UI_Callback, and gSG_UI_Progress_Lock.

Referenced by CSG_Tool::DataObject_Set_Parameters().

◆ SG_UI_DataObject_Show()

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

Definition at line 657 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_SHOW, and gSG_UI_Callback.

Referenced by SG_UI_DataObject_Update().

◆ SG_UI_DataObject_Update()

SAGA_API_DLL_EXPORT bool SG_UI_DataObject_Update ( class CSG_Data_Object *  pDataObject,
int  Show,
class CSG_Parameters *  pParameters 
)

Definition at line 636 of file api_callback.cpp.

References CALLBACK_DATAOBJECT_UPDATE, CSG_Data_Object::Get_Owner(), gSG_UI_Callback, SG_UI_DataObject_Show(), and SG_UI_DATAOBJECT_UPDATE.

Referenced by CSG_Tool::DataObject_Update(), and SG_UI_Diagram_Show().

◆ SG_UI_Diagram_Show()

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

Definition at line 748 of file api_callback.cpp.

References CALLBACK_DIAGRAM_SHOW, gSG_UI_Callback, SG_UI_DataObject_Update(), and SG_UI_DATAOBJECT_UPDATE.

◆ SG_UI_Dlg_Continue()

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

Definition at line 386 of file api_callback.cpp.

References CALLBACK_DLG_CONTINUE, gSG_UI_Callback, and gSG_UI_Progress_Lock.

Referenced by CSG_Tool::Message_Dlg_Confirm().

◆ SG_UI_Dlg_Error()

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

Definition at line 402 of file api_callback.cpp.

References CALLBACK_DLG_ERROR, gSG_UI_Callback, gSG_UI_Progress_Lock, and SG_UI_Msg_Add_Error().

Referenced by CSG_Tool::Error_Set().

◆ SG_UI_Dlg_Info()

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

Definition at line 423 of file api_callback.cpp.

References CSG_String::c_str(), CALLBACK_DLG_INFO, CSG_String::Format(), gSG_UI_Callback, gSG_UI_Progress_Lock, and SG_UI_Console_Print_StdOut().

◆ SG_UI_Dlg_Message()

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

Definition at line 368 of file api_callback.cpp.

References CSG_String::c_str(), CALLBACK_DLG_MESSAGE, CSG_String::Format(), gSG_UI_Callback, gSG_UI_Progress_Lock, and SG_UI_Console_Print_StdOut().

Referenced by CSG_Parameters::DataObjects_Check(), and CSG_Tool::Message_Dlg().

◆ SG_UI_Dlg_Parameters()

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

Definition at line 448 of file api_callback.cpp.

References CALLBACK_DLG_PARAMETERS, CSG_Parameters::Get_Name(), gSG_UI_Callback, and CSG_String::is_Empty().

Referenced by CSG_Tool::Dlg_Parameters().

◆ SG_UI_Get_API_Path()

SAGA_API_DLL_EXPORT CSG_String SG_UI_Get_API_Path ( void  )

Definition at line 345 of file api_core.cpp.

References g_SAGA_API_Path, CSG_String::is_Empty(), SG_UI_Get_Application_Name(), and SG_UI_Get_Application_Path().

Referenced by CSG_Tool_Library_Manager::Add_Default_Libraries(), and CSG_Projections::Create().

◆ 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, and CSG_String::is_Empty().

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

◆ SG_UI_Get_Application_Path()

SAGA_API_DLL_EXPORT CSG_String SG_UI_Get_Application_Path ( bool  bPathOnly = false)

Definition at line 356 of file api_core.cpp.

References CSG_String::is_Empty(), SG_File_Get_Path(), and SG_File_Get_Path_Absolute().

Referenced by CSG_Tool_Library_Manager::Add_Default_Libraries(), CSG_Projections::Create(), SG_Initialize_Environment(), and SG_UI_Get_API_Path().

◆ SG_UI_Get_Window_Main()

SAGA_API_DLL_EXPORT void* SG_UI_Get_Window_Main ( void  )

Definition at line 796 of file api_callback.cpp.

References CALLBACK_GET_APP_WINDOW, gSG_UI_Callback, and CSG_UI_Parameter::Pointer.

Referenced by CSG_Tool_Library_Manager::Destroy(), and CSG_Parameters::has_GUI().

◆ SG_UI_Msg_Add() [1/3]

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 
)

Definition at line 502 of file api_callback.cpp.

References SG_UI_Msg_Add().

Referenced by CSG_Tool_Library_Manager::Add_Library(), CSG_Shapes::Create(), CSG_Tool_Chain::Create(), CSG_Grid::Create(), CSG_Table::Create(), CSG_TIN::Create(), CSG_Tool::Execute(), CSG_Grids::Load(), CSG_Table::Save(), CSG_Grid::Save(), CSG_Grids::Save(), CSG_PointCloud::Save(), CSG_Shapes::Save(), and SG_UI_Msg_Add().

◆ 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 
)

Definition at line 504 of file api_callback.cpp.

References CALLBACK_MESSAGE_ADD, gSG_UI_Callback, gSG_UI_Msg_Lock, and SG_UI_Console_Print_StdOut().

◆ 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 503 of file api_callback.cpp.

References SG_UI_Msg_Add().

◆ SG_UI_Msg_Add_Error() [1/3]

SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Error ( const char *  Message)

Definition at line 556 of file api_callback.cpp.

References SG_UI_Msg_Add_Error().

Referenced by CSG_Tool_Library_Interface::Create(), CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Tool::Error_Set(), CSG_Parameters::Get_Parameter(), CSG_Table_DBase::Open_Read(), CSG_Table_DBase::Open_Write(), SG_FTP_Download(), SG_UI_Dlg_Error(), and SG_UI_Msg_Add_Error().

◆ SG_UI_Msg_Add_Error() [2/3]

SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Error ( const CSG_String &  Message)

Definition at line 558 of file api_callback.cpp.

References _TL, CSG_String::c_str(), CALLBACK_MESSAGE_ADD_ERROR, CSG_String::Format(), gSG_UI_Callback, gSG_UI_Msg_Lock, and SG_UI_Console_Print_StdErr().

◆ SG_UI_Msg_Add_Error() [3/3]

SAGA_API_DLL_EXPORT void SG_UI_Msg_Add_Error ( const wchar_t *  Message)

Definition at line 557 of file api_callback.cpp.

References SG_UI_Msg_Add_Error().

◆ SG_UI_Msg_Add_Execution() [1/3]

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 
)

Definition at line 529 of file api_callback.cpp.

References SG_UI_Msg_Add_Execution().

Referenced by CSG_Tool::Execute(), CSG_Parameters_CRSPicker::Get_CRS(), CSG_Tool::Message_Add(), CSG_Parameters::Msg_String(), and SG_UI_Msg_Add_Execution().

◆ 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 
)

Definition at line 531 of file api_callback.cpp.

References CALLBACK_MESSAGE_ADD_EXECUTION, gSG_UI_Callback, gSG_UI_Msg_Lock, and SG_UI_Console_Print_StdOut().

◆ 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 530 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 576 of file api_callback.cpp.

◆ SG_UI_Msg_is_Locked()

SAGA_API_DLL_EXPORT bool SG_UI_Msg_is_Locked ( void  )

Definition at line 486 of file api_callback.cpp.

References gSG_UI_Msg_Lock.

◆ SG_UI_Msg_Lock()

SAGA_API_DLL_EXPORT int SG_UI_Msg_Lock ( bool  bOn)

Definition at line 471 of file api_callback.cpp.

References gSG_UI_Msg_Lock.

Referenced by CSG_Tool_Library_Manager::Add_Default_Libraries(), CSG_Translator::Create(), CSG_Grid::Save(), and SG_UI_ProgressAndMsg_Lock().

◆ SG_UI_Msg_Reset()

SAGA_API_DLL_EXPORT int SG_UI_Msg_Reset ( void  )

Definition at line 492 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 761 of file api_callback.cpp.

References CALLBACK_DATABASE_UPDATE, and gSG_UI_Callback.

◆ SG_UI_Process_Get_Okay()

SAGA_API_DLL_EXPORT bool SG_UI_Process_Get_Okay ( bool  bBlink = false)

Definition at line 207 of file api_callback.cpp.

References CALLBACK_PROCESS_GET_OKAY, CSG_String::Format(), gSG_UI_Callback, gSG_UI_Progress_Lock, SG_Char, and SG_UI_Console_Print_StdOut().

Referenced by CSG_Shapes::Assign(), CSG_Tool::Error_Set(), CSG_Regression_Multiple::Get_CrossValidation(), CSG_Regression_Multiple::Get_Model_Stepwise(), CSG_Trend::Get_Trend(), CSG_Tool::is_Progress(), CSG_Tool::Process_Get_Okay(), SG_Matrix_LU_Decomposition(), and SG_UI_Process_Set_Progress().

◆ 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()

SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Okay ( bool  bOkay = true)

Definition at line 229 of file api_callback.cpp.

References CALLBACK_PROCESS_SET_OKAY, gSG_UI_Callback, and gSG_UI_Progress_Lock.

Referenced by CSG_Tool::Error_Set(), CSG_Tool::Execute(), CSG_Tool_Interactive_Base::Execute_Finish(), CSG_Tool_Interactive_Base::Execute_Keyboard(), and CSG_Tool_Interactive_Base::Execute_Position().

◆ SG_UI_Process_Set_Progress() [1/3]

SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Progress ( double  Position,
double  Range 
)

Definition at line 267 of file api_callback.cpp.

References CALLBACK_PROCESS_SET_PROGRESS, CSG_String::Format(), gSG_UI_Callback, gSG_UI_Progress_Lock, SG_UI_Console_Print_StdOut(), and SG_UI_Process_Get_Okay().

◆ SG_UI_Process_Set_Progress() [2/3]

SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Progress ( int  Position,
int  Range 
)

Definition at line 255 of file api_callback.cpp.

References SG_UI_Process_Set_Progress().

Referenced by CSG_Table::_Save_Text(), CSG_TIN::_Triangulate(), CSG_Grid::Assign(), CSG_TIN::Create(), CSG_PRQuadTree::Create(), CSG_Thin_Plate_Spline::Create(), CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Grid_OGIS_Converter::from_WKBinary(), CSG_Shapes::Make_Clean(), CSG_Grid::On_Update(), CSG_Table_DBase::Open_Read(), CSG_Table_DBase::Open_Write(), CSG_Matrix::Set_Inverse(), CSG_Tool::Set_Progress(), SG_Matrix_LU_Decomposition(), SG_Matrix_LU_Solve(), SG_UI_Process_Set_Progress(), SG_UI_Process_Set_Ready(), and CSG_Grid_OGIS_Converter::to_WKBinary().

◆ 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()

SAGA_API_DLL_EXPORT bool SG_UI_Process_Set_Ready ( void  )

Definition at line 305 of file api_callback.cpp.

References CALLBACK_PROCESS_SET_READY, gSG_UI_Callback, gSG_UI_Progress_Lock, and SG_UI_Process_Set_Progress().

Referenced by CSG_Table::_Save_Text(), CSG_TIN::_Triangulate(), CSG_Grid::Assign(), CSG_Shapes::Create(), CSG_Grid::Create(), CSG_TIN::Create(), CSG_Tool::Execute(), CSG_Tool_Interactive_Base::Execute_Finish(), CSG_Tool_Interactive_Base::Execute_Keyboard(), CSG_Tool_Interactive_Base::Execute_Position(), CSG_Grids::Load(), CSG_Grid::On_Update(), CSG_Table_DBase::Open_Read(), CSG_Table_DBase::Open_Write(), CSG_Grid::Save(), CSG_Grids::Save(), CSG_PointCloud::Save(), and CSG_Shapes::Save().

◆ SG_UI_Process_Set_Text()

SAGA_API_DLL_EXPORT void SG_UI_Process_Set_Text ( const CSG_String &  Text)

Definition at line 323 of file api_callback.cpp.

References CALLBACK_PROCESS_SET_TEXT, gSG_UI_Callback, gSG_UI_Progress_Lock, and SG_UI_Console_Print_StdOut().

Referenced by CSG_Thin_Plate_Spline::Create(), CSG_Tool_Library_Manager::Create_Python_ToolBox(), and CSG_Tool::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()

SAGA_API_DLL_EXPORT void SG_UI_ProgressAndMsg_Lock ( bool  bOn)

Definition at line 589 of file api_callback.cpp.

References SG_UI_Msg_Lock(), and SG_UI_Progress_Lock().

Referenced by CSG_Shapes::Create(), CSG_Table::Create(), CSG_Projections::Parse(), SG_Get_Projected(), and SG_Initialize_Environment().

◆ SG_UI_ProgressAndMsg_Reset()

SAGA_API_DLL_EXPORT void SG_UI_ProgressAndMsg_Reset ( void  )

Definition at line 596 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 735 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 781 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 1039 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().