SAGA API v9.10
Loading...
Searching...
No Matches
tool_summary.cpp File Reference
#include "saga_api.h"

Go to the source code of this file.

Macros

#define SG_XML_SYSTEM   SG_T("system")
#define SG_XML_SYSTEM_VER   SG_T("version")
#define SG_XML_SYSTEM_MLP   SG_T("library-path")
#define SG_XML_LIBRARY   SG_T("library")
#define SG_XML_LIBRARY_PATH   SG_T("path")
#define SG_XML_LIBRARY_NAME   SG_T("name")
#define SG_XML_LIBRARY_CATEGORY   SG_T("category")
#define SG_XML_TOOL   SG_T("module")
#define SG_XML_TOOL_ATT_NAME   SG_T("name")
#define SG_XML_TOOL_ATT_ID   SG_T("id")
#define SG_XML_TOOL_ATT_VERSION   SG_T("version")
#define SG_XML_TOOL_ATT_AUTHOR   SG_T("author")
#define SG_XML_SPECIFICATION   SG_T("specification")
#define SG_XML_SPEC_ATT_GRID   SG_T("grid")
#define SG_XML_SPEC_ATT_INTERA   SG_T("interactive")
#define SG_XML_MENU   SG_T("menu")
#define SG_XML_DESCRIPTION   SG_T("description")
#define SG_XML_PARAM   SG_T("parameter")
#define SG_XML_PARAM_ATT_NAME   SG_T("name")
#define SG_XML_PARAM_ATT_CLASS   SG_T("class")
#define SG_XML_PARAM_MANDATORY   SG_T("mandatory")
#define SG_XML_PARAM_WITH_GUI   SG_T("with_gui")
#define SG_XML_PARAM_WITH_CMD   SG_T("with_cmd")
#define SG_XML_PARAM_TYPE   SG_T("type")
#define SG_XML_PARAM_IDENTIFIER   SG_T("identifier")
#define SG_XML_PARAM_PARENT   SG_T("parent")
#define SG_XML_PARAM_LIST   SG_T("list")
#define SG_XML_PARAM_ITEM   SG_T("item")
#define SG_XML_PARAM_TABLE   SG_T("table")
#define SG_XML_PARAM_FIELD   SG_T("field")
#define SG_XML_PARAM_FIELD_ATT_NAME   SG_T("name")
#define SG_XML_PARAM_FIELD_ATT_TYPE   SG_T("type")
#define SG_XML_PARAM_MIN   SG_T("min")
#define SG_XML_PARAM_MAX   SG_T("max")
#define SG_XML_PARAM_DEFAULT   SG_T("default")
#define SG_GET_XML_TAGGED_STR(value, tag)
#define SG_GET_XML_TAGGED_INT(value, tag)
#define SG_GET_XML_TAGGED_FLT(value, tag)
#define SUMMARY_ADD_STR(label, value)
#define SUMMARY_ADD_INT(label, value)
#define SUMMARY_ADD_STR(label, value)
#define SUMMARY_ADD_INT(label, value)
#define SUMMARY_ADD_STR(label, value)
#define SUMMARY_ADD_INT(label, value)
#define SUMMARY_ADD_INT(label, value)

Functions

void SG_XML_Add_Parameter (CSG_MetaData *pParent, CSG_Parameter *pParameter, CSG_String ID="")

Macro Definition Documentation

◆ SG_GET_XML_TAGGED_FLT

#define SG_GET_XML_TAGGED_FLT ( value,
tag )
Value:
CSG_String::Format("<%s>%f</%s>", tag, value, tag)
CSG_String::Format
static CSG_String Format(const char *Format,...)
Definition api_string.cpp:270

Definition at line 100 of file tool_summary.cpp.

◆ SG_GET_XML_TAGGED_INT

#define SG_GET_XML_TAGGED_INT ( value,
tag )
Value:
CSG_String::Format("<%s>%d</%s>", tag, value, tag)

Definition at line 99 of file tool_summary.cpp.

◆ SG_GET_XML_TAGGED_STR

#define SG_GET_XML_TAGGED_STR ( value,
tag )
Value:
CSG_String::Format("<%s>%s</%s>", tag, value, tag)

Definition at line 98 of file tool_summary.cpp.

◆ SG_XML_DESCRIPTION

#define SG_XML_DESCRIPTION   SG_T("description")

Definition at line 77 of file tool_summary.cpp.

Referenced by CSG_Tool::Get_Summary(), and SG_XML_Add_Parameter().

◆ SG_XML_LIBRARY

#define SG_XML_LIBRARY   SG_T("library")

Definition at line 64 of file tool_summary.cpp.

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

◆ SG_XML_LIBRARY_CATEGORY

#define SG_XML_LIBRARY_CATEGORY   SG_T("category")

Definition at line 67 of file tool_summary.cpp.

Referenced by CSG_Tool_Library::Get_Summary().

◆ SG_XML_LIBRARY_NAME

