#include <tool_library.h>

Inheritance diagram for CSG_Tool_Library:

Public Member Functions
virtual TSG_Tool_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)

virtual CSG_Tool *	Create_Tool (const CSG_String &Name, bool bWithGUI=false)

virtual CSG_Tool *	Create_Tool (const char *Name, bool bWithGUI=false)

virtual CSG_Tool *	Create_Tool (const wchar_t *Name, bool bWithGUI=false)

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 106 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`
	)

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`
	)

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`
	)

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`
	)

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 Create_Tool(), and CSG_Tool_Library_Manager::Create_Tool().