SAGA API  v9.8
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
CSG_Tool_Chain Class Reference

#include <tool_chain.h>

Inheritance diagram for CSG_Tool_Chain:
CSG_Tool

Public Member Functions

 CSG_Tool_Chain (void)
 
virtual ~CSG_Tool_Chain (void)
 
 CSG_Tool_Chain (const CSG_Tool_Chain &Tool, bool bWithGUI, bool bWithCMD)
 
bool Create (const CSG_Tool_Chain &Tool, bool bWithGUI, bool bWithCMD)
 
 CSG_Tool_Chain (const CSG_String &File)
 
bool Create (const CSG_String &File)
 
 CSG_Tool_Chain (const CSG_MetaData &Chain)
 
bool Create (const CSG_MetaData &Chain)
 
virtual TSG_Tool_Type Get_Type (void) const
 
virtual bool do_Sync_Projections (void) const
 
bool is_Okay (void) const
 
void Set_Library_Menu (const CSG_String &Menu)
 
virtual CSG_String Get_MenuPath (void)
 
const CSG_String & Get_Library_Name (void) const
 
- Public Member Functions inherited from CSG_Tool
 CSG_Tool (void)
 
virtual ~CSG_Tool (void)
 
virtual void Destroy (void)
 
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 (bool bSolved)
 
CSG_Parameters * Get_Parameters (void)
 
int Get_Parameters_Count (void) const
 
CSG_Parameters * Get_Parameters (int i) const
 
CSG_Parameters * Get_Parameters (int i)
 
CSG_Parameters * Get_Parameters (const CSG_String &Identifier) const
 
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 needs_GUI (void) const
 
bool has_GUI (void) const
 
bool has_CMD (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 (Script_Format Format, bool bHeader=true, int Arguments=0, bool bWrapArgs=true)
 

Static Public Member Functions

static CSG_String Get_Script (CSG_Tool *pTool, bool bHeader, bool bAllParameters=true)
 
static bool Save_History_to_Model (const CSG_MetaData &History, const CSG_String &File)
 
- Static Public Member Functions inherited from CSG_Tool
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)
 
static int _On_Parameter_Changed (CSG_Parameter *pParameter, int Flags)
 

Protected Member Functions

virtual int On_Parameters_Enable (CSG_Parameters *pParameters, CSG_Parameter *pParameter)
 
virtual bool On_Execute (void)
 
- Protected Member Functions inherited from CSG_Tool
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 int On_Parameter_Changed (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="")
 
