OpenMS
Loading...
Searching...
No Matches
ToolDescription.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, Mathias Walzer $
7// --------------------------------------------------------------------------
8
9#pragma once
10
13
14#include <OpenMS/OpenMSConfig.h>
15
16namespace OpenMS
17{
18 namespace Internal
19 {
29 struct OPENMS_DLLAPI ToolDescriptionInternal
30 {
31 std::string name;
32 std::string category;
34
37
39 ToolDescriptionInternal(const std::string& p_name, const std::string& p_category, const StringList& p_types);
40
42 ToolDescriptionInternal(const std::string& p_name, const StringList& p_types);
43
46
47 bool operator==(const ToolDescriptionInternal& rhs) const;
48
49 bool operator<(const ToolDescriptionInternal& rhs) const;
50 };
51
55 struct OPENMS_DLLAPI ToolDescription :
57 {
59 ToolDescription() = default;
60
62 ToolDescription(const ToolDescription& other) = default;
63
65 ToolDescription(const std::string& p_name, const std::string& p_category, const StringList& p_types = StringList());
66
69
70 };
71 } // namespace Internal
72} // namespace OPENMS
std::vector< std::string > StringList
Vector of String.
Definition TypeAliases.h:39
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19
What the TOPP tool registry knows about one tool.
Definition ToolDescription.h:30
ToolDescriptionInternal(const std::string &p_name, const std::string &p_category, const StringList &p_types)
C'Tor with arguments.
ToolDescriptionInternal & operator=(const ToolDescriptionInternal &rhs)=default
Copy assignment.
ToolDescriptionInternal()=default
default C'Tor
bool operator<(const ToolDescriptionInternal &rhs) const
StringList types
-types of the tool
Definition ToolDescription.h:33
std::string name
Definition ToolDescription.h:31
ToolDescriptionInternal(const std::string &p_name, const StringList &p_types)
short C'Tor
std::string category
Definition ToolDescription.h:32
bool operator==(const ToolDescriptionInternal &rhs) const
Definition ToolDescription.h:57
ToolDescription()=default
default CTor
ToolDescription & operator=(const ToolDescription &rhs)=default
Copy assignment.
ToolDescription(const std::string &p_name, const std::string &p_category, const StringList &p_types=StringList())
C'Tor from a registry entry.
ToolDescription(const ToolDescription &other)=default
Copy C'Tor.