ToolHandler Class Reference

#include <OpenMS/APPLICATIONS/ToolHandler.h>

Collaboration diagram for ToolHandler:

Static Public Member Functions
static ToolListType	getTOPPToolList ()
	List every official TOPP tool shipped with this OpenMS release, keyed by tool name.
static StringList	getTypes (const std::string &toolname)
	Return the alternative "types" / sub-commands a tool supports, or an empty list if it has none.
static std::string	getCategory (const std::string &toolname)
	Return the KNIME-style category string of a tool.
static std::string	getExternalToolsPath ()
	Resolved file-system path of the external-tool config directory.
static std::string	getInternalToolsPath ()
	Resolved file-system path of the internal-tool config directory (root of the .ttd search).

Static Private Member Functions
static std::vector< Internal::ToolDescription >	getInternalTools_ ()
	Lazily load the internal tool registry from .ttd files under getInternalToolsPath.
static StringList	getInternalToolConfigFiles_ ()
	Enumerate .ttd config file paths under getInternalToolsPath (and its OS-specific subdir)
static void	loadInternalToolConfig_ ()
	Parse the .ttd config files (idempotent — sets tools_internal_loaded_ on success)

Static Private Attributes
static std::vector< Internal::ToolDescription >	tools_internal_
	Cached internal tool registry; populated lazily by loadInternalToolConfig_.
static bool	tools_internal_loaded_
	Whether tools_internal_ has been initialised this run.

Member Function Documentation

getCategory()

static std::string getCategory ( const std::string &  toolname )

static

Return the KNIME-style category string of a tool.

Parameters

[in]

toolname

Name of the TOPP tool to query.

Returns

Category string (e.g. "Quantitation") or an empty string if toolname is unknown.

getExternalToolsPath()

static std::string getExternalToolsPath ( )

static

Resolved file-system path of the external-tool config directory.

Returns

File::getOpenMSDataPath() + "/TOOLS/EXTERNAL".

getInternalToolConfigFiles_()

static StringList getInternalToolConfigFiles_ ( )

staticprivate

Enumerate .ttd config file paths under getInternalToolsPath (and its OS-specific subdir)

getInternalTools_()

static std::vector< Internal::ToolDescription > getInternalTools_ ( )

staticprivate

Lazily load the internal tool registry from .ttd files under getInternalToolsPath.

getInternalToolsPath()

static std::string getInternalToolsPath ( )

static

Resolved file-system path of the internal-tool config directory (root of the .ttd search).

Returns

File::getOpenMSDataPath() + "/TOOLS/INTERNAL".

getTOPPToolList()

static ToolListType getTOPPToolList ( )

static

List every official TOPP tool shipped with this OpenMS release, keyed by tool name.

Includes only the hard-coded "internal" tool registry — external .ttd entries are not merged here. Each value carries the tool's KNIME-style category string (e.g. "Quantitation", "File Converter") used by TOPPAS for grouping.

Returns

Map toolname -> Internal::ToolDescription for every tool.

Referenced by TOPPASBase::createTOPPToolsTreeWidget().

getTypes()

static StringList getTypes ( const std::string &  toolname )

static

Return the alternative "types" / sub-commands a tool supports, or an empty list if it has none.

Most tools have a single behaviour; a small number expose multiple sub-modes via -type (e.g. FeatureFinderCentroided vs. FeatureFinderIsotopeWavelet sharing infrastructure).

Parameters

[in]

toolname

Name of the TOPP tool to query.

Returns

Type names (may be empty); empty also when the tool is unknown.

Referenced by TOPPASBase::createTOPPToolsTreeWidget().

loadInternalToolConfig_()

static void loadInternalToolConfig_ ( )

staticprivate

Parse the .ttd config files (idempotent — sets tools_internal_loaded_ on success)

Member Data Documentation

tools_internal_

std::vector<Internal::ToolDescription> tools_internal_

staticprivate

Cached internal tool registry; populated lazily by loadInternalToolConfig_.

tools_internal_loaded_

bool tools_internal_loaded_

staticprivate

Whether tools_internal_ has been initialised this run.