bool Dlg_Parameters (CSG_Parameters &Parameters, 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
 

Additional Inherited Members

- Public Types inherited from CSG_Tool
enum  Script_Format {
  Script_Format::CMD_Shell, Script_Format::CMD_Batch, Script_Format::CMD_Usage, Script_Format::Toolchain,
  Script_Format::Python, Script_Format::Python_Wrapper_Func_Name, Script_Format::Python_Wrapper_Func_ID, Script_Format::Python_Wrapper_Call_Name,
  Script_Format::Python_Wrapper_Call_ID
}
 
- Protected Attributes inherited from CSG_Tool
CSG_Parameters Parameters
 
CSG_MetaData History_Supplement
 

Detailed Description

CSG_Tool_Chain, the SAGA Model class.

Definition at line 77 of file tool_chain.h.

Constructor & Destructor Documentation

◆ CSG_Tool_Chain() [1/4]

CSG_Tool_Chain::CSG_Tool_Chain ( void  )

Definition at line 79 of file tool_chain.cpp.

◆ ~CSG_Tool_Chain()

CSG_Tool_Chain::~CSG_Tool_Chain ( void  )
virtual

Definition at line 103 of file tool_chain.cpp.

◆ CSG_Tool_Chain() [2/4]

CSG_Tool_Chain::CSG_Tool_Chain ( const CSG_Tool_Chain &  Tool,
bool  bWithGUI,
bool  bWithCMD 
)

Definition at line 85 of file tool_chain.cpp.

References Create().

◆ CSG_Tool_Chain() [3/4]

CSG_Tool_Chain::CSG_Tool_Chain ( const CSG_String &  File)

Definition at line 91 of file tool_chain.cpp.

References Create().

◆ CSG_Tool_Chain() [4/4]

CSG_Tool_Chain::CSG_Tool_Chain ( const CSG_MetaData &  Chain)

Definition at line 97 of file tool_chain.cpp.

References Create().

Member Function Documentation

◆ Create() [1/3]

bool CSG_Tool_Chain::Create ( const CSG_MetaData &  Chain)

Definition at line 204 of file tool_chain.cpp.

References _TL, CSG_Parameters::Add_Bool(), CSG_MetaData::Add_Child(), CSG_Parameters::Add_Choice(), CSG_Parameters::Add_Choices(), CSG_Parameters::Add_Color(), CSG_Parameters::Add_Colors(), CSG_Parameters::Add_Date(), CSG_Parameters::Add_Degree(), CSG_Parameters::Add_Double(), CSG_Parameters::Add_FilePath(), CSG_Parameters::Add_FixedTable(), CSG_Parameters::Add_Grid(), CSG_Parameters::Add_Grid_List(), CSG_Parameters::Add_Grid_Output(), CSG_Parameters::Add_Grid_System(), CSG_Parameters::Add_Grids(), CSG_Parameters::Add_Grids_List(), CSG_Parameters::Add_Grids_Output(), CSG_Parameters::Add_Int(), CSG_Parameters::Add_Node(), CSG_Parameters::Add_PointCloud(), CSG_Parameters::Add_PointCloud_List(), CSG_Parameters::Add_Range(), CSG_Parameters::Add_Shapes(), CSG_Parameters::Add_Shapes_List(), CSG_Parameters::Add_String(), CSG_Parameters::Add_Table(), CSG_Parameters::Add_Table_Field(), CSG_Parameters::Add_Table_Fields(), CSG_Parameters::Add_Table_List(), CSG_Parameters::Add_TIN(), CSG_Parameters::Add_TIN_List(), CSG_String::AfterFirst(), CSG_String::asDouble(), CSG_String::asInt(), CSG_String::BeforeFirst(), CSG_MetaData::Cmp_Name(), CSG_MetaData::Cmp_Property(), CSG_String::CmpNoCase(), CSG_Tool::Error_Fmt(), CSG_MetaData::Get_Children_Count(), CSG_MetaData::Get_Content(), CSG_Tool::Get_Description(), CSG_Parameter::Get_Identifier(), CSG_MetaData::Get_Property(), GET_XML_CONTENT, CSG_Tool::has_GUI(), CSG_String::is_Empty(), is_Okay(), IS_TRUE_PROPERTY, IS_TRUE_STRING, CSG_String::Length(), PARAMETER_INPUT, PARAMETER_INPUT_OPTIONAL, PARAMETER_OUTPUT, PARAMETER_OUTPUT_OPTIONAL, PARAMETER_TYPE_Bool, PARAMETER_TYPE_Choice, PARAMETER_TYPE_Choices, PARAMETER_TYPE_Color, PARAMETER_TYPE_Colors, PARAMETER_TYPE_Data_Type, PARAMETER_TYPE_DataObject_Output, PARAMETER_TYPE_Date, PARAMETER_TYPE_Degree, PARAMETER_TYPE_Double, PARAMETER_TYPE_FilePath, PARAMETER_TYPE_FixedTable, PARAMETER_TYPE_Font, PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grid_List, PARAMETER_TYPE_Grid_System, PARAMETER_TYPE_Grids, PARAMETER_TYPE_Grids_List, PARAMETER_TYPE_Int, PARAMETER_TYPE_Node, PARAMETER_TYPE_Parameters, PARAMETER_TYPE_PointCloud, PARAMETER_TYPE_PointCloud_List, PARAMETER_TYPE_Range, PARAMETER_TYPE_Shapes, PARAMETER_TYPE_Shapes_List, PARAMETER_TYPE_String, PARAMETER_TYPE_Table, PARAMETER_TYPE_Table_Field, PARAMETER_TYPE_Table_Fields, PARAMETER_TYPE_Table_List, PARAMETER_TYPE_Text, PARAMETER_TYPE_TIN, PARAMETER_TYPE_TIN_List, CSG_Tool::Parameters, CSG_String::Prepend(), CSG_String::Replace(), CSG_Parameter::Serialize(), CSG_Tool::Set_Author(), CSG_Tool::Set_Description(), CSG_Tool::Set_Name(), CSG_Parameter::Set_Value(), SG_Compare_Version(), SG_Parameter_Type_Get_Type(), SG_T, SG_Translate(), SHAPE_TYPE_Line, SHAPE_TYPE_Point, SHAPE_TYPE_Points, SHAPE_TYPE_Polygon, and SHAPE_TYPE_Undefined.

◆ Create() [2/3]

bool CSG_Tool_Chain::Create ( const CSG_String &  File)

Definition at line 151 of file tool_chain.cpp.

References _TL, CSG_String::c_str(), CSG_String::Cmp(), CSG_MetaData::Cmp_Name(), Create(), CSG_Tool::Error_Fmt(), CSG_String::Find(), CSG_String::Format(), CSG_MetaData::Load(), CSG_String::Make_Lower(), CSG_String::Right(), SG_File_Cmp_Extension(), SG_UI_Msg_Add(), SG_UI_MSG_STYLE_FAILURE, and SG_UI_MSG_STYLE_SUCCESS.

◆ Create() [3/3]

bool CSG_Tool_Chain::Create ( const CSG_Tool_Chain &  Tool,
bool  bWithGUI,
bool  bWithCMD 
)

Definition at line 133 of file tool_chain.cpp.

Referenced by Create(), and CSG_Tool_Chain().

◆ do_Sync_Projections()

virtual bool CSG_Tool_Chain::do_Sync_Projections ( void  ) const
virtual

Reimplemented from CSG_Tool.

◆ Get_Library_Name()

const CSG_String& CSG_Tool_Chain::Get_Library_Name ( void  ) const
inline

Definition at line 100 of file tool_chain.h.

◆ Get_MenuPath()

virtual CSG_String CSG_Tool_Chain::Get_MenuPath ( void  )
inlinevirtual

Reimplemented from CSG_Tool.

Definition at line 99 of file tool_chain.h.

◆ Get_Script()

static CSG_String CSG_Tool_Chain::Get_Script ( CSG_Tool *  pTool,
bool  bHeader,
bool  bAllParameters = true 
)
static

Referenced by CSG_Tool::Get_Script().

◆ Get_Type()

virtual TSG_Tool_Type CSG_Tool_Chain::Get_Type ( void  ) const
inlinevirtual

Reimplemented from CSG_Tool.

Definition at line 92 of file tool_chain.h.

References TOOL_TYPE_Chain.

◆ is_Okay()

bool CSG_Tool_Chain::is_Okay ( void  ) const
inline

Definition at line 96 of file tool_chain.h.

Referenced by Create().

◆ On_Execute()

virtual bool CSG_Tool_Chain::On_Execute ( void  )
protectedvirtual

Implements CSG_Tool.

◆ On_Parameters_Enable()

virtual int CSG_Tool_Chain::On_Parameters_Enable ( CSG_Parameters *  pParameters,
CSG_Parameter *  pParameter 
)
protectedvirtual

Reimplemented from CSG_Tool.

◆ Save_History_to_Model()

static bool CSG_Tool_Chain::Save_History_to_Model ( const CSG_MetaData &  History,
const CSG_String &  File 
)
static

Referenced by CSG_Data_Object::Save_History_to_Model().

◆ Set_Library_Menu()

void CSG_Tool_Chain::Set_Library_Menu ( const CSG_String &  Menu)

Definition at line 122 of file tool_chain.cpp.

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