SAGA API Version 9.14
Loading...
Searching...
No Matches
CSG_Environment Class Reference

#include <api_core.h>

Static Public Member Functions

static bool Initialize (bool bInitializeWX=false, bool bInitializeGUI=false, bool bProjections=true, bool bLibraries=false, const SG_Char *SAGA_Path=NULL)
static bool Uninitialize (void)
static const CSG_String & Get_Application_Path (bool bPathOnly)
static const CSG_String & Get_Application_Name (void)
static bool Set_Application_Name (const CSG_String &Name="")
static const CSG_String & Get_API_Path (void)
static bool Set_API_Path (const CSG_String &Path="")
static CSG_String Get_Share_Path (const CSG_String &AddPath="")
static CSG_String Get_Ressources_Path (const CSG_String &AddPath="")
static CSG_Strings Get_Tool_Paths (void)
static bool is_GUI (void)
static bool is_CMD (void)
static bool is_Python (void)
static bool Get_Variable (const CSG_String &Variable)
static bool Get_Variable (const CSG_String &Variable, CSG_String &Value)
static bool Set_Variable (const CSG_String &Variable, const CSG_String &Value)
static CSG_String Get_Option (const CSG_String &Variable, bool bGetVariable=true)
static bool Get_Option (const CSG_String &Variable, CSG_String &Value, bool bGetVariable=true)
static bool Set_Option (const CSG_String &Variable, const CSG_String &Value, bool bSetVariable=true)

Detailed Description

Definition at line 1854 of file api_core.h.

Member Function Documentation

◆ Get_API_Path()

const CSG_String & CSG_Environment::Get_API_Path ( void )
static

Definition at line 480 of file api_core.cpp.

References Get_Application_Path(), and theEnvironment.

Referenced by Get_Tool_Paths().

◆ Get_Application_Name()

const CSG_String & CSG_Environment::Get_Application_Name ( void )
static

Definition at line 448 of file api_core.cpp.

References Get_Application_Path(), SG_File_Get_Name(), and theEnvironment.

Referenced by CSG_Tool_Library_Interface::Create(), CSG_Tool::CSG_Tool(), is_CMD(), is_GUI(), and is_Python().

◆ Get_Application_Path()

const CSG_String & CSG_Environment::Get_Application_Path ( bool bPathOnly)
static

Definition at line 433 of file api_core.cpp.

References SG_File_Get_Path(), SG_File_Get_Path_Absolute(), and theEnvironment.

Referenced by Get_API_Path(), Get_Application_Name(), Get_Share_Path(), Get_Tool_Paths(), and Initialize().

◆ Get_Option() [1/2]

CSG_String CSG_Environment::Get_Option ( const CSG_String & Variable,
bool bGetVariable = true )
static

Definition at line 620 of file api_core.cpp.

References Get_Option().

Referenced by Get_Option().

◆ Get_Option() [2/2]

bool CSG_Environment::Get_Option ( const CSG_String & Variable,
CSG_String & Value,
bool bGetVariable = true )
static

Definition at line 626 of file api_core.cpp.

References Get_Variable(), and theEnvironment.

◆ Get_Ressources_Path()

CSG_String CSG_Environment::Get_Ressources_Path ( const CSG_String & AddPath = "")
static

Definition at line 528 of file api_core.cpp.

References Get_Share_Path(), and SG_File_Make_Path().

◆ Get_Share_Path()

CSG_String CSG_Environment::Get_Share_Path ( const CSG_String & AddPath = "")
static

Definition at line 491 of file api_core.cpp.

References CSG_String::Clear(), CSG_String::Find(), Get_Application_Path(), CSG_String::Left(), and SG_File_Make_Path().

Referenced by CSG_Projections::Create(), Get_Ressources_Path(), and Initialize().

◆ Get_Tool_Paths()

CSG_Strings CSG_Environment::Get_Tool_Paths ( void )
static

Definition at line 542 of file api_core.cpp.

References CSG_String::Find(), Get_API_Path(), Get_Application_Path(), CSG_Strings::Get_Count(), Get_Variable(), CSG_String::Left(), SG_File_Make_Path(), and SG_String_Tokenize().

Referenced by CSG_Tool_Library_Manager::Add_Default_Libraries().

◆ Get_Variable() [1/2]

bool CSG_Environment::Get_Variable ( const CSG_String & Variable)
static

Definition at line 662 of file api_core.cpp.

References CSG_String::wx_str().

Referenced by Get_Option(), Get_Tool_Paths(), and SG_Get_Environment().

◆ Get_Variable() [2/2]

bool CSG_Environment::Get_Variable ( const CSG_String & Variable,
CSG_String & Value )
static

Definition at line 667 of file api_core.cpp.

References CSG_String::wx_str().

◆ Initialize()

bool CSG_Environment::Initialize ( bool bInitializeWX = false,
bool bInitializeGUI = false,
bool bProjections = true,
bool bLibraries = false,
const SG_Char * SAGA_Path = NULL )
static

Definition at line 289 of file api_core.cpp.

References CSG_Tool_Library_Manager::Add_Default_Libraries(), CSG_String::c_str(), CSG_Projections::Create(), CSG_String::Format(), Get_Application_Path(), Get_Share_Path(), Set_API_Path(), Set_Option(), Set_Variable(), SG_Char, SG_Dir_Exists(), SG_File_Exists(), SG_File_Make_Path(), SG_Get_Projections(), SG_Get_Tool_Library_Manager(), SG_UI_Console_Print_StdErr(), SG_UI_Console_Print_StdOut(), SG_UI_ProgressAndMsg_Lock(), and theEnvironment.

◆ is_CMD()

bool CSG_Environment::is_CMD ( void )
static

Definition at line 611 of file api_core.cpp.

References Get_Application_Name().

◆ is_GUI()

bool CSG_Environment::is_GUI ( void )
static

Definition at line 610 of file api_core.cpp.

References Get_Application_Name().

◆ is_Python()

bool CSG_Environment::is_Python ( void )
static

Definition at line 612 of file api_core.cpp.

References Get_Application_Name().

◆ Set_API_Path()

bool CSG_Environment::Set_API_Path ( const CSG_String & Path = "")
static

Definition at line 467 of file api_core.cpp.

References SG_Dir_Exists(), and theEnvironment.

Referenced by Initialize().

◆ Set_Application_Name()

bool CSG_Environment::Set_Application_Name ( const CSG_String & Name = "")
static

Definition at line 459 of file api_core.cpp.

References theEnvironment.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox().

◆ Set_Option()

bool CSG_Environment::Set_Option ( const CSG_String & Variable,
const CSG_String & Value,
bool bSetVariable = true )
static

Definition at line 639 of file api_core.cpp.

References Set_Variable(), and theEnvironment.

Referenced by Initialize().

◆ Set_Variable()

bool CSG_Environment::Set_Variable ( const CSG_String & Variable,
const CSG_String & Value )
static

Definition at line 682 of file api_core.cpp.

References CSG_String::wx_str().

Referenced by Initialize(), Set_Option(), and SG_Set_Environment().

◆ Uninitialize()

bool CSG_Environment::Uninitialize ( void )
static

Definition at line 415 of file api_core.cpp.

References theEnvironment.

The documentation for this class was generated from the following files: