SAGA API  v9.2
CSG_Tool Class Referenceabstract

#include <tool.h>

Inheritance diagram for CSG_Tool:
CSG_Tool_Chain CSG_Tool_Grid CSG_Tool_Interactive CSG_Tool_Grid_Interactive

Public Member Functions

 CSG_Tool (void)
 
virtual ~CSG_Tool (void)
 
virtual void Destroy (void)
 
virtual TSG_Tool_Type Get_Type (void) const
 
const CSG_StringGet_ID (void) const
 
const CSG_StringGet_Library (void) const
 
const CSG_StringGet_File_Name (void) const
 
const CSG_StringGet_Name (void) const
 
const CSG_StringGet_Author (void) const
 
const CSG_StringGet_Version (void) const
 
const CSG_StringGet_Description (void) const
 
const CSG_StringsGet_References (void) const
 
const SG_CharGet_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_ParametersGet_Parameters (void)
 
CSG_ParametersGet_Parameters (int i)
 
CSG_ParametersGet_Parameters (const CSG_String &Identifier)
 
CSG_ParameterGet_Parameter (const CSG_String &ID) const
 
CSG_ParameterGet_Parameter (const char *ID) const
 
CSG_ParameterGet_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_ManagerGet_Manager (void) const
 
class CSG_Data_ManagerCreate_Manager (void)
 
bool Delete_Manager (bool bDetachData=false, bool bReset=true)
 
bool Set_Grid_System (const CSG_Grid_System &System)
 
CSG_Grid_SystemGet_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_CharGet_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_ParameterDataObject_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_ParametersAdd_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
 

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 148 of file tool.h.

Constructor & Destructor Documentation

◆ CSG_Tool()

CSG_Tool::CSG_Tool ( void  )

◆ ~CSG_Tool()

CSG_Tool::~CSG_Tool ( void  )
virtual

Member Function Documentation

◆ Add_Parameters()

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

◆ 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 184 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 189 of file tool.cpp.

References CSG_Parameters::Add_Reference(), and Parameters.

◆ Create_Manager()

CSG_Data_Manager * CSG_Tool::Create_Manager ( void  )

Definition at line 568 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

◆ DataObject_Get_Colors()

bool CSG_Tool::DataObject_Get_Colors ( CSG_Data_Object pDataObject,
CSG_Colors Colors 
)
static

Definition at line 999 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 1051 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

◆ DataObject_Set_Colors() [1/2]

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

Definition at line 1004 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 1011 of file tool.cpp.

References SG_UI_DataObject_Colors_Set().

◆ DataObject_Set_History()

◆ 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 1108 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

◆ 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 1084 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 1072 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 1096 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 1065 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 1058 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

◆ DataObject_Set_Parameters() [2/2]

bool CSG_Tool::DataObject_Set_Parameters ( CSG_Data_Object pDataObject,
CSG_Parameters Parameters 
)
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().

◆ DataObject_Update() [1/2]

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

◆ DataObject_Update() [2/2]

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

Definition at line 980 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 819 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 
)

◆ Destroy()

void CSG_Tool::Destroy ( void  )
virtual

Definition at line 115 of file tool.cpp.

References CSG_MetaData::Destroy(), and History_Supplement.

Referenced by ~CSG_Tool().

◆ Dlg_Parameters() [1/2]

bool CSG_Tool::Dlg_Parameters ( const CSG_String Identifier)
protected

◆ Dlg_Parameters() [2/2]

bool CSG_Tool::Dlg_Parameters ( CSG_Parameters pParameters,
const CSG_String Caption 
)
protected

Definition at line 527 of file tool.cpp.

References SG_UI_Dlg_Parameters().

◆ do_Sync_Projections()

virtual bool CSG_Tool::do_Sync_Projections ( void  ) const
inlinevirtual

Reimplemented in CSG_Tool_Chain.

Definition at line 227 of file tool.h.

◆ Error_Fmt() [1/2]

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

Definition at line 746 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 771 of file tool.cpp.

References Error_Set().

◆ Error_Set() [1/2]

bool CSG_Tool::Error_Set ( const CSG_String Text)
protected

◆ Error_Set() [2/2]

