OpenMS
Loading...
Searching...
No Matches
ToolDescriptionInternal Struct Reference

What the TOPP tool registry knows about one tool. More...

#include <OpenMS/DATASTRUCTURES/ToolDescription.h>

Inheritance diagram for ToolDescriptionInternal:
ToolDescription

Public Member Functions

 ToolDescriptionInternal ()=default
 default C'Tor
 
 ToolDescriptionInternal (const std::string &p_name, const std::string &p_category, const StringList &p_types)
 C'Tor with arguments.
 
 ToolDescriptionInternal (const std::string &p_name, const StringList &p_types)
 short C'Tor
 
ToolDescriptionInternal & operator= (const ToolDescriptionInternal &rhs)=default
 Copy assignment.
 
bool operator== (const ToolDescriptionInternal &rhs) const
 
bool operator< (const ToolDescriptionInternal &rhs) const
 

Public Attributes

std::string name
 
std::string category
 
StringList types
 -types of the tool
 

Detailed Description

What the TOPP tool registry knows about one tool.

The name ToolHandler looks it up by, the category TOPPAS groups it under, and the -type sub-modes it offers. Everything else about a tool comes from the tool's own binary (-write_ctd), not from here.

Constructor & Destructor Documentation

◆ ToolDescriptionInternal() [1/3]

default C'Tor

◆ ToolDescriptionInternal() [2/3]

ToolDescriptionInternal ( const std::string &  p_name,
const std::string &  p_category,
const StringList &  p_types 
)

C'Tor with arguments.

◆ ToolDescriptionInternal() [3/3]

ToolDescriptionInternal ( const std::string &  p_name,
const StringList &  p_types 
)

short C'Tor

Member Function Documentation

◆ operator<()

bool operator< ( const ToolDescriptionInternal &  rhs) const

◆ operator=()

ToolDescriptionInternal & operator= ( const ToolDescriptionInternal &  rhs)
default

Copy assignment.

◆ operator==()

bool operator== ( const ToolDescriptionInternal &  rhs) const

Member Data Documentation

◆ category

std::string category

◆ name

std::string name

◆ types

StringList types

-types of the tool