ToolDescription Struct Reference

#include <OpenMS/DATASTRUCTURES/ToolDescription.h>

Inheritance diagram for ToolDescription:
Collaboration diagram for ToolDescription:

Public Member Functions

 ToolDescription ()=default
 default CTor More...
 ToolDescription (const ToolDescription &other)=default
 Copy C'Tor. More...
 ToolDescription (const String &p_name, const String &p_category, const StringList &p_types=StringList())
 C'Tor for internal TOPP tools. More...
ToolDescriptionoperator= (const ToolDescription &rhs)=default
 Copy assignment. More...
void addExternalType (const String &type, const ToolExternalDetails &details)
void append (const ToolDescription &other)
- Public Member Functions inherited from ToolDescriptionInternal
 ToolDescriptionInternal ()=default
 default C'Tor More...
 ToolDescriptionInternal (const bool p_is_internal, const String &p_name, const String &p_category, const StringList &p_types)
 C'Tor with arguments. More...
 ToolDescriptionInternal (const String &p_name, const StringList &p_types)
 short C'Tor More...
ToolDescriptionInternaloperator= (const ToolDescriptionInternal &rhs)=default
 Copy assignment. More...
bool operator== (const ToolDescriptionInternal &rhs) const
bool operator< (const ToolDescriptionInternal &rhs) const

Public Attributes

std::vector< ToolExternalDetailsexternal_details
 additional details for external tools (one entry for each 'type') More...
- Public Attributes inherited from ToolDescriptionInternal
bool is_internal = false
String name
String category
StringList types
 -types of the tool (if any, e.g. ['centroided','wavelet']) More...

Detailed Description

Used for internal and external tools

Constructor & Destructor Documentation

◆ ToolDescription() [1/3]

ToolDescription ( )

default CTor

◆ ToolDescription() [2/3]

ToolDescription ( const ToolDescription other)

Copy C'Tor.

◆ ToolDescription() [3/3]

ToolDescription ( const String p_name,
const String p_category,
const StringList p_types = StringList() 

C'Tor for internal TOPP tools.

Member Function Documentation

◆ addExternalType()

void addExternalType ( const String type,
const ToolExternalDetails details 

◆ append()

void append ( const ToolDescription other)

◆ operator=()

ToolDescription& operator= ( const ToolDescription rhs)

Copy assignment.

Member Data Documentation

◆ external_details

std::vector<ToolExternalDetails> external_details

additional details for external tools (one entry for each 'type')