#define SG_XML_LIBRARY_NAME   SG_T("name")

Definition at line 66 of file tool_summary.cpp.

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

◆ SG_XML_LIBRARY_PATH

#define SG_XML_LIBRARY_PATH   SG_T("path")

Definition at line 65 of file tool_summary.cpp.

Referenced by CSG_Tool_Library::Get_Summary().

◆ SG_XML_MENU

#define SG_XML_MENU   SG_T("menu")

Definition at line 76 of file tool_summary.cpp.

Referenced by CSG_Tool::Get_Summary().

◆ SG_XML_PARAM

#define SG_XML_PARAM   SG_T("parameter")

Definition at line 78 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_ATT_CLASS

#define SG_XML_PARAM_ATT_CLASS   SG_T("class")

Definition at line 80 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_ATT_NAME

#define SG_XML_PARAM_ATT_NAME   SG_T("name")

Definition at line 79 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_DEFAULT

#define SG_XML_PARAM_DEFAULT   SG_T("default")

Definition at line 95 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_FIELD

#define SG_XML_PARAM_FIELD   SG_T("field")

Definition at line 90 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_FIELD_ATT_NAME

#define SG_XML_PARAM_FIELD_ATT_NAME   SG_T("name")

Definition at line 91 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_FIELD_ATT_TYPE

#define SG_XML_PARAM_FIELD_ATT_TYPE   SG_T("type")

Definition at line 92 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_IDENTIFIER

#define SG_XML_PARAM_IDENTIFIER   SG_T("identifier")

Definition at line 85 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_ITEM

#define SG_XML_PARAM_ITEM   SG_T("item")

Definition at line 88 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_LIST

#define SG_XML_PARAM_LIST   SG_T("list")

Definition at line 87 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_MANDATORY

#define SG_XML_PARAM_MANDATORY   SG_T("mandatory")

Definition at line 81 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_MAX

#define SG_XML_PARAM_MAX   SG_T("max")

Definition at line 94 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_MIN

#define SG_XML_PARAM_MIN   SG_T("min")

Definition at line 93 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_PARENT

#define SG_XML_PARAM_PARENT   SG_T("parent")

Definition at line 86 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_TABLE

#define SG_XML_PARAM_TABLE   SG_T("table")

Definition at line 89 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_TYPE

#define SG_XML_PARAM_TYPE   SG_T("type")

Definition at line 84 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_WITH_CMD

#define SG_XML_PARAM_WITH_CMD   SG_T("with_cmd")

Definition at line 83 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_PARAM_WITH_GUI

#define SG_XML_PARAM_WITH_GUI   SG_T("with_gui")

Definition at line 82 of file tool_summary.cpp.

Referenced by SG_XML_Add_Parameter().

◆ SG_XML_SPEC_ATT_GRID

#define SG_XML_SPEC_ATT_GRID   SG_T("grid")

Definition at line 74 of file tool_summary.cpp.

Referenced by CSG_Tool::Get_Summary().

◆ SG_XML_SPEC_ATT_INTERA

#define SG_XML_SPEC_ATT_INTERA   SG_T("interactive")

Definition at line 75 of file tool_summary.cpp.

Referenced by CSG_Tool::Get_Summary().

◆ SG_XML_SPECIFICATION

#define SG_XML_SPECIFICATION   SG_T("specification")

Definition at line 73 of file tool_summary.cpp.

◆ SG_XML_SYSTEM

#define SG_XML_SYSTEM   SG_T("system")

Definition at line 61 of file tool_summary.cpp.

Referenced by CSG_Tool_Library_Manager::Get_Summary().

◆ SG_XML_SYSTEM_MLP

#define SG_XML_SYSTEM_MLP   SG_T("library-path")

Definition at line 63 of file tool_summary.cpp.

◆ SG_XML_SYSTEM_VER

#define SG_XML_SYSTEM_VER   SG_T("version")

Definition at line 62 of file tool_summary.cpp.

Referenced by CSG_Tool_Library_Manager::Get_Summary().

◆ SG_XML_TOOL

#define SG_XML_TOOL   SG_T("module")

Definition at line 68 of file tool_summary.cpp.

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

◆ SG_XML_TOOL_ATT_AUTHOR

#define SG_XML_TOOL_ATT_AUTHOR   SG_T("author")

Definition at line 72 of file tool_summary.cpp.

Referenced by CSG_Tool::Get_Summary().

◆ SG_XML_TOOL_ATT_ID

#define SG_XML_TOOL_ATT_ID   SG_T("id")

Definition at line 70 of file tool_summary.cpp.

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

◆ SG_XML_TOOL_ATT_NAME

#define SG_XML_TOOL_ATT_NAME   SG_T("name")

Definition at line 69 of file tool_summary.cpp.

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

◆ SG_XML_TOOL_ATT_VERSION

#define SG_XML_TOOL_ATT_VERSION   SG_T("version")

