SAGA API Version 9.12
Loading...
Searching...
No Matches
CSG_Tool_Library Class Reference

#include <tool_library.h>

Inheritance diagram for CSG_Tool_Library:
CSG_Tool_Chains

Public Member Functions

virtual ESG_Library_Type Get_Type (void) const
bool is_Valid (void) const
const CSG_String & Get_File_Name (void) const
const CSG_String & Get_Library_Name (void) const
const CSG_String & Get_Description (void) const
virtual const CSG_String & Get_Info (int Type) 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_Menu (void) const
const CSG_String & Get_Category (void) const
CSG_String Get_Summary (int Format=SG_SUMMARY_FMT_HTML, bool bInteractive=true) const
bool Get_Summary (const CSG_String &Path) const
virtual int Get_Count (void) const
virtual CSG_Tool * Get_Tool (int Index, TSG_Tool_Type Type=TOOL_TYPE_Base) const
virtual CSG_Tool * Get_Tool (const CSG_String &Name, TSG_Tool_Type Type=TOOL_TYPE_Base) const
virtual CSG_Tool * Get_Tool (const char *Name, TSG_Tool_Type Type=TOOL_TYPE_Base) const
virtual CSG_Tool * Get_Tool (const wchar_t *Name, TSG_Tool_Type Type=TOOL_TYPE_Base) const
virtual CSG_Tool * Create_Tool (int Index, bool bWithGUI=false, bool bWithCMD=true)
virtual CSG_Tool * Create_Tool (const CSG_String &Name, bool bWithGUI=false, bool bWithCMD=true)
virtual CSG_Tool * Create_Tool (const char *Name, bool bWithGUI=false, bool bWithCMD=true)
virtual CSG_Tool * Create_Tool (const wchar_t *Name, bool bWithGUI=false, bool bWithCMD=true)
virtual bool Delete_Tool (CSG_Tool *pTool)
virtual bool Delete_Tools (void)
virtual CSG_String Get_File_Name (int i) const
virtual CSG_String Get_Menu (int i) const
bool Load_Description (void)
const CSG_Table & Get_References_Table (void) const
CSG_Strings Get_References (bool bHTML=true) const
bool Del_References (void)
void Add_Reference (const CSG_String &Authors, const CSG_String &Date, const CSG_String &Title, const CSG_String &Source, const CSG_String &Link="", const CSG_String &Link_Text="")
void Add_Reference (const CSG_String &Link, const CSG_String &Link_Text="")

Protected Member Functions

 CSG_Tool_Library (void)
 CSG_Tool_Library (const CSG_String &File)
virtual ~CSG_Tool_Library (void)

Protected Attributes

CSG_String m_File_Name
CSG_String m_Library_Name

Friends

class CSG_Tool_Library_Manager

Detailed Description

Definition at line 104 of file tool_library.h.

Constructor & Destructor Documentation

◆ CSG_Tool_Library() [1/2]

CSG_Tool_Library::CSG_Tool_Library ( void )
protected

Definition at line 68 of file tool_library.cpp.

◆ CSG_Tool_Library() [2/2]

CSG_Tool_Library::CSG_Tool_Library ( const CSG_String & File)
protected

Definition at line 75 of file tool_library.cpp.

References _TL, Load_Description(), m_File_Name, m_Library_Name, SG_DATATYPE_String, SG_File_Get_Path_Absolute(), SYMBOL_TLB_Finalize, SYMBOL_TLB_Get_Interface, SYMBOL_TLB_Initialize, TLB_INFO_Description, TLB_INFO_File, and TLB_INFO_Library.

◆ ~CSG_Tool_Library()

CSG_Tool_Library::~CSG_Tool_Library ( void )
protectedvirtual

Definition at line 111 of file tool_library.cpp.

Member Function Documentation

◆ Add_Reference() [1/2]

