#include <tool.h>

Inheritance diagram for CSG_Tool:

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)

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	do_Sync_Projections (void) const

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 (TSG_Tool_Script_Type Type, bool bHeader=true, 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)

static int	_On_Parameter_Changed (CSG_Parameter *pParameter, int Flags)

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="")

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

Protected Attributes
CSG_Parameters	Parameters

CSG_MetaData	History_Supplement

Friends
class	CSG_Tool_Interactive_Base

class	CSG_Tool_Library_Interface

class	CSG_Tool_Chain

Detailed Description

CSG_Tool is the base class for all executable SAGA tools.

See also: CSG_Parameters; CSG_Tool_Interactive; CSG_Tool_Grid; CSG_Tool_Grid_Interactive

Definition at line 150 of file tool.h.

Constructor & Destructor Documentation

◆ CSG_Tool()

CSG_Tool::CSG_Tool ( void )

Definition at line 67 of file tool.cpp.

References _On_Parameter_Changed(), CSG_String::Cmp(), CSG_Parameters::Create(), Parameters, CSG_Parameters::Set_Callback_On_Parameter_Changed(), Set_Show_Progress(), CSG_Parameters::Set_Tool(), SG_T, and SG_UI_Get_Application_Name().

◆ ~CSG_Tool()

CSG_Tool::~CSG_Tool ( void )

virtual

Definition at line 86 of file tool.cpp.

References Destroy(), Get_Parameters(), and Get_Parameters_Count().

Member Function Documentation

◆ _On_Parameter_Changed()

int CSG_Tool::_On_Parameter_Changed	(	CSG_Parameter *	pParameter,
		int	Flags
	)

static

Definition at line 452 of file tool.cpp.

References CSG_Parameter::Get_Parameters(), CSG_Parameters::Get_Tool(), On_Parameter_Changed(), On_Parameters_Enable(), PARAMETER_CHECK_ENABLE, and PARAMETER_CHECK_VALUES.

Referenced by Add_Parameters(), and CSG_Tool().

◆ Add_Parameters()

CSG_Parameters * CSG_Tool::Add_Parameters	(	const CSG_String &	Identifier,
		const CSG_String &	Name,
		const CSG_String &	Description
	)

protected

Definition at line 495 of file tool.cpp.

References _On_Parameter_Changed(), CSG_Array_Pointer::Add(), CSG_Parameters::Create(), and CSG_Parameters::Set_Callback_On_Parameter_Changed().

◆ Add_Reference() [1/2]

