SAGA API  v9.6
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
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
 
virtual CSG_String Get_Info (int Type) const
 
CSG_String Get_Name (void) const
 
CSG_String Get_Description (void) const
 
CSG_String Get_Author (void) const
 
CSG_String Get_Version (void) const
 
CSG_String Get_Menu (void) 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
 
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)
 
void Del_References (void)
 
const CSG_Strings & Get_References (void) const
 

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 CSG_Tool_Library_Interface::Get_Count(), CSG_Tool_Library_Interface::Get_Info(), m_File_Name, m_Library_Name, SG_File_Get_Path_Absolute(), SYMBOL_TLB_Finalize, SYMBOL_TLB_Get_Interface, SYMBOL_TLB_Initialize, TLB_INFO_File, and TLB_INFO_Library.

◆ ~CSG_Tool_Library()

CSG_Tool_Library::~CSG_Tool_Library ( void  )
protectedvirtual

Definition at line 100 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 &  Year,
const CSG_String &  Title,
const CSG_String &  Where,
const SG_Char *  Link = NULL,
const SG_Char *  Link_Text = NULL 
)

Definition at line 242 of file tool_library.cpp.

References CSG_String::c_str(), CSG_String::Format(), CSG_String::is_Empty(), CSG_String::Printf(), and CSG_Strings::Sort().

◆ Add_Reference() [2/2]

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

Definition at line 262 of file tool_library.cpp.

References CSG_String::c_str(), CSG_String::Format(), and CSG_Strings::Sort().

◆ Create_Tool() [1/4]

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

Definition at line 196 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 198 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 197 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 190 of file tool_library.cpp.

References CSG_Tool_Library_Interface::Create_Tool().

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

◆ Del_References()

void CSG_Tool_Library::Del_References ( void  )

Definition at line 270 of file tool_library.cpp.

References CSG_Strings::Clear().

◆ 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 209 of file tool_library.cpp.

References CSG_Tool_Library_Interface::Delete_Tool().

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

◆ Delete_Tools()

bool CSG_Tool_Library::Delete_Tools ( void  )
virtual

Reimplemented in CSG_Tool_Chains.

Definition at line 215 of file tool_library.cpp.

References CSG_Tool_Library_Interface::Delete_Tools().

◆ Get_Author()

CSG_String CSG_Tool_Library::Get_Author ( void  ) const
inline

Definition at line 120 of file tool_library.h.

References TLB_INFO_Author.

◆ Get_Category()

CSG_String CSG_Tool_Library::Get_Category ( void  ) const
inline

Definition at line 123 of file tool_library.h.

References 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(), CSG_Tool_Chains::Get_File_Name(), CSG_Tool_Library_Manager::Get_Summary(), Get_Summary(), Get_Tool(), and CSG_Tool_Library_Manager::Get_Tool_Count().

◆ Get_Description()

CSG_String CSG_Tool_Library::Get_Description ( void  ) const
inline

Definition at line 119 of file tool_library.h.

References TLB_INFO_Description.

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox().

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

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

◆ Get_Info()

CSG_String CSG_Tool_Library::Get_Info ( int  Type) const
virtual

Reimplemented in CSG_Tool_Chains.

Definition at line 133 of file tool_library.cpp.

References CSG_Tool_Library_Interface::Get_Info().

Referenced by Get_Summary().

◆ Get_Library_Name()

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

Definition at line 115 of file tool_library.h.

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

◆ Get_Menu() [1/2]

CSG_String CSG_Tool_Library::Get_Menu ( int  i) const
virtual

Definition at line 226 of file tool_library.cpp.

References Get_Tool().

◆ Get_Menu() [2/2]

CSG_String CSG_Tool_Library::Get_Menu ( void  ) const
inline

Definition at line 122 of file tool_library.h.

References TLB_INFO_Menu_Path.

◆ Get_Name()

CSG_String CSG_Tool_Library::Get_Name ( void  ) const
inline

Definition at line 118 of file tool_library.h.

References TLB_INFO_Name.

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

◆ Get_References()

const CSG_Strings& CSG_Tool_Library::Get_References ( void  ) const
inline

Definition at line 149 of file tool_library.h.

Referenced by Get_Summary().

◆ Get_Summary() [1/2]

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

Definition at line 763 of file tool_summary.cpp.

References Get_Count(), Get_Library_Name(), CSG_Tool::Get_Summary(), Get_Summary(), Get_Tool(), CSG_File::Open(), 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 621 of file tool_summary.cpp.

References _TL, CSG_String::c_str(), CSG_String::Format(), CSG_Strings::Get_Count(), Get_Count(), Get_File_Name(), CSG_Tool::Get_ID(), Get_Info(), Get_Library_Name(), CSG_Tool::Get_Name(), Get_Name(), Get_References(), Get_Tool(), CSG_String::is_Empty(), CSG_Tool::needs_GUI(), CSG_String::Replace(), SG_HTML_Tag_Replacer(), 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, TLB_INFO_Description, 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 157 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 159 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 158 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 149 of file tool_library.cpp.

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

Referenced by CSG_Tool_Library_Manager::Create_Python_ToolBox(), Get_Menu(), Get_Summary(), 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.

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

◆ Get_Version()

CSG_String CSG_Tool_Library::Get_Version ( void  ) const
inline

Definition at line 121 of file tool_library.h.

References TLB_INFO_Version.

◆ is_Valid()

bool CSG_Tool_Library::is_Valid ( void  ) const
inline

Definition at line 112 of file tool_library.h.

References CSG_Tool_Library_Manager::Get_Count().

Referenced by CSG_Tool_Library_Manager::Add_Library().

Friends And Related Function Documentation

◆ CSG_Tool_Library_Manager

friend class CSG_Tool_Library_Manager
friend

Definition at line 106 of file tool_library.h.

Member Data Documentation

◆ m_File_Name

CSG_String CSG_Tool_Library::m_File_Name
protected

Definition at line 159 of file tool_library.h.

Referenced by CSG_Tool_Library().

◆ m_Library_Name

CSG_String CSG_Tool_Library::m_Library_Name
protected

Definition at line 159 of file tool_library.h.

Referenced by CSG_Tool_Library().

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