void CSG_Tool_Library::Add_Reference ( const CSG_String & Authors,
const CSG_String & Date,
const CSG_String & Title,
const CSG_String & Source,
const CSG_String & Link = "",
const CSG_String & Link_Text = "" )

Definition at line 292 of file tool_library.cpp.

References CSG_Table_Record::Set_Value().

Referenced by Add_Reference(), CSG_Tool_Chains::CSG_Tool_Chains(), and Load_Description().

◆ Add_Reference() [2/2]

void CSG_Tool_Library::Add_Reference ( const CSG_String & Link,
const CSG_String & Link_Text = "" )

Definition at line 307 of file tool_library.cpp.

References Add_Reference().

◆ Create_Tool() [1/4]

CSG_Tool * CSG_Tool_Library::Create_Tool ( const char * Name,
bool bWithGUI = false,
bool bWithCMD = true )
virtual

Definition at line 209 of file tool_library.cpp.

References Create_Tool().

◆ Create_Tool() [2/4]

CSG_Tool * CSG_Tool_Library::Create_Tool ( const CSG_String & Name,
bool bWithGUI = false,
bool bWithCMD = true )
virtual

Reimplemented in CSG_Tool_Chains.

Definition at line 211 of file tool_library.cpp.

References CSG_String::asInt(), and Create_Tool().

◆ Create_Tool() [3/4]

CSG_Tool * CSG_Tool_Library::Create_Tool ( const wchar_t * Name,
bool bWithGUI = false,
bool bWithCMD = true )
virtual

Definition at line 210 of file tool_library.cpp.

References Create_Tool().

◆ Create_Tool() [4/4]

CSG_Tool * CSG_Tool_Library::Create_Tool ( int Index,
bool bWithGUI = false,
bool bWithCMD = true )
virtual

Creates a new instance of the requested tool in addition to the standard-wise created instance that you can request with the 'Get_Tool() functions. Tools created with this function are collected in a separate internal list and can be removed from memory with the 'Delete_Tool()' function. This way of tool creation is necessary, if you want to run a tool simultaneously with different settings.

Definition at line 203 of file tool_library.cpp.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), Create_Tool(), Create_Tool(), Create_Tool(), and CSG_Tool_Library_Manager::Create_Tool().

◆ Del_References()

bool CSG_Tool_Library::Del_References ( void )

Definition at line 313 of file tool_library.cpp.

Referenced by Load_Description().

◆ Delete_Tool()

bool CSG_Tool_Library::Delete_Tool ( CSG_Tool * pTool)
virtual

Deletes a tool that has been created previously with a call to the 'Create_Tool()' function.

Reimplemented in CSG_Tool_Chains.

Definition at line 222 of file tool_library.cpp.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox().

◆ Delete_Tools()

bool CSG_Tool_Library::Delete_Tools ( void )
virtual

Reimplemented in CSG_Tool_Chains.

Definition at line 228 of file tool_library.cpp.

◆ Get_Author()

const CSG_String & CSG_Tool_Library::Get_Author ( void ) const
inline

Definition at line 120 of file tool_library.h.

References Get_Info(), and TLB_INFO_Author.

◆ Get_Category()

const CSG_String & CSG_Tool_Library::Get_Category ( void ) const
inline

Definition at line 123 of file tool_library.h.

References Get_Info(), and TLB_INFO_Category.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox().

◆ Get_Count()

virtual int CSG_Tool_Library::Get_Count ( void ) const
inlinevirtual

Reimplemented in CSG_Tool_Chains.

Definition at line 128 of file tool_library.h.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), Get_Summary(), Get_Summary(), CSG_Tool_Library_Manager::Get_Summary(), Get_Tool(), Get_Tool(), and is_Valid().

◆ Get_Description()

const CSG_String & CSG_Tool_Library::Get_Description ( void ) const
inline

Definition at line 116 of file tool_library.h.

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

◆ Get_File_Name() [1/2]