void CSG_Tool::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`
	)

protected

Definition at line 171 of file tool.cpp.

References CSG_Parameters::Add_Reference(), and Parameters.

◆ Add_Reference() [2/2]

void CSG_Tool::Add_Reference	(	const CSG_String &	Link,
		const SG_Char *	Link_Text = `NULL`
	)

protected

Definition at line 176 of file tool.cpp.

References CSG_Parameters::Add_Reference(), and Parameters.

◆ Create_Manager()

CSG_Data_Manager * CSG_Tool::Create_Manager ( void )

Definition at line 589 of file tool.cpp.

References Get_Manager(), and Set_Manager().

◆ DataObject_Add()

bool CSG_Tool::DataObject_Add	(	CSG_Data_Object *	pDataObject,
		bool	bUpdate = `false`
	)

protected

Definition at line 799 of file tool.cpp.

References CSG_Data_Manager::Add(), CSG_Parameters::Get_Manager(), Parameters, SG_Get_Data_Manager(), SG_UI_DataObject_Add(), SG_UI_DATAOBJECT_SHOW_MAP, and SG_UI_DATAOBJECT_UPDATE.

◆ DataObject_Get_Colors()

bool CSG_Tool::DataObject_Get_Colors	(	CSG_Data_Object *	pDataObject,
		CSG_Colors &	Colors
	)

static

Definition at line 995 of file tool.cpp.

References SG_UI_DataObject_Colors_Get().

◆ DataObject_Get_Parameter()

CSG_Parameter * CSG_Tool::DataObject_Get_Parameter	(	CSG_Data_Object *	pDataObject,
		const CSG_String &	ID
	)

static

Definition at line 1047 of file tool.cpp.

References DataObject_Get_Parameters().

Referenced by DataObject_Set_Parameter().

◆ DataObject_Get_Parameters()

bool CSG_Tool::DataObject_Get_Parameters	(	CSG_Data_Object *	pDataObject,
		CSG_Parameters &	Parameters
	)

static

Definition at line 1015 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().

◆ DataObject_Set_Colors() [1/2]

bool CSG_Tool::DataObject_Set_Colors	(	CSG_Data_Object *	pDataObject,
		const CSG_Colors &	Colors
	)

static

Definition at line 1000 of file tool.cpp.

References SG_UI_DataObject_Colors_Set().

◆ DataObject_Set_Colors() [2/2]

bool CSG_Tool::DataObject_Set_Colors	(	CSG_Data_Object *	pDataObject,
		int	nColors,
		int	Palette = `SG_COLORS_DEFAULT`,
		bool	bRevert = `false`
	)

static

Definition at line 1007 of file tool.cpp.

References SG_UI_DataObject_Colors_Set().

◆ DataObject_Set_History()

bool CSG_Tool::DataObject_Set_History	(	CSG_Parameter *	pParameter,
		CSG_MetaData *	pHistory = `NULL`
	)

protected

Definition at line 2348 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().

◆ DataObject_Set_Parameter() [1/7]

bool CSG_Tool::DataObject_Set_Parameter	(	CSG_Data_Object *	pDataObject,
		const CSG_String &	ID,
		const SG_Char *	Value
	)

static

Definition at line 1104 of file tool.cpp.

References DataObject_Get_Parameters(), and DataObject_Set_Parameter().

◆ DataObject_Set_Parameter() [2/7]

bool CSG_Tool::DataObject_Set_Parameter	(	CSG_Data_Object *	pDataObject,
		const CSG_String &	ID,
		double	loVal,
		double	hiVal
	)

static

Definition at line 1116 of file tool.cpp.

References DataObject_Get_Parameters(), DataObject_Set_Parameter(), Get_Type(), and PARAMETER_TYPE_Range.

◆ DataObject_Set_Parameter() [3/7]

bool CSG_Tool::DataObject_Set_Parameter	(	CSG_Data_Object *	pDataObject,
		const CSG_String &	ID,
		double	Value
	)

static

Definition at line 1080 of file tool.cpp.

References DataObject_Get_Parameters(), and DataObject_Set_Parameter().

◆ DataObject_Set_Parameter() [4/7]

bool CSG_Tool::DataObject_Set_Parameter	(	CSG_Data_Object *	pDataObject,
		const CSG_String &	ID,
		int	Value
	)

static

Definition at line 1068 of file tool.cpp.

References DataObject_Get_Parameters(), and DataObject_Set_Parameter().

◆ DataObject_Set_Parameter() [5/7]

bool CSG_Tool::DataObject_Set_Parameter	(	CSG_Data_Object *	pDataObject,
		const CSG_String &	ID,
		void *	Value
	)

static

Definition at line 1092 of file tool.cpp.

References DataObject_Get_Parameters(), and DataObject_Set_Parameter().

◆ DataObject_Set_Parameter() [6/7]

bool CSG_Tool::DataObject_Set_Parameter	(	CSG_Data_Object *	pDataObject,
		CSG_Data_Object *	pCopy,
		const CSG_String &	ID
	)

static

Definition at line 1061 of file tool.cpp.

References DataObject_Get_Parameter(), and DataObject_Set_Parameter().

◆ DataObject_Set_Parameter() [7/7]

bool CSG_Tool::DataObject_Set_Parameter	(	CSG_Data_Object *	pDataObject,
		CSG_Parameter *	pParameter
	)

static

Definition at line 1054 of file tool.cpp.

References DataObject_Set_Parameters().

Referenced by DataObject_Set_Parameter().

◆ DataObject_Set_Parameters() [1/2]

bool CSG_Tool::DataObject_Set_Parameters	(	CSG_Data_Object *	pDataObject,
		CSG_Data_Object *	pCopy
	)

static

Definition at line 1025 of file tool.cpp.

References DataObject_Get_Parameters(), DataObject_Set_Parameters(), and CSG_Parameters::Del_Parameter().

◆ DataObject_Set_Parameters() [2/2]

bool CSG_Tool::DataObject_Set_Parameters	(	CSG_Data_Object *	pDataObject,
		CSG_Parameters &	Parameters
	)

static

Definition at line 1020 of file tool.cpp.

References Parameters, and SG_UI_DataObject_Params_Set().

Referenced by DataObject_Set_Parameter(), and DataObject_Set_Parameters().

◆ DataObject_Update() [1/2]

bool CSG_Tool::DataObject_Update	(	CSG_Data_Object *	pDataObject,
		double	Minimum,
		double	Maximum,
		int	Show = `SG_UI_DATAOBJECT_UPDATE`
	)

static

Definition at line 981 of file tool.cpp.

References DataObject_Get_Parameters(), CSG_Parameters::Set_Parameter(), and SG_UI_DataObject_Update().

◆ DataObject_Update() [2/2]

bool CSG_Tool::DataObject_Update	(	CSG_Data_Object *	pDataObject,
		int	Show = `SG_UI_DATAOBJECT_UPDATE`
	)

static

Definition at line 976 of file tool.cpp.

References SG_UI_DataObject_Update().

Referenced by DataObject_Update_All().

◆ DataObject_Update_All()

void CSG_Tool::DataObject_Update_All ( void )

protected

Definition at line 815 of file tool.cpp.

References DataObject_Update(), CSG_Parameters::Get_Count(), and Parameters.

◆ Delete_Manager()

bool CSG_Tool::Delete_Manager	(	bool	bDetachData = `false`,
		bool	bReset = `true`
	)

Definition at line 597 of file tool.cpp.

References CSG_Data_Manager::Delete(), Get_Manager(), Set_Manager(), and SG_Get_Data_Manager().

◆ Destroy()

void CSG_Tool::Destroy ( void )

virtual

Definition at line 102 of file tool.cpp.

References CSG_MetaData::Destroy(), and History_Supplement.

Referenced by ~CSG_Tool().

◆ Dlg_Parameters() [1/3]

bool CSG_Tool::Dlg_Parameters ( const CSG_String & Identifier )

protected

Definition at line 523 of file tool.cpp.

References Get_Name(), Get_Parameters(), History_Supplement, CSG_Parameters::is_Managed(), and CSG_Parameters::Set_History().

Referenced by Dlg_Parameters().

◆ Dlg_Parameters() [2/3]

bool CSG_Tool::Dlg_Parameters	(	CSG_Parameters &	Parameters,
		const CSG_String &	Caption = `""`
	)

protected

Definition at line 548 of file tool.cpp.

References Get_Name(), CSG_String::is_Empty(), Parameters, and SG_UI_Dlg_Parameters().

◆ Dlg_Parameters() [3/3]

bool CSG_Tool::Dlg_Parameters	(	CSG_Parameters *	pParameters,
		const CSG_String &	Caption = `""`
	)

protected

Definition at line 543 of file tool.cpp.

References Dlg_Parameters().

◆ do_Sync_Projections()

virtual bool CSG_Tool::do_Sync_Projections ( void ) const

inlinevirtual

Reimplemented in CSG_Tool_Chain.

Definition at line 231 of file tool.h.

◆ Error_Fmt() [1/2]

bool CSG_Tool::Error_Fmt	(	const char *	Format,
			...
	)

protected

Definition at line 742 of file tool.cpp.

References Error_Set().

Referenced by CSG_Tool_Chain::Create().

◆ Error_Fmt() [2/2]

bool CSG_Tool::Error_Fmt	(	const wchar_t *	Format,
			...
	)

protected

Definition at line 767 of file tool.cpp.

References Error_Set().

◆ Error_Set() [1/2]

bool CSG_Tool::Error_Set ( const CSG_String & Text )

protected

Definition at line 718 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().

◆ Error_Set() [2/2]

bool CSG_Tool::Error_Set ( TSG_Tool_Error Error_ID = TOOL_ERROR_Unknown )

protected

Definition at line 705 of file tool.cpp.

References _TL, and TOOL_ERROR_Calculation.

Referenced by Error_Fmt().

◆ Execute()

bool CSG_Tool::Execute ( bool bAddHistory = false )

Definition at line 258 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(), CSG_Projections::Parse(), and SG_Get_Projected().

◆ Get_Author()

const CSG_String & CSG_Tool::Get_Author ( void ) const

Definition at line 143 of file tool.cpp.

Referenced by Get_Summary().

◆ Get_Description()

const CSG_String & CSG_Tool::Get_Description ( void ) const

Definition at line 165 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().

◆ Get_Execution_Info()

const SG_Char* CSG_Tool::Get_Execution_Info ( void ) const

inline

Definition at line 249 of file tool.h.

◆ Get_File_Name()

const CSG_String & CSG_Tool::Get_File_Name ( void ) const

Definition at line 121 of file tool.cpp.

Referenced by Get_Summary().

◆ Get_Grid_System()

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 1268 of file tool.cpp.

References CSG_Parameters::Get_Grid_System(), and Parameters.

◆ Get_Icon()

const SG_Char* CSG_Tool::Get_Icon ( void )

inline

Definition at line 174 of file tool.h.

◆ Get_ID()

const CSG_String& CSG_Tool::Get_ID ( void ) const

inline

Definition at line 165 of file tool.h.

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

◆ Get_Library()

const CSG_String & CSG_Tool::Get_Library ( void ) const

Definition at line 115 of file tool.cpp.

Referenced by Get_Summary().

◆ Get_Manager()

CSG_Data_Manager * CSG_Tool::Get_Manager ( void ) const

Definition at line 583 of file tool.cpp.

References CSG_Parameters::Get_Manager(), and Parameters.

Referenced by Create_Manager(), and Delete_Manager().

◆ Get_MenuPath() [1/2]

CSG_String CSG_Tool::Get_MenuPath ( bool bSolved )

virtual

Definition at line 187 of file tool.cpp.

References CSG_Strings::Get_Count(), Get_MenuPath(), CSG_String::is_Empty(), and SG_String_Tokenize().

◆ Get_MenuPath() [2/2]

virtual CSG_String CSG_Tool::Get_MenuPath ( void )

inlinevirtual

Reimplemented in CSG_Tool_Chain.

Definition at line 177 of file tool.h.

References SG_T.

Referenced by Get_MenuPath(), and Get_Summary().

◆ Get_Name()

const CSG_String & CSG_Tool::Get_Name ( void ) const

Definition at line 132 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().

◆ Get_Parameter() [1/3]

CSG_Parameter* CSG_Tool::Get_Parameter ( const char * ID ) const

inline

Definition at line 188 of file tool.h.

References Parameters.

◆ Get_Parameter() [2/3]

CSG_Parameter* CSG_Tool::Get_Parameter ( const CSG_String & ID ) const

inline

Definition at line 187 of file tool.h.

References Parameters.

Referenced by CSG_Projections::Parse(), and SG_Get_Projected().

◆ Get_Parameter() [3/3]

CSG_Parameter* CSG_Tool::Get_Parameter ( const wchar_t * ID ) const

inline

Definition at line 189 of file tool.h.

References Parameters.

◆ Get_Parameter_Changed()

TSG_PFNC_Parameter_Changed CSG_Tool::Get_Parameter_Changed ( void )

inlineprotected

Definition at line 276 of file tool.h.

◆ Get_Parameters() [1/4]

CSG_Parameters * CSG_Tool::Get_Parameters ( const CSG_String & Identifier ) const

Definition at line 509 of file tool.cpp.

References CSG_Parameters::Cmp_Identifier(), Get_Parameters(), and Get_Parameters_Count().

◆ Get_Parameters() [2/4]

CSG_Parameters* CSG_Tool::Get_Parameters ( int i )

inline

Definition at line 184 of file tool.h.

References Get_Parameters_Count().

◆ Get_Parameters() [3/4]

CSG_Parameters* CSG_Tool::Get_Parameters ( int i ) const

inline

Definition at line 183 of file tool.h.

References Get_Parameters_Count().

◆ Get_Parameters() [4/4]

CSG_Parameters* CSG_Tool::Get_Parameters ( void )

inline

Definition at line 180 of file tool.h.

References Parameters.

Referenced by CSG_Parameters_CRSPicker::Activate_GUI(), Dlg_Parameters(), Get_Parameters(), Get_Projection(), Reset(), Reset_Grid_System(), Set_Callback(), Set_Manager(), Settings_Pop(), Settings_Push(), Update_Parameter_States(), and ~CSG_Tool().

◆ Get_Parameters_Count()

int CSG_Tool::Get_Parameters_Count ( void ) const

inline

Definition at line 182 of file tool.h.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), Get_Parameters(), Get_Projection(), Reset(), Reset_Grid_System(), Set_Callback(), Set_Manager(), Settings_Pop(), Settings_Push(), Update_Parameter_States(), and ~CSG_Tool().

◆ Get_Projection()

bool CSG_Tool::Get_Projection ( CSG_Projection & Projection ) const

protected

Definition at line 430 of file tool.cpp.

References CSG_Projection::Destroy(), Get_Parameters(), Get_Parameters_Count(), CSG_Projection::is_Okay(), and Parameters.

◆ Get_References()

const CSG_Strings & CSG_Tool::Get_References ( void ) const

Definition at line 181 of file tool.cpp.

References CSG_Parameters::Get_References(), and Parameters.

Referenced by Get_Summary().

◆ Get_Script()

CSG_String CSG_Tool::Get_Script	(	TSG_Tool_Script_Type	Type,
		bool	bHeader = `true`,
		bool	bAllParameters = `false`
	)

Definition at line 1322 of file tool.cpp.

References CSG_Tool_Chain::Get_Script(), TOOL_SCRIPT_CHAIN, TOOL_SCRIPT_CMD_BATCH, TOOL_SCRIPT_CMD_SHELL, TOOL_SCRIPT_CMD_USAGE, TOOL_SCRIPT_PYTHON, TOOL_SCRIPT_PYTHON_WRAP_ID, TOOL_SCRIPT_PYTHON_WRAP_ID_CALL, TOOL_SCRIPT_PYTHON_WRAP_NAME, TOOL_SCRIPT_PYTHON_WRAP_NAME_CALL, and TOOL_SCRIPT_PYTHON_WRAP_NAME_CALL_FULL.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox().

◆ Get_Summary()

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_Parameter::do_UseInCMD(), 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(), has_GUI(), 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_HTML_Tag_Replacer(), SG_SUMMARY_FMT_FLAT, SG_SUMMARY_FMT_HTML, SG_SUMMARY_FMT_XML, SG_T, 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().

◆ Get_Type()

virtual TSG_Tool_Type CSG_Tool::Get_Type ( void ) const

inlinevirtual

Reimplemented in CSG_Tool_Chain, CSG_Tool_Grid_Interactive, CSG_Tool_Interactive, and CSG_Tool_Grid.

Definition at line 163 of file tool.h.

References TOOL_TYPE_Base.

Referenced by DataObject_Set_Parameter(), Get_Summary(), and CSG_Tool_Library::Get_Tool().

◆ Get_Version()

const CSG_String & CSG_Tool::Get_Version ( void ) const

Definition at line 154 of file tool.cpp.

Referenced by Get_Summary().

◆ has_CMD()

bool CSG_Tool::has_CMD ( void ) const

Definition at line 245 of file tool.cpp.

◆ has_GUI()

bool CSG_Tool::has_GUI ( void ) const

Definition at line 239 of file tool.cpp.

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::Get_Grids(), Get_Summary(), CSG_Parameters_Grid_Target::Set_User_Defined(), and CSG_Parameters_Grid_Target::Set_User_Defined_ZLevels().

◆ is_Executing()

bool CSG_Tool::is_Executing ( void ) const

inline

Definition at line 240 of file tool.h.

◆ is_Grid()

virtual bool CSG_Tool::is_Grid ( void ) const

inlinevirtual

Reimplemented in CSG_Tool_Grid.

Definition at line 237 of file tool.h.

Referenced by Get_Summary().

◆ is_Interactive()

virtual bool CSG_Tool::is_Interactive ( void ) const

inlinevirtual

Reimplemented in CSG_Tool_Grid_Interactive, and CSG_Tool_Interactive.

Definition at line 238 of file tool.h.

Referenced by CSG_Tool_Library_Interface::Create(), CSG_Tool_Library_Manager::Create_Python_ToolBox(), Execute(), and Get_Summary().

◆ is_Progress()

bool CSG_Tool::is_Progress ( void ) const

inline

Definition at line 239 of file tool.h.

References SG_UI_Process_Get_Okay().

Referenced by CSG_Tool_Grid::Set_Progress_Cells().

◆ Message_Add()

void CSG_Tool::Message_Add	(	const CSG_String &	Text,
		bool	bNewLine = `true`
	)

protected

Definition at line 906 of file tool.cpp.

References SG_UI_Msg_Add_Execution().

Referenced by Message_Fmt().

◆ Message_Dlg()

void CSG_Tool::Message_Dlg	(	const CSG_String &	Text,
		const SG_Char *	Caption = `NULL`
	)

protected

Definition at line 693 of file tool.cpp.

References Get_Name(), and SG_UI_Dlg_Message().

Referenced by Execute().

◆ Message_Dlg_Confirm()

bool CSG_Tool::Message_Dlg_Confirm	(	const CSG_String &	Text,
		const SG_Char *	Caption = `NULL`
	)

protected

Definition at line 699 of file tool.cpp.

References Get_Name(), and SG_UI_Dlg_Continue().

◆ Message_Fmt() [1/2]

void CSG_Tool::Message_Fmt	(	const char *	Format,
			...
	)

protected

Definition at line 919 of file tool.cpp.

References Message_Add().

◆ Message_Fmt() [2/2]

void CSG_Tool::Message_Fmt	(	const wchar_t *	Format,
			...
	)

protected

Definition at line 944 of file tool.cpp.

References Message_Add().

◆ needs_GUI()

virtual bool CSG_Tool::needs_GUI ( void ) const

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(), and CSG_Tool_Library::Get_Summary().

◆ On_After_Execution()

virtual bool CSG_Tool::On_After_Execution ( void )

inlinevirtual

Definition at line 245 of file tool.h.

◆ On_Before_Execution()

virtual bool CSG_Tool::On_Before_Execution ( void )

inlinevirtual

Definition at line 244 of file tool.h.

Referenced by CSG_Shapes::Create(), and CSG_Table::Create().

◆ On_Execute()

virtual bool CSG_Tool::On_Execute ( void )

protectedpure virtual

Implemented in CSG_Tool_Chain.

Referenced by Execute().

◆ On_Parameter_Changed()

int CSG_Tool::On_Parameter_Changed	(	CSG_Parameters *	pParameters,
		CSG_Parameter *	pParameter
	)

protectedvirtual

Definition at line 476 of file tool.cpp.

Referenced by _On_Parameter_Changed().

◆ On_Parameters_Enable()

int CSG_Tool::On_Parameters_Enable	(	CSG_Parameters *	pParameters,
		CSG_Parameter *	pParameter
	)

protectedvirtual

Reimplemented in CSG_Tool_Chain.

Definition at line 482 of file tool.cpp.

Referenced by _On_Parameter_Changed().

◆ Process_Get_Okay()

bool CSG_Tool::Process_Get_Okay ( bool bBlink = false )

static

Definition at line 844 of file tool.cpp.

References SG_UI_Process_Get_Okay().

Referenced by Execute(), and Set_Progress().

◆ Process_Set_Text() [1/3]

void CSG_Tool::Process_Set_Text	(	const char *	Format,
			...
	)

static

Definition at line 856 of file tool.cpp.

References SG_UI_Process_Set_Text().

◆ Process_Set_Text() [2/3]

void CSG_Tool::Process_Set_Text ( const CSG_String & Text )

static

Definition at line 850 of file tool.cpp.

References SG_UI_Process_Set_Text().

◆ Process_Set_Text() [3/3]

void CSG_Tool::Process_Set_Text	(	const wchar_t *	Format,
			...
	)

static

Definition at line 881 of file tool.cpp.

References SG_UI_Process_Set_Text().

◆ Reset()

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 1211 of file tool.cpp.

References Get_Parameters(), Get_Parameters_Count(), Parameters, Reset_Grid_System(), Reset_Manager(), and CSG_Parameters::Restore_Defaults().

◆ Reset_Grid_System()

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 1243 of file tool.cpp.

References Get_Parameters(), Get_Parameters_Count(), Parameters, and CSG_Parameters::Reset_Grid_System().

Referenced by Reset().

◆ Reset_Manager()

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 1233 of file tool.cpp.

References Set_Manager(), and SG_Get_Data_Manager().

Referenced by Reset().

◆ Set_Author()

void CSG_Tool::Set_Author ( const CSG_String & String )

protected

Definition at line 138 of file tool.cpp.

Referenced by CSG_Tool_Chain::Create().

◆ Set_Callback()

void CSG_Tool::Set_Callback ( bool bActive = true )

Definition at line 559 of file tool.cpp.

References Get_Parameters(), Get_Parameters_Count(), Parameters, and CSG_Parameters::Set_Callback().

◆ Set_Description()

void CSG_Tool::Set_Description ( const CSG_String & String )

protected

Definition at line 160 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Description().

Referenced by CSG_Tool_Chain::Create().

◆ Set_Grid_System()

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 1258 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Grid_System().

◆ Set_Manager()

bool CSG_Tool::Set_Manager ( class CSG_Data_Manager * pManager )

Definition at line 570 of file tool.cpp.

References Get_Parameters(), Get_Parameters_Count(), Parameters, and CSG_Parameters::Set_Manager().

Referenced by CSG_Shapes::Create(), CSG_Table::Create(), Create_Manager(), Delete_Manager(), Reset_Manager(), and SG_Get_Projected().

◆ Set_Name()

void CSG_Tool::Set_Name ( const CSG_String & String )

protected

Definition at line 127 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Name().

Referenced by CSG_Tool_Chain::Create().

◆ Set_Parameter() [1/21]

bool CSG_Tool::Set_Parameter	(	const char *	ID,
		const char *	Value,
		int	Type = `PARAMETER_TYPE_Undefined`
	)

Definition at line 1186 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Parameter().

◆ Set_Parameter() [2/21]

bool CSG_Tool::Set_Parameter	(	const char *	ID,
		const CSG_String &	Value,
		int	Type = `PARAMETER_TYPE_Undefined`
	)

Definition at line 1177 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Parameter().

◆ Set_Parameter() [3/21]

bool CSG_Tool::Set_Parameter	(	const char *	ID,
		const wchar_t *	Value,
		int	Type = `PARAMETER_TYPE_Undefined`
	)

Definition at line 1195 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Parameter().

◆ Set_Parameter() [4/21]

bool CSG_Tool::Set_Parameter	(	const char *	ID,
		CSG_Parameter *	pValue
	)

Definition at line 1141 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Parameter().

◆ Set_Parameter() [5/21]

bool CSG_Tool::Set_Parameter	(	const char *	ID,
		double	Value,
		int	Type = `PARAMETER_TYPE_Undefined`
	)

Definition at line 1159 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Parameter().

◆ Set_Parameter() [6/21]

bool CSG_Tool::Set_Parameter	(	const char *	ID,
		int	Value,
		int	Type = `PARAMETER_TYPE_Undefined`
	)

Definition at line 1150 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Parameter().

◆ Set_Parameter() [7/21]

bool CSG_Tool::Set_Parameter	(	const char *	ID,
		void *	Value,
		int	Type = `PARAMETER_TYPE_Undefined`
	)

Definition at line 1168 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Parameter().