OpenMS
ToolHandler Class Reference

#include <OpenMS/APPLICATIONS/ToolHandler.h>

Collaboration diagram for ToolHandler:
[legend]

Static Public Member Functions

static ToolListType getTOPPToolList (const bool includeGenericWrapper=false)
 Returns the list of official TOPP tools contained in the OpenMS/TOPP release. More...
 
static ToolListType getUtilList ()
 Returns the list of official UTIL tools contained in the OpenMS/TOPP release. More...
 
static StringList getTypes (const String &toolname)
 get all types of a tool (empty if none) More...
 
static bool checkDuplicated (const String &toolname)
 
static String getCategory (const String &toolname)
 
static String getExternalToolsPath ()
 get getOpenMSDataPath() + "/TOOLS/EXTERNAL" More...
 
static String getInternalToolsPath ()
 get File::getOpenMSDataPath() + "/TOOLS/INTERNAL" More...
 

Static Private Member Functions

static Internal::ToolDescription getExternalTools_ ()
 
static QStringList getExternalToolConfigFiles_ ()
 
static void loadExternalToolConfig_ ()
 
static std::vector< Internal::ToolDescriptiongetInternalTools_ ()
 
static QStringList getInternalToolConfigFiles_ ()
 
static void loadInternalToolConfig_ ()
 

Static Private Attributes

static Internal::ToolDescription tools_external_
 
static bool tools_external_loaded_
 
static std::vector< Internal::ToolDescriptiontools_internal_
 
static bool tools_internal_loaded_
 

Member Function Documentation

◆ checkDuplicated()

static bool checkDuplicated ( const String toolname)
static

Returns if tool is duplicated (in TOPP and UTILS category)

Returns
true if duplicated

◆ getCategory()

static String getCategory ( const String toolname)
static

Returns the category string from TOPP or UTIL tools

Returns
empty string if tool was not found

◆ getExternalToolConfigFiles_()

static QStringList getExternalToolConfigFiles_ ( )
staticprivate

◆ getExternalTools_()

static Internal::ToolDescription getExternalTools_ ( )
staticprivate

◆ getExternalToolsPath()

static String getExternalToolsPath ( )
static

get getOpenMSDataPath() + "/TOOLS/EXTERNAL"

◆ getInternalToolConfigFiles_()

static QStringList getInternalToolConfigFiles_ ( )
staticprivate

◆ getInternalTools_()

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

◆ getInternalToolsPath()

static String getInternalToolsPath ( )
static

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

◆ getTOPPToolList()

static ToolListType getTOPPToolList ( const bool  includeGenericWrapper = false)
static

Returns the list of official TOPP tools contained in the OpenMS/TOPP release.

Referenced by TOPPASBase::createTOPPToolsTreeWidget().

◆ getTypes()

static StringList getTypes ( const String toolname)
static

get all types of a tool (empty if none)

Referenced by TOPPASBase::createTOPPToolsTreeWidget().

◆ getUtilList()

static ToolListType getUtilList ( )
static

Returns the list of official UTIL tools contained in the OpenMS/TOPP release.

Referenced by TOPPASBase::createTOPPToolsTreeWidget().

◆ loadExternalToolConfig_()

static void loadExternalToolConfig_ ( )
staticprivate

◆ loadInternalToolConfig_()

static void loadInternalToolConfig_ ( )
staticprivate

Member Data Documentation

◆ tools_external_

Internal::ToolDescription tools_external_
staticprivate

◆ tools_external_loaded_

bool tools_external_loaded_
staticprivate

◆ tools_internal_

std::vector<Internal::ToolDescription> tools_internal_
staticprivate

◆ tools_internal_loaded_

bool tools_internal_loaded_
staticprivate