virtual CSG_String CSG_Tool_Library::Get_File_Name ( int i) const
inlinevirtual

Reimplemented in CSG_Tool_Chains.

Definition at line 143 of file tool_library.h.

◆ Get_File_Name() [2/2]

const CSG_String & CSG_Tool_Library::Get_File_Name ( void ) const
inline

Definition at line 114 of file tool_library.h.

References m_File_Name.

Referenced by Get_Summary().

◆ Get_Info()

const CSG_String & CSG_Tool_Library::Get_Info ( int Type) const
virtual

Reimplemented in CSG_Tool_Chains.

Definition at line 146 of file tool_library.cpp.

Referenced by Get_Author(), Get_Category(), Get_Menu(), Get_Name(), Get_Summary(), and Get_Version().

◆ Get_Library_Name()

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

Definition at line 115 of file tool_library.h.

References m_Library_Name.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Tool_Library_Manager::Get_Library(), Get_Summary(), Get_Summary(), and CSG_Tool_Library_Manager::Get_Summary().

◆ Get_Menu() [1/2]

CSG_String CSG_Tool_Library::Get_Menu ( int i) const
virtual

Definition at line 239 of file tool_library.cpp.

References Get_Tool().

◆ Get_Menu() [2/2]

const CSG_String & CSG_Tool_Library::Get_Menu ( void ) const
inline

Definition at line 122 of file tool_library.h.

References Get_Info(), and TLB_INFO_Menu_Path.

◆ Get_Name()

const CSG_String & CSG_Tool_Library::Get_Name ( void ) const
inline

Definition at line 119 of file tool_library.h.

References Get_Info(), and TLB_INFO_Name.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Tool_Chains::CSG_Tool_Chains(), CSG_Tool_Library_Manager::Get_Library(), and Get_Summary().

◆ Get_References()

CSG_Strings CSG_Tool_Library::Get_References ( bool bHTML = true) const

Definition at line 319 of file tool_library.cpp.

References CSG_String::is_Empty().

Referenced by Get_Summary().

◆ Get_References_Table()

const CSG_Table & CSG_Tool_Library::Get_References_Table ( void ) const
inline

Definition at line 148 of file tool_library.h.

◆ Get_Summary() [1/2]

bool CSG_Tool_Library::Get_Summary ( const CSG_String & Path) const

Definition at line 799 of file tool_summary.cpp.

References Get_Count(), Get_Library_Name(), Get_Summary(), Get_Tool(), CSG_File::Open(), SG_FILE_ENCODING_UTF8, SG_File_Make_Path(), SG_FILE_W, and CSG_File::Write().

◆ Get_Summary() [2/2]

CSG_String CSG_Tool_Library::Get_Summary ( int Format = SG_SUMMARY_FMT_HTML,
bool bInteractive = true ) const

Definition at line 657 of file tool_summary.cpp.

References _TL, CSG_String::c_str(), CSG_String::Format(), CSG_Strings::Get_Count(), Get_Count(), Get_Description(), Get_File_Name(), CSG_Tool::Get_ID(), Get_Info(), Get_Library_Name(), CSG_Tool::Get_Name(), Get_Name(), Get_References(), Get_Tool(), CSG_Text_Format_Converter::Html_to_SimpleText(), CSG_String::is_Empty(), CSG_String::Replace(), SG_SUMMARY_FMT_FLAT, SG_SUMMARY_FMT_HTML, SG_SUMMARY_FMT_XML, SG_T, SG_XML_LIBRARY, SG_XML_LIBRARY_CATEGORY, SG_XML_LIBRARY_NAME, SG_XML_LIBRARY_PATH, SG_XML_TOOL, SG_XML_TOOL_ATT_ID, SG_XML_TOOL_ATT_NAME, SUMMARY_ADD_STR, TLB_INFO_Author, TLB_INFO_Category, and TLB_INFO_Name.

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

◆ Get_Tool() [1/4]

