OpenMS
Loading...
Searching...
No Matches
ToolHandler.h
Go to the documentation of this file.
1// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
2// SPDX-License-Identifier: BSD-3-Clause
3//
4// --------------------------------------------------------------------------
5// $Maintainer: Chris Bielow $
6// $Authors: Chris Bielow $
7// --------------------------------------------------------------------------
8
9#pragma once
10
14
15#include <map>
16
17
18namespace OpenMS
19{
50 typedef std::map<std::string, Internal::ToolDescription> ToolListType;
51
52 class OPENMS_DLLAPI ToolHandler
53 {
54public:
55
66
76 static StringList getTypes(const std::string& toolname);
77
84 static std::string getCategory(const std::string& toolname);
85
90 static std::string getExternalToolsPath();
91
96 static std::string getInternalToolsPath();
97
98private:
99
101 static std::vector<Internal::ToolDescription> getInternalTools_();
102
105
108
110 static std::vector<Internal::ToolDescription> tools_internal_;
111
114 };
115
116} // namespace OpenMS
Definition ToolHandler.h:53
static std::string getCategory(const std::string &toolname)
Return the KNIME-style category string of a tool.
static StringList getInternalToolConfigFiles_()
Enumerate .ttd config file paths under getInternalToolsPath (and its OS-specific subdir)
static ToolListType getTOPPToolList()
List every official TOPP tool shipped with this OpenMS release, keyed by tool name.
static bool tools_internal_loaded_
Whether tools_internal_ has been initialised this run.
Definition ToolHandler.h:113
static std::vector< Internal::ToolDescription > tools_internal_
Cached internal tool registry; populated lazily by loadInternalToolConfig_.
Definition ToolHandler.h:110
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 getInternalToolsPath()
Resolved file-system path of the internal-tool config directory (root of the .ttd search).
static std::string getExternalToolsPath()
Resolved file-system path of the external-tool config directory.
static std::vector< Internal::ToolDescription > getInternalTools_()
Lazily load the internal tool registry from .ttd files under getInternalToolsPath.
static void loadInternalToolConfig_()
Parse the .ttd config files (idempotent — sets tools_internal_loaded_ on success)
std::vector< std::string > StringList
Vector of String.
Definition ListUtils.h:44
std::map< std::string, Internal::ToolDescription > ToolListType
Registry of TOPP tools and their (TOPPAS / KNIME) categories.
Definition ToolHandler.h:50
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19