bool CSG_Tool::Error_Set ( TSG_Tool_Error  Error_ID = TOOL_ERROR_Unknown)
protected

Definition at line 709 of file tool.cpp.

References _TL, and TOOL_ERROR_Calculation.

Referenced by Error_Fmt().

◆ Execute()

◆ Get_Author()

const CSG_String & CSG_Tool::Get_Author ( void  ) const

Definition at line 156 of file tool.cpp.

Referenced by Get_Summary().

◆ Get_Description()

const CSG_String & CSG_Tool::Get_Description ( void  ) const

◆ Get_Execution_Info()

const SG_Char* CSG_Tool::Get_Execution_Info ( void  ) const
inline

Definition at line 244 of file tool.h.

◆ Get_File_Name()

const CSG_String & CSG_Tool::Get_File_Name ( void  ) const

Definition at line 134 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 1272 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 172 of file tool.h.

◆ Get_ID()

const CSG_String& CSG_Tool::Get_ID ( void  ) const
inline

Definition at line 163 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 128 of file tool.cpp.

Referenced by Get_Summary().

◆ Get_Manager()

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().

◆ Get_MenuPath() [1/2]

CSG_String CSG_Tool::Get_MenuPath ( bool  bSolved)
virtual

◆ Get_MenuPath() [2/2]

virtual CSG_String CSG_Tool::Get_MenuPath ( void  )
inlinevirtual

Reimplemented in CSG_Tool_Chain.

Definition at line 175 of file tool.h.

References SG_T.

Referenced by Get_MenuPath(), and Get_Summary().

◆ Get_Name()

◆ Get_Parameter() [1/3]

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

Definition at line 184 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 183 of file tool.h.

References Parameters.

Referenced by SG_Get_Projected().

◆ Get_Parameter() [3/3]

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

Definition at line 185 of file tool.h.

References Parameters.

◆ Get_Parameter_Changed()

TSG_PFNC_Parameter_Changed CSG_Tool::Get_Parameter_Changed ( void  )
inlineprotected

Definition at line 271 of file tool.h.

◆ Get_Parameters() [1/3]

CSG_Parameters * CSG_Tool::Get_Parameters ( const CSG_String Identifier)

Definition at line 498 of file tool.cpp.

◆ Get_Parameters() [2/3]

CSG_Parameters* CSG_Tool::Get_Parameters ( int  i)
inline

Definition at line 180 of file tool.h.

◆ Get_Parameters() [3/3]

CSG_Parameters* CSG_Tool::Get_Parameters ( void  )
inline

Definition at line 179 of file tool.h.

References Parameters.

Referenced by Dlg_Parameters(), and Update_Parameter_States().

◆ Get_Parameters_Count()

int CSG_Tool::Get_Parameters_Count ( void  )
inline

◆ Get_Projection()

bool CSG_Tool::Get_Projection ( CSG_Projection Projection) const
protected

Definition at line 418 of file tool.cpp.

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

◆ Get_References()

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().

◆ Get_Script()

◆ Get_Summary()

◆ Get_Type()

virtual TSG_Tool_Type CSG_Tool::Get_Type ( void  ) const
inlinevirtual

◆ Get_Version()

const CSG_String & CSG_Tool::Get_Version ( void  ) const

Definition at line 167 of file tool.cpp.

Referenced by Get_Summary().

◆ has_GUI()

◆ is_Executing()

bool CSG_Tool::is_Executing ( void  ) const
inline

Definition at line 235 of file tool.h.

◆ is_Grid()

virtual bool CSG_Tool::is_Grid ( void  ) const
inlinevirtual

Reimplemented in CSG_Tool_Grid.

Definition at line 232 of file tool.h.

Referenced by Get_Summary().

◆ is_Interactive()

virtual bool CSG_Tool::is_Interactive ( void  ) const
inlinevirtual

◆ is_Progress()

bool CSG_Tool::is_Progress ( void  ) const
inline

Definition at line 234 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 910 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 697 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 703 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 923 of file tool.cpp.

References Message_Add().

◆ Message_Fmt() [2/2]

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

Definition at line 948 of file tool.cpp.

References Message_Add().

◆ needs_GUI()

virtual bool CSG_Tool::needs_GUI ( void  ) const
inlinevirtual