Definition at line 71 of file tool_summary.cpp.

Referenced by CSG_Tool::Get_Summary().

◆ SUMMARY_ADD_INT [1/4]

#define SUMMARY_ADD_INT ( label,
value )
Value:
CSG_String::Format("<tr><td valign=\"top\"><b>%s</b></td><td valign=\"top\">%d</td></tr>", label, value)

Referenced by CSG_Tool_Library_Manager::Get_Summary().

◆ SUMMARY_ADD_INT [2/4]

#define SUMMARY_ADD_INT ( label,
value )
Value:
CSG_String::Format("%s:\t%d\n", label, value)

◆ SUMMARY_ADD_INT [3/4]

#define SUMMARY_ADD_INT ( label,
value )
Value:
CSG_String::Format("<tr><td valign=\"top\"><b>%s</b></td><td valign=\"top\">%d</td></tr>", label, value)

◆ SUMMARY_ADD_INT [4/4]

#define SUMMARY_ADD_INT ( label,
value )
Value:
CSG_String::Format("<tr><td valign=\"top\"><b>%s</b></td><td valign=\"top\">%d</td></tr>", label, value)

◆ SUMMARY_ADD_STR [1/3]

#define SUMMARY_ADD_STR ( label,
value )
Value:
CSG_String::Format("<tr><td valign=\"top\"><b>%s</b></td><td valign=\"top\">%s</td></tr>", label, value)

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

◆ SUMMARY_ADD_STR [2/3]

#define SUMMARY_ADD_STR ( label,
value )
Value:
CSG_String::Format("%s:\t%s\n", label, value)

◆ SUMMARY_ADD_STR [3/3]

#define SUMMARY_ADD_STR ( label,
value )
Value:
CSG_String::Format("<tr><td valign=\"top\"><b>%s</b></td><td valign=\"top\">%s</td></tr>", label, value)

Function Documentation

◆ SG_XML_Add_Parameter()

void SG_XML_Add_Parameter ( CSG_MetaData * pParent,
CSG_Parameter * pParameter,
CSG_String ID = "" )

Definition at line 110 of file tool_summary.cpp.

References CSG_MetaData::Add_Child(), CSG_MetaData::Add_Property(), CSG_Parameter::asBool(), CSG_Parameter::asChoice(), CSG_Parameter::asChoices(), CSG_Parameter::asParameters(), CSG_Parameter::asTable(), CSG_Parameter::asValue(), CSG_String::c_str(), CSG_Parameter::do_UseInCMD(), CSG_Parameter::do_UseInGUI(), CSG_String::Format(), CSG_Parameter::Get_DataObject_Type(), CSG_Parameter::Get_Default(), CSG_Parameter::Get_Description(), CSG_Table::Get_Field_Name(), CSG_Table::Get_Field_Type(), CSG_Parameter::Get_Identifier(), CSG_Parameter_Choice::Get_Item(), CSG_Parameter_Choices::Get_Item(), CSG_Parameter_Value::Get_Maximum(), CSG_Parameter_Value::Get_Minimum(), CSG_Parameter::Get_Name(), CSG_Parameters::Get_Parameter(), CSG_Parameter::Get_Parent(), CSG_Parameter::Get_Type(), CSG_Parameter::Get_Type_Name(), CSG_Parameter_Value::has_Maximum(), CSG_Parameter_Value::has_Minimum(), CSG_String::is_Empty(), CSG_Parameter::is_Input(), CSG_Parameter::is_Option(), CSG_Parameter::is_Optional(), CSG_Parameter::is_Output(), CSG_String::Make_Lower(), 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_System, PARAMETER_TYPE_Int, PARAMETER_TYPE_Parameters, PARAMETER_TYPE_Range, PARAMETER_TYPE_String, PARAMETER_TYPE_Table_Field, PARAMETER_TYPE_Table_Fields, PARAMETER_TYPE_Text, SG_Data_Type_Get_Name(), SG_Get_DataObject_Name(), SG_XML_Add_Parameter(), SG_XML_DESCRIPTION, SG_XML_PARAM, SG_XML_PARAM_ATT_CLASS, SG_XML_PARAM_ATT_NAME, SG_XML_PARAM_DEFAULT, SG_XML_PARAM_FIELD, SG_XML_PARAM_FIELD_ATT_NAME, SG_XML_PARAM_FIELD_ATT_TYPE, SG_XML_PARAM_IDENTIFIER, SG_XML_PARAM_ITEM, SG_XML_PARAM_LIST, SG_XML_PARAM_MANDATORY, SG_XML_PARAM_MAX, SG_XML_PARAM_MIN, SG_XML_PARAM_PARENT, SG_XML_PARAM_TABLE, SG_XML_PARAM_TYPE, SG_XML_PARAM_WITH_CMD, and SG_XML_PARAM_WITH_GUI.

Referenced by CSG_Tool::Get_Summary(), and SG_XML_Add_Parameter().