![]() |
SAGA API
v9.2
|
#include <tool.h>
Public Member Functions | |
CSG_Tool (void) | |
virtual | ~CSG_Tool (void) |
virtual void | Destroy (void) |
virtual TSG_Tool_Type | Get_Type (void) const |
const CSG_String & | Get_ID (void) const |
const CSG_String & | Get_Library (void) const |
const CSG_String & | Get_File_Name (void) const |
const CSG_String & | Get_Name (void) const |
const CSG_String & | Get_Author (void) const |
const CSG_String & | Get_Version (void) const |
const CSG_String & | Get_Description (void) const |
const CSG_Strings & | Get_References (void) const |
const SG_Char * | Get_Icon (void) |
CSG_String | Get_Summary (bool bParameters=true, const CSG_String &Menu="", const CSG_String &Description="", int Format=SG_SUMMARY_FMT_HTML) |
virtual CSG_String | Get_MenuPath (void) |
virtual CSG_String | Get_MenuPath (bool bSolved) |
int | Get_Parameters_Count (void) |
CSG_Parameters * | Get_Parameters (void) |
CSG_Parameters * | Get_Parameters (int i) |
CSG_Parameters * | Get_Parameters (const CSG_String &Identifier) |
CSG_Parameter * | Get_Parameter (const CSG_String &ID) const |
CSG_Parameter * | Get_Parameter (const char *ID) const |
CSG_Parameter * | Get_Parameter (const wchar_t *ID) const |
bool | Set_Parameter (const CSG_String &ID, CSG_Parameter *pValue) |
bool | Set_Parameter (const char *ID, CSG_Parameter *pValue) |
bool | Set_Parameter (const wchar_t *ID, CSG_Parameter *pValue) |
bool | Set_Parameter (const CSG_String &ID, int Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const char *ID, int Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const wchar_t *ID, int Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const CSG_String &ID, double Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const char *ID, double Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const wchar_t *ID, double Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const CSG_String &ID, void *Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const char *ID, void *Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const wchar_t *ID, void *Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const CSG_String &ID, const CSG_String &Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const char *ID, const CSG_String &Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const wchar_t *ID, const CSG_String &Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const CSG_String &ID, const char *Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const char *ID, const char *Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const wchar_t *ID, const char *Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const CSG_String &ID, const wchar_t *Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const char *ID, const wchar_t *Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Set_Parameter (const wchar_t *ID, const wchar_t *Value, int Type=PARAMETER_TYPE_Undefined) |
bool | Reset (bool bManager=true) |
bool | Reset_Manager (void) |
bool | Reset_Grid_System (void) |
bool | Update_Parameter_States (void) |
void | Set_Callback (bool bActive=true) |
bool | Set_Manager (class CSG_Data_Manager *pManager) |
class CSG_Data_Manager * | Get_Manager (void) const |
class CSG_Data_Manager * | Create_Manager (void) |
bool | Delete_Manager (bool bDetachData=false, bool bReset=true) |
bool | Set_Grid_System (const CSG_Grid_System &System) |
CSG_Grid_System * | Get_Grid_System (void) const |
bool | Settings_Push (class CSG_Data_Manager *pManager=NULL) |
bool | Settings_Pop (void) |
virtual bool | do_Sync_Projections (void) const |
virtual bool | needs_GUI (void) const |
bool | has_GUI (void) const |
virtual bool | is_Grid (void) const |
virtual bool | is_Interactive (void) const |
bool | is_Progress (void) const |
bool | is_Executing (void) const |
void | Set_Show_Progress (bool bOn=true) |
virtual bool | On_Before_Execution (void) |
virtual bool | On_After_Execution (void) |
bool | Execute (bool bAddHistory=false) |
const SG_Char * | Get_Execution_Info (void) const |
CSG_String | Get_Script (TSG_Tool_Script_Type Type, bool bHeader, bool bAllParameters=false) |
Static Public Member Functions | |
static bool | Process_Get_Okay (bool bBlink=false) |
static void | Process_Set_Text (const CSG_String &Text) |
static void | Process_Set_Text (const char *Format,...) |
static void | Process_Set_Text (const wchar_t *Format,...) |
static bool | DataObject_Update (CSG_Data_Object *pDataObject, int Show=SG_UI_DATAOBJECT_UPDATE) |
static bool | DataObject_Update (CSG_Data_Object *pDataObject, double Minimum, double Maximum, int Show=SG_UI_DATAOBJECT_UPDATE) |
static bool | DataObject_Get_Colors (CSG_Data_Object *pDataObject, CSG_Colors &Colors) |
static bool | DataObject_Set_Colors (CSG_Data_Object *pDataObject, const CSG_Colors &Colors) |
static bool | DataObject_Set_Colors (CSG_Data_Object *pDataObject, int nColors, int Palette=SG_COLORS_DEFAULT, bool bRevert=false) |
static bool | DataObject_Get_Parameters (CSG_Data_Object *pDataObject, CSG_Parameters &Parameters) |
static bool | DataObject_Set_Parameters (CSG_Data_Object *pDataObject, CSG_Parameters &Parameters) |
static bool | DataObject_Set_Parameters (CSG_Data_Object *pDataObject, CSG_Data_Object *pCopy) |
static CSG_Parameter * | DataObject_Get_Parameter (CSG_Data_Object *pDataObject, const CSG_String &ID) |
static bool | DataObject_Set_Parameter (CSG_Data_Object *pDataObject, CSG_Parameter *pParameter) |
static bool | DataObject_Set_Parameter (CSG_Data_Object *pDataObject, CSG_Data_Object *pCopy, const CSG_String &ID) |
static bool | DataObject_Set_Parameter (CSG_Data_Object *pDataObject, const CSG_String &ID, int Value) |
static bool | DataObject_Set_Parameter (CSG_Data_Object *pDataObject, const CSG_String &ID, double Value) |
static bool | DataObject_Set_Parameter (CSG_Data_Object *pDataObject, const CSG_String &ID, void *Value) |
static bool | DataObject_Set_Parameter (CSG_Data_Object *pDataObject, const CSG_String &ID, const SG_Char *Value) |
static bool | DataObject_Set_Parameter (CSG_Data_Object *pDataObject, const CSG_String &ID, double loVal, double hiVal) |
Protected Member Functions | |
void | Set_Name (const CSG_String &String) |
void | Set_Author (const CSG_String &String) |
void | Set_Version (const CSG_String &String) |
void | Set_Description (const CSG_String &String) |
void | Add_Reference (const CSG_String &Authors, const CSG_String &Year, const CSG_String &Title, const CSG_String &Where, const SG_Char *Link=NULL, const SG_Char *Link_Text=NULL) |
void | Add_Reference (const CSG_String &Link, const SG_Char *Link_Text=NULL) |
virtual bool | On_Execute (void)=0 |
virtual int | On_Parameter_Changed (CSG_Parameters *pParameters, CSG_Parameter *pParameter) |
virtual int | On_Parameters_Enable (CSG_Parameters *pParameters, CSG_Parameter *pParameter) |
TSG_PFNC_Parameter_Changed | Get_Parameter_Changed (void) |
CSG_Parameters * | Add_Parameters (const CSG_String &Identifier, const CSG_String &Name, const CSG_String &Description) |
bool | Dlg_Parameters (const CSG_String &Identifier) |
bool | Dlg_Parameters (CSG_Parameters *pParameters, const CSG_String &Caption) |
virtual bool | Set_Progress (int Position, int Range) const |
virtual bool | Set_Progress (sLong Position, sLong Range) const |
virtual bool | Set_Progress (double Position, double Range=1.) const |
bool | Stop_Execution (bool bDialog=true) |
void | Message_Dlg (const CSG_String &Text, const SG_Char *Caption=NULL) |
bool | Message_Dlg_Confirm (const CSG_String &Text, const SG_Char *Caption=NULL) |
void | Message_Add (const CSG_String &Text, bool bNewLine=true) |
void | Message_Fmt (const char *Format,...) |
void | Message_Fmt (const wchar_t *Format,...) |
bool | Error_Set (TSG_Tool_Error Error_ID=TOOL_ERROR_Unknown) |
bool | Error_Set (const CSG_String &Text) |
bool | Error_Fmt (const char *Format,...) |
bool | Error_Fmt (const wchar_t *Format,...) |
bool | DataObject_Add (CSG_Data_Object *pDataObject, bool bUpdate=false) |
void | DataObject_Update_All (void) |
bool | DataObject_Set_History (CSG_Parameter *pParameter, CSG_MetaData *pHistory=NULL) |
bool | Get_Projection (CSG_Projection &Projection) const |
Protected Attributes | |
CSG_Parameters | Parameters |
CSG_MetaData | History_Supplement |
Friends | |
class | CSG_Tool_Interactive_Base |
class | CSG_Tool_Library_Interface |
class | CSG_Tool_Chain |
CSG_Tool is the base class for all executable SAGA tools.
CSG_Tool::CSG_Tool | ( | void | ) |
Definition at line 66 of file tool.cpp.
References CSG_Parameters::Create(), Parameters, CSG_Parameters::Set_Callback_On_Parameter_Changed(), Set_Show_Progress(), and SG_T.
|
virtual |
Definition at line 86 of file tool.cpp.
References Destroy(), CSG_Array::Get_Array(), CSG_Array::Get_Size(), CSG_Array::Get_uSize(), and SG_Free().
|
protected |
Definition at line 483 of file tool.cpp.
References CSG_Parameters::Create(), CSG_Parameters::Set_Callback_On_Parameter_Changed(), and SG_Realloc().
|
protected |
Definition at line 184 of file tool.cpp.
References CSG_Parameters::Add_Reference(), and Parameters.
|
protected |
Definition at line 189 of file tool.cpp.
References CSG_Parameters::Add_Reference(), and Parameters.
CSG_Data_Manager * CSG_Tool::Create_Manager | ( | void | ) |
Definition at line 568 of file tool.cpp.
References Get_Manager(), and Set_Manager().
|
protected |
Definition at line 803 of file tool.cpp.
References CSG_Data_Manager::Add(), CSG_Parameters::Get_Manager(), Parameters, SG_Get_Data_Manager(), and SG_UI_DataObject_Add().
|
static |
Definition at line 999 of file tool.cpp.
References SG_UI_DataObject_Colors_Get().
|
static |
Definition at line 1051 of file tool.cpp.
References DataObject_Get_Parameters().
Referenced by DataObject_Set_Parameter().
|
static |
Definition at line 1019 of file tool.cpp.
References Parameters, and SG_UI_DataObject_Params_Get().
Referenced by DataObject_Get_Parameter(), DataObject_Set_Parameter(), DataObject_Set_Parameters(), and DataObject_Update().
|
static |
Definition at line 1004 of file tool.cpp.
References SG_UI_DataObject_Colors_Set().
|
static |
Definition at line 1011 of file tool.cpp.
References SG_UI_DataObject_Colors_Set().
|
protected |
Definition at line 2212 of file tool.cpp.
References CSG_Parameter::asDataObject(), CSG_Parameter::asList(), CSG_MetaData::Assign(), CSG_MetaData::Get_Child(), CSG_Data_Object::Get_History(), CSG_Parameter::Get_Identifier(), CSG_Parameter_List::Get_Item(), CSG_Data_Object::Get_Name(), CSG_Parameter::Get_Name(), CSG_Parameter::Get_Type_Identifier(), CSG_Parameter::is_DataObject(), CSG_Parameter::is_DataObject_List(), CSG_MetaData::Set_Content(), and CSG_MetaData::Set_Property().
|
static |
Definition at line 1108 of file tool.cpp.
References DataObject_Get_Parameters(), and DataObject_Set_Parameter().
|
static |
Definition at line 1120 of file tool.cpp.
References DataObject_Get_Parameters(), DataObject_Set_Parameter(), Get_Type(), and PARAMETER_TYPE_Range.
|
static |
Definition at line 1084 of file tool.cpp.
References DataObject_Get_Parameters(), and DataObject_Set_Parameter().
|
static |
Definition at line 1072 of file tool.cpp.
References DataObject_Get_Parameters(), and DataObject_Set_Parameter().
|
static |
Definition at line 1096 of file tool.cpp.
References DataObject_Get_Parameters(), and DataObject_Set_Parameter().
|
static |
Definition at line 1065 of file tool.cpp.
References DataObject_Get_Parameter(), and DataObject_Set_Parameter().
|
static |
Definition at line 1058 of file tool.cpp.
References DataObject_Set_Parameters().
Referenced by DataObject_Set_Parameter().
|
static |
Definition at line 1029 of file tool.cpp.
References DataObject_Get_Parameters(), DataObject_Set_Parameters(), and CSG_Parameters::Del_Parameter().
|
static |
Definition at line 1024 of file tool.cpp.
References Parameters, and SG_UI_DataObject_Params_Set().
Referenced by DataObject_Set_Parameter(), and DataObject_Set_Parameters().
|
static |
Definition at line 985 of file tool.cpp.
References DataObject_Get_Parameters(), CSG_Parameters::Set_Parameter(), and SG_UI_DataObject_Update().
|
static |
Definition at line 980 of file tool.cpp.
References SG_UI_DataObject_Update().
Referenced by DataObject_Update_All().
|
protected |
Definition at line 819 of file tool.cpp.
References DataObject_Update(), CSG_Parameters::Get_Count(), and Parameters.
bool CSG_Tool::Delete_Manager | ( | bool | bDetachData = false , |
bool | bReset = true |
||
) |
Definition at line 576 of file tool.cpp.
References CSG_Data_Manager::Delete_All(), Get_Manager(), Set_Manager(), and SG_Get_Data_Manager().
|
virtual |
Definition at line 115 of file tool.cpp.
References CSG_MetaData::Destroy(), and History_Supplement.
Referenced by ~CSG_Tool().
|
protected |
Definition at line 512 of file tool.cpp.
References Get_Name(), Get_Parameters(), History_Supplement, CSG_Parameters::is_Managed(), and CSG_Parameters::Set_History().
|
protected |
Definition at line 527 of file tool.cpp.
References SG_UI_Dlg_Parameters().
|
inlinevirtual |
Reimplemented in CSG_Tool_Chain.
|
protected |
Definition at line 746 of file tool.cpp.
References Error_Set().
Referenced by CSG_Tool_Chain::Create().
|
protected |
Definition at line 771 of file tool.cpp.
References Error_Set().
|
protected |
Definition at line 722 of file tool.cpp.
References _TL, CSG_String::Format(), SG_UI_Dlg_Error(), SG_UI_Msg_Add_Error(), SG_UI_Process_Get_Okay(), and SG_UI_Process_Set_Okay().
|
protected |
Definition at line 709 of file tool.cpp.
References _TL, and TOOL_ERROR_Calculation.
Referenced by Error_Fmt().
bool CSG_Tool::Execute | ( | bool | bAddHistory = false | ) |
Definition at line 246 of file tool.cpp.
References _TL, ADD_MESSAGE_EXECUTION, CSG_String::c_str(), CSG_String::Clear(), CSG_MetaData::Destroy(), CSG_String::Format(), CSG_TimeSpan::Format(), CSG_TimeSpan::Get_Hours(), CSG_Parameters::Get_Manager(), CSG_TimeSpan::Get_Milliseconds(), CSG_TimeSpan::Get_Minutes(), Get_Name(), CSG_TimeSpan::Get_Seconds(), History_Supplement, is_Interactive(), Message_Dlg(), CSG_Parameters::Msg_String(), CSG_DateTime::Now(), On_Execute(), Parameters, Process_Get_Okay(), SG_Get_Data_Manager(), SG_UI_Msg_Add(), SG_UI_Msg_Add_Execution(), SG_UI_MSG_STYLE_BOLD, SG_UI_MSG_STYLE_FAILURE, SG_UI_MSG_STYLE_NORMAL, SG_UI_MSG_STYLE_SUCCESS, SG_UI_Process_Set_Okay(), SG_UI_Process_Set_Ready(), and Update_Parameter_States().
Referenced by CSG_Shapes::Create(), CSG_Table::Create(), and SG_Get_Projected().
const CSG_String & CSG_Tool::Get_Author | ( | void | ) | const |
Definition at line 156 of file tool.cpp.
Referenced by Get_Summary().
const CSG_String & CSG_Tool::Get_Description | ( | void | ) | const |
Definition at line 178 of file tool.cpp.
References CSG_Parameters::Get_Description(), Get_Name(), CSG_String::is_Empty(), and Parameters.
Referenced by CSG_Tool_Chain::Create(), and Get_Summary().
|
inline |
const CSG_String & CSG_Tool::Get_File_Name | ( | void | ) | const |
Definition at line 134 of file tool.cpp.
Referenced by Get_Summary().
CSG_Grid_System * CSG_Tool::Get_Grid_System | ( | void | ) | const |
Gets the tools' grid system, if it has one, which is typically the case for all derivatives of CSG_Tool_Grid.
Definition at line 1272 of file tool.cpp.
References CSG_Parameters::Get_Grid_System(), and Parameters.
|
inline |
Definition at line 163 of file tool.h.
Referenced by Get_Summary(), CSG_Tool_Library::Get_Summary(), and CSG_Tool_Library::Get_Tool().
const CSG_String & CSG_Tool::Get_Library | ( | void | ) | const |
Definition at line 128 of file tool.cpp.
Referenced by Get_Summary().
CSG_Data_Manager * CSG_Tool::Get_Manager | ( | void | ) | const |
Definition at line 562 of file tool.cpp.
References CSG_Parameters::Get_Manager(), and Parameters.
Referenced by Create_Manager(), Delete_Manager(), and Settings_Pop().
|
virtual |
Definition at line 200 of file tool.cpp.
References CSG_String::AfterFirst(), Get_MenuPath(), CSG_String::is_Empty(), and CSG_String::Length().
|
inlinevirtual |
Reimplemented in CSG_Tool_Chain.
Definition at line 175 of file tool.h.
References SG_T.
Referenced by Get_MenuPath(), and Get_Summary().
const CSG_String & CSG_Tool::Get_Name | ( | void | ) | const |
Definition at line 145 of file tool.cpp.
References CSG_Parameters::Get_Name(), and Parameters.
Referenced by Dlg_Parameters(), Execute(), CSG_Tool_Interactive_Base::Execute_Finish(), Get_Description(), Get_Summary(), CSG_Tool_Library::Get_Summary(), CSG_Tool_Library::Get_Tool(), Message_Dlg(), and Message_Dlg_Confirm().
|
inline |
Definition at line 184 of file tool.h.
References Parameters.
|
inline |
|
inline |
Definition at line 185 of file tool.h.
References Parameters.
|
inlineprotected |
CSG_Parameters * CSG_Tool::Get_Parameters | ( | const CSG_String & | Identifier | ) |
|
inline |
|
inline |
Definition at line 179 of file tool.h.
References Parameters.
Referenced by Dlg_Parameters(), and Update_Parameter_States().
|
inline |
Definition at line 178 of file tool.h.
Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), and Update_Parameter_States().
|
protected |
Definition at line 418 of file tool.cpp.
References CSG_Projection::Destroy(), CSG_Projection::is_Okay(), and Parameters.
const CSG_Strings & CSG_Tool::Get_References | ( | void | ) | const |
Definition at line 194 of file tool.cpp.
References CSG_Parameters::Get_References(), and Parameters.
Referenced by Get_Summary().
CSG_String CSG_Tool::Get_Script | ( | TSG_Tool_Script_Type | Type, |
bool | bHeader, | ||
bool | bAllParameters = false |
||
) |
Definition at line 1326 of file tool.cpp.
References CSG_Tool_Chain::Get_Script(), TOOL_SCRIPT_CHAIN, TOOL_SCRIPT_CMD_BATCH, TOOL_SCRIPT_CMD_SHELL, TOOL_SCRIPT_PYTHON, TOOL_SCRIPT_PYTHON_WRAP_ID, TOOL_SCRIPT_PYTHON_WRAP_ID_CALL, TOOL_SCRIPT_PYTHON_WRAP_NAME, and TOOL_SCRIPT_PYTHON_WRAP_NAME_CALL.
Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox().
CSG_String CSG_Tool::Get_Summary | ( | bool | bParameters = true , |
const CSG_String & | Menu = "" , |
||
const CSG_String & | Description = "" , |
||
int | Format = SG_SUMMARY_FMT_HTML |
||
) |
Definition at line 258 of file tool_summary.cpp.
References _TL, CSG_MetaData::Add_Child(), CSG_MetaData::Add_Property(), CSG_MetaData::asText(), CSG_String::c_str(), CSG_String::Format(), Get_Author(), CSG_Strings::Get_Count(), CSG_Parameters::Get_Count(), CSG_Parameter::Get_Description(), Get_Description(), Get_File_Name(), Get_ID(), CSG_Parameter::Get_Identifier(), Get_Library(), Get_MenuPath(), CSG_Parameter::Get_Name(), Get_Name(), Get_References(), Get_Type(), CSG_Parameter::Get_Type(), Get_Version(), CSG_String::is_Empty(), is_Grid(), CSG_Parameter::is_Input(), is_Interactive(), CSG_Parameter::is_Option(), CSG_Parameter::is_Output(), CSG_String::Length(), PARAMETER_DESCRIPTION_PROPERTIES, PARAMETER_DESCRIPTION_TYPE, PARAMETER_TYPE_Grid_System, PARAMETER_TYPE_Node, Parameters, CSG_String::Replace(), CSG_MetaData::Set_Name(), SG_SUMMARY_FMT_FLAT, SG_SUMMARY_FMT_HTML, SG_SUMMARY_FMT_XML, SG_XML_Add_Parameter(), SG_XML_DESCRIPTION, SG_XML_MENU, SG_XML_SPEC_ATT_GRID, SG_XML_SPEC_ATT_INTERA, SG_XML_TOOL, SG_XML_TOOL_ATT_AUTHOR, SG_XML_TOOL_ATT_ID, SG_XML_TOOL_ATT_NAME, SG_XML_TOOL_ATT_VERSION, SUMMARY_ADD_STR, and TOOL_TYPE_Chain.
Referenced by CSG_Tool_Library::Get_Summary().
|
inlinevirtual |
Reimplemented in CSG_Tool_Chain, CSG_Tool_Grid_Interactive, CSG_Tool_Interactive, and CSG_Tool_Grid.
Definition at line 161 of file tool.h.
References TOOL_TYPE_Base.
Referenced by DataObject_Set_Parameter(), Get_Summary(), and CSG_Tool_Library::Get_Tool().
const CSG_String & CSG_Tool::Get_Version | ( | void | ) | const |
Definition at line 167 of file tool.cpp.
Referenced by Get_Summary().
bool CSG_Tool::has_GUI | ( | void | ) | const |
Definition at line 233 of file tool.cpp.
References SG_UI_Get_Window_Main().
Referenced by CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Tool_Chain::Create(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Set_User_Defined(), and CSG_Parameters_Grid_Target::Set_User_Defined_ZLevels().
|
inlinevirtual |
|
inlinevirtual |
Reimplemented in CSG_Tool_Grid_Interactive, and CSG_Tool_Interactive.
Definition at line 233 of file tool.h.
Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), Execute(), and Get_Summary().
|
inline |
Definition at line 234 of file tool.h.
References SG_UI_Process_Get_Okay().
Referenced by CSG_Tool_Grid::Set_Progress_Cells().
|
protected |
Definition at line 910 of file tool.cpp.
References SG_UI_Msg_Add_Execution().
Referenced by Message_Fmt().
|
protected |
Definition at line 697 of file tool.cpp.
References Get_Name(), and SG_UI_Dlg_Message().
Referenced by Execute().
|
protected |
Definition at line 703 of file tool.cpp.
References Get_Name(), and SG_UI_Dlg_Continue().
|
protected |
Definition at line 923 of file tool.cpp.
References Message_Add().
|
protected |
Definition at line 948 of file tool.cpp.
References Message_Add().
|
inlinevirtual |
Reimplemented in CSG_Tool_Grid_Interactive, and CSG_Tool_Interactive.
Definition at line 229 of file tool.h.
Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), and CSG_Tool_Library::Get_Summary().
|
inlinevirtual |
|
inlinevirtual |
Definition at line 239 of file tool.h.
Referenced by CSG_Shapes::Create(), and CSG_Table::Create().
|
protectedpure virtual |
Implemented in CSG_Tool_Chain.
Referenced by Execute().
|
protectedvirtual |
|
protectedvirtual |
Reimplemented in CSG_Tool_Chain.
|
static |
Definition at line 848 of file tool.cpp.
References SG_UI_Process_Get_Okay().
Referenced by Execute(), and Set_Progress().
|
static |
Definition at line 860 of file tool.cpp.
References SG_UI_Process_Set_Text().
|
static |
Definition at line 854 of file tool.cpp.
References SG_UI_Process_Set_Text().
|
static |
Definition at line 885 of file tool.cpp.
References SG_UI_Process_Set_Text().
bool CSG_Tool::Reset | ( | bool | bManager = true | ) |
Resets the tools' parameters list. All input and output data objects and object lists are cleared and parameter defaults are restored.
Definition at line 1215 of file tool.cpp.
References Parameters, Reset_Grid_System(), Reset_Manager(), and CSG_Parameters::Restore_Defaults().
bool CSG_Tool::Reset_Grid_System | ( | void | ) |
Resets the tools' grid system, if it has one, which is typically the case for all derivatives of CSG_Tool_Grid.
Definition at line 1247 of file tool.cpp.
References Parameters, and CSG_Parameters::Reset_Grid_System().
Referenced by Reset().
bool CSG_Tool::Reset_Manager | ( | void | ) |
Resets the tools' data manager so it will be the SAGA API's default manager as can be requested by SG_Get_Data_Manager().
Definition at line 1237 of file tool.cpp.
References Set_Manager(), and SG_Get_Data_Manager().
Referenced by Reset().
|
protected |
Definition at line 151 of file tool.cpp.
Referenced by CSG_Tool_Chain::Create().
void CSG_Tool::Set_Callback | ( | bool | bActive = true | ) |
Definition at line 538 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Callback().
|
protected |
Definition at line 173 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Description().
Referenced by CSG_Tool_Chain::Create().
bool CSG_Tool::Set_Grid_System | ( | const CSG_Grid_System & | System | ) |
Sets the tools' grid system, if it has one, which is typically the case for all derivatives of CSG_Tool_Grid.
Definition at line 1262 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Grid_System().
bool CSG_Tool::Set_Manager | ( | class CSG_Data_Manager * | pManager | ) |
Definition at line 549 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Manager().
Referenced by CSG_Shapes::Create(), CSG_Table::Create(), Create_Manager(), Delete_Manager(), Reset_Manager(), and SG_Get_Projected().
|
protected |
Definition at line 140 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Name().
Referenced by CSG_Tool_Chain::Create().
bool CSG_Tool::Set_Parameter | ( | const char * | ID, |
const char * | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1190 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const char * | ID, |
const CSG_String & | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1181 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const char * | ID, |
const wchar_t * | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1199 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const char * | ID, |
CSG_Parameter * | pValue | ||
) |
Definition at line 1145 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const char * | ID, |
double | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1163 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const char * | ID, |
int | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1154 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const char * | ID, |
void * | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1172 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const CSG_String & | ID, |
const char * | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Direct 'set a value' access to this tool's default parameters list.
Definition at line 1189 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const CSG_String & | ID, |
const CSG_String & | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Direct 'set a value' access to this tool's default parameters list.
Definition at line 1180 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const CSG_String & | ID, |
const wchar_t * | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Direct 'set a value' access to this tool's default parameters list.
Definition at line 1198 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const CSG_String & | ID, |
CSG_Parameter * | pValue | ||
) |
Direct 'set a value' access to this tool's default parameters list.
Definition at line 1144 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
Referenced by SG_Get_Projected().
bool CSG_Tool::Set_Parameter | ( | const CSG_String & | ID, |
double | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Direct 'set a value' access to this tool's default parameters list.
Definition at line 1162 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const CSG_String & | ID, |
int | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Direct 'set a value' access to this tool's default parameters list.
Definition at line 1153 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const CSG_String & | ID, |
void * | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Direct 'set a value' access to this tool's default parameters list.
Definition at line 1171 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const wchar_t * | ID, |
const char * | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1191 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const wchar_t * | ID, |
const CSG_String & | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1182 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const wchar_t * | ID, |
const wchar_t * | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1200 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const wchar_t * | ID, |
CSG_Parameter * | pValue | ||
) |
Definition at line 1146 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const wchar_t * | ID, |
double | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1164 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const wchar_t * | ID, |
int | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1155 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
bool CSG_Tool::Set_Parameter | ( | const wchar_t * | ID, |
void * | Value, | ||
int | Type = PARAMETER_TYPE_Undefined |
||
) |
Definition at line 1173 of file tool.cpp.
References Parameters, and CSG_Parameters::Set_Parameter().
|
protectedvirtual |
Definition at line 676 of file tool.cpp.
References Process_Get_Okay(), and SG_UI_Process_Set_Progress().
|
protectedvirtual |
Definition at line 664 of file tool.cpp.
Referenced by Set_Progress(), CSG_Tool_Grid::Set_Progress_Cells(), and CSG_Tool_Grid::Set_Progress_Rows().
Definition at line 670 of file tool.cpp.
References Set_Progress().
void CSG_Tool::Set_Show_Progress | ( | bool | bOn = true | ) |
Definition at line 658 of file tool.cpp.
Referenced by CSG_Tool().
|
protected |
bool CSG_Tool::Settings_Pop | ( | void | ) |
Definition at line 627 of file tool.cpp.
References CSG_Parameters::Assign_Values(), CSG_Array::Get_Array(), Get_Manager(), CSG_Array::Get_Size(), Parameters, CSG_Array::Set_Array(), and CSG_Parameters::Set_Manager().
bool CSG_Tool::Settings_Push | ( | class CSG_Data_Manager * | pManager = NULL | ) |
Definition at line 600 of file tool.cpp.
References CSG_Array::Create(), CSG_Array::Get_Array(), CSG_Array::Get_Size(), CSG_Array::Get_Value_Size(), Parameters, CSG_Parameters::Restore_Defaults(), and CSG_Parameters::Set_Manager().
|
protected |
Definition at line 682 of file tool.cpp.
References SG_UI_Stop_Execution().
bool CSG_Tool::Update_Parameter_States | ( | void | ) |
Definition at line 1285 of file tool.cpp.
References Get_Parameters(), Get_Parameters_Count(), and Parameters.
Referenced by Execute().
|
friend |
|
friend |
|
friend |
|
protected |
Definition at line 253 of file tool.h.
Referenced by Destroy(), Dlg_Parameters(), and Execute().
|
protected |
Definition at line 251 of file tool.h.
Referenced by Add_Reference(), CSG_Tool_Chain::Create(), CSG_Tool(), CSG_Tool_Grid::CSG_Tool_Grid(), DataObject_Add(), DataObject_Get_Parameters(), DataObject_Set_Parameters(), DataObject_Update_All(), Execute(), Get_Description(), Get_Grid_System(), Get_Manager(), Get_Name(), Get_Parameter(), Get_Parameters(), Get_Projection(), Get_References(), Get_Summary(), Reset(), Reset_Grid_System(), Set_Callback(), Set_Description(), Set_Grid_System(), Set_Manager(), Set_Name(), Set_Parameter(), CSG_Tool_Grid::Set_System(), Settings_Pop(), Settings_Push(), and Update_Parameter_States().