◆ On_After_Execution()

virtual bool CSG_Tool::On_After_Execution ( void  )
inlinevirtual

Definition at line 240 of file tool.h.

◆ On_Before_Execution()

virtual bool CSG_Tool::On_Before_Execution ( void  )
inlinevirtual

Definition at line 239 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 464 of file tool.cpp.

◆ On_Parameters_Enable()

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

Reimplemented in CSG_Tool_Chain.

Definition at line 470 of file tool.cpp.

◆ Process_Get_Okay()

bool CSG_Tool::Process_Get_Okay ( bool  bBlink = false)
static

Definition at line 848 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 860 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 854 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 885 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 1215 of file tool.cpp.

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

References 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 1237 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 151 of file tool.cpp.

Referenced by CSG_Tool_Chain::Create().

◆ Set_Callback()

void CSG_Tool::Set_Callback ( bool  bActive = true)

Definition at line 538 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Callback().

◆ Set_Description()

void CSG_Tool::Set_Description ( const CSG_String String)
protected

Definition at line 173 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 1262 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Grid_System().

◆ Set_Manager()

bool CSG_Tool::Set_Manager ( class CSG_Data_Manager pManager)

◆ Set_Name()

void CSG_Tool::Set_Name ( const CSG_String String)
protected

Definition at line 140 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 1190 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 1181 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 1199 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 1145 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 1163 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 1154 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 1172 of file tool.cpp.

References Parameters, and CSG_Parameters::Set_Parameter().

◆ Set_Parameter() [8/21]

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().

◆ Set_Parameter() [9/21]

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().

◆ Set_Parameter() [10/21]

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().

◆ Set_Parameter() [11/21]

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().

◆ Set_Parameter() [12/21]

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().

◆ Set_Parameter() [13/21]

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().

◆ Set_Parameter() [14/21]

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().

◆ Set_Parameter() [15/21]

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().

◆ Set_Parameter() [16/21]

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().

◆ Set_Parameter() [17/21]

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().

◆ Set_Parameter() [18/21]

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().

◆ Set_Parameter() [19/21]

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().

◆ Set_Parameter() [20/21]

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().

◆ Set_Parameter() [21/21]

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().

◆ Set_Progress() [1/3]

bool CSG_Tool::Set_Progress ( double  Position,
double  Range = 1. 
) const
protectedvirtual

Definition at line 676 of file tool.cpp.

References Process_Get_Okay(), and SG_UI_Process_Set_Progress().

◆ Set_Progress() [2/3]

bool CSG_Tool::Set_Progress ( int  Position,
int  Range 
) const
protectedvirtual

◆ Set_Progress() [3/3]

bool CSG_Tool::Set_Progress ( sLong  Position,
sLong  Range 
) const
protectedvirtual

Definition at line 670 of file tool.cpp.

References Set_Progress().

◆ Set_Show_Progress()

void CSG_Tool::Set_Show_Progress ( bool  bOn = true)

Definition at line 658 of file tool.cpp.

Referenced by CSG_Tool().

◆ Set_Version()

void CSG_Tool::Set_Version ( const CSG_String String)
protected

Definition at line 162 of file tool.cpp.

◆ Settings_Pop()

◆ Settings_Push()

◆ Stop_Execution()

bool CSG_Tool::Stop_Execution ( bool  bDialog = true)
protected

Definition at line 682 of file tool.cpp.

References SG_UI_Stop_Execution().

◆ Update_Parameter_States()

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().

Friends And Related Function Documentation

◆ CSG_Tool_Chain

friend class CSG_Tool_Chain ( void  )
friend

Definition at line 152 of file tool.h.

◆ CSG_Tool_Interactive_Base

friend class CSG_Tool_Interactive_Base
friend

Definition at line 150 of file tool.h.

◆ CSG_Tool_Library_Interface

friend class CSG_Tool_Library_Interface
friend

Definition at line 151 of file tool.h.

Member Data Documentation

◆ History_Supplement

CSG_MetaData CSG_Tool::History_Supplement
protected

Definition at line 253 of file tool.h.

Referenced by Destroy(), Dlg_Parameters(), and Execute().

◆ Parameters


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