OpenMS
3.6.0
Main Page
Related Pages
Topics
Namespaces
Concepts
Classes
Files
File List
File Members
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
11
#include <
OpenMS/DATASTRUCTURES/StringUtils.h
>
12
#include <
OpenMS/DATASTRUCTURES/TypeAliases.h
>
13
14
#include <OpenMS/OpenMSConfig.h>
15
16
namespace
OpenMS
17
{
18
namespace
Internal
19
{
29
struct
OPENMS_DLLAPI
ToolDescriptionInternal
30
{
31
std::string
name
;
32
std::string
category
;
33
StringList
types
;
34
36
ToolDescriptionInternal
() =
default
;
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
45
ToolDescriptionInternal
&
operator=
(
const
ToolDescriptionInternal
& rhs) =
default
;
46
47
bool
operator==
(
const
ToolDescriptionInternal
& rhs)
const
;
48
49
bool
operator<
(
const
ToolDescriptionInternal
& rhs)
const
;
50
};
51
55
struct
OPENMS_DLLAPI
ToolDescription
:
56
ToolDescriptionInternal
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
68
ToolDescription
&
operator=
(
const
ToolDescription
& rhs) =
default
;
69
70
};
71
}
// namespace Internal
72
}
// namespace OPENMS
StringUtils.h
TypeAliases.h
OpenMS::StringList
std::vector< std::string > StringList
Vector of String.
Definition
TypeAliases.h:39
OpenMS
Main OpenMS namespace.
Definition
openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19
OpenMS::Internal::ToolDescriptionInternal
What the TOPP tool registry knows about one tool.
Definition
ToolDescription.h:30
OpenMS::Internal::ToolDescriptionInternal::ToolDescriptionInternal
ToolDescriptionInternal(const std::string &p_name, const std::string &p_category, const StringList &p_types)
C'Tor with arguments.
OpenMS::Internal::ToolDescriptionInternal::operator=
ToolDescriptionInternal & operator=(const ToolDescriptionInternal &rhs)=default
Copy assignment.
OpenMS::Internal::ToolDescriptionInternal::ToolDescriptionInternal
ToolDescriptionInternal()=default
default C'Tor
OpenMS::Internal::ToolDescriptionInternal::operator<
bool operator<(const ToolDescriptionInternal &rhs) const
OpenMS::Internal::ToolDescriptionInternal::types
StringList types
-types of the tool
Definition
ToolDescription.h:33
OpenMS::Internal::ToolDescriptionInternal::name
std::string name
Definition
ToolDescription.h:31
OpenMS::Internal::ToolDescriptionInternal::ToolDescriptionInternal
ToolDescriptionInternal(const std::string &p_name, const StringList &p_types)
short C'Tor
OpenMS::Internal::ToolDescriptionInternal::category
std::string category
Definition
ToolDescription.h:32
OpenMS::Internal::ToolDescriptionInternal::operator==
bool operator==(const ToolDescriptionInternal &rhs) const
OpenMS::Internal::ToolDescription
Definition
ToolDescription.h:57
OpenMS::Internal::ToolDescription::ToolDescription
ToolDescription()=default
default CTor
OpenMS::Internal::ToolDescription::operator=
ToolDescription & operator=(const ToolDescription &rhs)=default
Copy assignment.
OpenMS::Internal::ToolDescription::ToolDescription
ToolDescription(const std::string &p_name, const std::string &p_category, const StringList &p_types=StringList())
C'Tor from a registry entry.
OpenMS::Internal::ToolDescription::ToolDescription
ToolDescription(const ToolDescription &other)=default
Copy C'Tor.
OpenMS
DATASTRUCTURES
ToolDescription.h
Generated on Wed Sep 30 2026 02:31:04 for OpenMS by
1.9.8