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
11#include <OpenMS/APPLICATIONS/OpenMS_CLIConfig.h>
12
16
17#include <map>
18
19
20namespace OpenMS
21{
23 typedef std::map<std::string, Internal::ToolDescription> ToolListType;
24
63 class OPENMS_CLI_DLLAPI ToolHandler
64 {
65public:
66
81
91
102 static StringList getTypes(const std::string& toolname);
103
110 static std::string getCategory(const std::string& toolname);
111
116 static std::string getToolRegistryPath();
117
118private:
119
123
129 };
130
131} // namespace OpenMS
Registry of TOPP tools and their TOPPAS categories.
Definition ToolHandler.h:64
static std::string getCategory(const std::string &toolname)
Return the category string of a tool.
static ToolListType getTOPPToolList()
List every TOPP tool enabled in this build, keyed by tool name.
static const ToolListType & getTOPPToolListRef()
The registry of getTOPPToolList without copying it.
static ToolListType loadRegistry_()
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 StringList getToolRegistryFiles_()
static std::string getToolRegistryPath()
Resolved file-system path of the tool registry directory (root of the .tsv search).
std::vector< std::string > StringList
Vector of String.
Definition TypeAliases.h:39
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19
std::map< std::string, Internal::ToolDescription > ToolListType
Map: TOPP tool name -> its Internal::ToolDescription (category + per-type configuration).
Definition ToolHandler.h:23