CSG_Tool * CSG_Tool_Library::Get_Tool ( const char * Name,
TSG_Tool_Type Type = TOOL_TYPE_Base ) const
virtual

Definition at line 170 of file tool_library.cpp.

References Get_Tool().

◆ Get_Tool() [2/4]

CSG_Tool * CSG_Tool_Library::Get_Tool ( const CSG_String & Name,
TSG_Tool_Type Type = TOOL_TYPE_Base ) const
virtual

Definition at line 172 of file tool_library.cpp.

References CSG_String::Cmp(), Get_Count(), CSG_Tool::Get_ID(), CSG_Tool::Get_Name(), and Get_Tool().

◆ Get_Tool() [3/4]

CSG_Tool * CSG_Tool_Library::Get_Tool ( const wchar_t * Name,
TSG_Tool_Type Type = TOOL_TYPE_Base ) const
virtual

Definition at line 171 of file tool_library.cpp.

References Get_Tool().

◆ Get_Tool() [4/4]

CSG_Tool * CSG_Tool_Library::Get_Tool ( int Index,
TSG_Tool_Type Type = TOOL_TYPE_Base ) const
virtual

Reimplemented in CSG_Tool_Chains.

Definition at line 162 of file tool_library.cpp.

References Get_Count(), CSG_Tool::Get_Type(), and TOOL_TYPE_Base.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Tool_Chains::Create_Tool(), Get_Menu(), Get_Summary(), Get_Summary(), Get_Tool(), Get_Tool(), Get_Tool(), and CSG_Tool_Library_Manager::Get_Tool().

◆ Get_Type()

virtual ESG_Library_Type CSG_Tool_Library::Get_Type ( void ) const
inlinevirtual

Reimplemented in CSG_Tool_Chains.

Definition at line 110 of file tool_library.h.

References Library.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), and CSG_Tool_Library_Manager::Get_Library().

◆ Get_Version()

const CSG_String & CSG_Tool_Library::Get_Version ( void ) const
inline

Definition at line 121 of file tool_library.h.

References Get_Info(), and TLB_INFO_Version.

◆ is_Valid()

bool CSG_Tool_Library::is_Valid ( void ) const
inline

Definition at line 112 of file tool_library.h.

References Get_Count().

Referenced by CSG_Tool_Library_Manager::Add_Library().

◆ Load_Description()

bool CSG_Tool_Library::Load_Description ( void )

Definition at line 255 of file tool_library.cpp.

References Add_Reference(), CSG_Table::Create(), Del_References(), CSG_Table::Get_Count(), CSG_Tool::Get_Description_Source(), CSG_Table::Get_Field_Count(), CSG_Text_Format_Converter::Html_Absolute_Image_Paths(), m_Library_Name, CSG_Text_Format_Converter::Markdown_to_Html(), CSG_File::Open(), CSG_File::Read(), CSG_Table::Set_Field_Type(), SG_DATATYPE_String, SG_Dir_Exists(), SG_FILE_ENCODING_UTF8, SG_File_Make_Path(), SG_FILE_R, and SG_UI_ProgressAndMsg_Lock().

Referenced by CSG_Tool_Library().

◆ CSG_Tool_Library_Manager

friend class CSG_Tool_Library_Manager
friend

Definition at line 106 of file tool_library.h.

References CSG_Tool_Library_Manager.

Referenced by CSG_Tool_Library_Manager.

Member Data Documentation

◆ m_File_Name

CSG_String CSG_Tool_Library::m_File_Name
protected

Definition at line 162 of file tool_library.h.

Referenced by CSG_Tool_Library(), and Get_File_Name().

◆ m_Library_Name

CSG_String CSG_Tool_Library::m_Library_Name
protected

Definition at line 162 of file tool_library.h.

Referenced by CSG_Tool_Chains::CSG_Tool_Chains(), CSG_Tool_Library(), Get_Library_Name(), and Load_Description().

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