api_core.cpp File Reference

#include <wx/utils.h>
#include <wx/app.h>
#include <wx/dir.h>
#include <wx/stdpaths.h>
#include "api_core.h"
#include "tool_library.h"

Go to the source code of this file.

Functions
void	SG_OMP_Set_Max_Num_Threads (int iCores)
int	SG_OMP_Get_Max_Num_Threads (void)
int	SG_OMP_Get_Max_Num_Procs (void)
int	SG_OMP_Get_Thread_Num (void)
CSG_String	SG_Data_Type_Get_Name (TSG_Data_Type Type, bool bShort)
CSG_String	SG_Data_Type_Get_Identifier (TSG_Data_Type Type)
TSG_Data_Type	SG_Data_Type_Get_Type (const CSG_String &Identifier)
int	SG_Data_Type_Get_Flag (TSG_Data_Type Type)
bool	SG_Data_Type_is_Numeric (TSG_Data_Type Type)
bool	SG_Data_Type_Range_Check (TSG_Data_Type Type, double &Value)
CSG_String	SG_UI_Get_API_Path (void)
CSG_String	SG_UI_Get_Application_Path (bool bPathOnly)
CSG_String	SG_UI_Get_Application_Name (void)
CSG_String	SG_UI_Set_Application_Name (const CSG_String &Name)
bool	SG_Add_Dll_Paths (const wxString &Directory, wxString &Paths)
bool	SG_Initialize_Environment (bool bLibraries, bool bProjections, const SG_Char *SAGA_Path, bool bInitializeWX)
bool	SG_Uninitialize_Environment (void)

Variables
CSG_App_Initialize	g_App_Initialize
CSG_String	g_SAGA_API_Path
CSG_String	g_App_Name

Function Documentation

SG_Add_Dll_Paths()

bool SG_Add_Dll_Paths	(	const wxString &	Directory,
		wxString &	Paths
	)

Definition at line 403 of file api_core.cpp.

Referenced by SG_Initialize_Environment().

SG_Data_Type_Get_Flag()

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

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

CSG_String SG_Data_Type_Get_Name	(	TSG_Data_Type	Type,
		bool	bShort
	)

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

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

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

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

bool SG_Initialize_Environment	(	bool	bLibraries,
		bool	bProjections,
		const SG_Char *	SAGA_Path,
		bool	bInitializeWX
	)

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

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

int SG_OMP_Get_Max_Num_Threads

(

void

)

Definition at line 110 of file api_core.cpp.

SG_OMP_Get_Thread_Num()

int SG_OMP_Get_Thread_Num

(

void

)

Definition at line 112 of file api_core.cpp.

SG_OMP_Set_Max_Num_Threads()

void SG_OMP_Set_Max_Num_Threads

(

int

iCores

)

Definition at line 109 of file api_core.cpp.

SG_UI_Get_API_Path()

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

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

CSG_String SG_UI_Get_Application_Path

(

bool

bPathOnly

)

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

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

bool SG_Uninitialize_Environment

(

void

)

Definition at line 528 of file api_core.cpp.

References g_App_Initialize.

Variable Documentation

g_App_Initialize

CSG_App_Initialize g_App_Initialize

Definition at line 335 of file api_core.cpp.

Referenced by SG_Initialize_Environment(), and SG_Uninitialize_Environment().

g_App_Name

CSG_String g_App_Name

Definition at line 376 of file api_core.cpp.

Referenced by SG_UI_Get_Application_Name(), and SG_UI_Set_Application_Name().

g_SAGA_API_Path

CSG_String g_SAGA_API_Path

Definition at line 343 of file api_core.cpp.

Referenced by SG_Initialize_Environment(), and SG_UI_Get_API_Path().