OpenMS
ParameterInformation.h
Go to the documentation of this file.
1 // Copyright (c) 2002-present, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: Marc Sturm, Clemens Groepl $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
14 
15 namespace OpenMS
16 {
17 
21  struct OPENMS_DLLAPI ParameterInformation
22  {
25  {
26  NONE = 0,
32  INT,
38  FLAG,
39  TEXT,
40  NEWLINE
41  };
42 
54  bool required;
56  bool advanced;
59 
61 
65  double min_float;
66  double max_float;
68 
70  ParameterInformation(const String& n, ParameterTypes t, const String& arg, const ParamValue& def, const String& desc, bool req, bool adv, const StringList& tag_values = StringList());
71 
73 
75 
77 
78  };
79 
80 } // namespace
81 
Class to hold strings, numeric values, vectors of strings and vectors of numeric values using the stl...
Definition: ParamValue.h:29
A more convenient string class.
Definition: String.h:34
int Int
Signed integer type.
Definition: Types.h:72
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:44
Main OpenMS namespace.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19
Struct that captures all information of a command line parameter.
Definition: ParameterInformation.h:22
ParameterTypes type
type of the parameter
Definition: ParameterInformation.h:46
String argument
argument in the description
Definition: ParameterInformation.h:52
ParamValue default_value
default value of the parameter stored as string
Definition: ParameterInformation.h:48
double max_float
Definition: ParameterInformation.h:66
ParameterInformation(const ParameterInformation &rhs)=default
StringList tags
StringList for special tags.
Definition: ParameterInformation.h:58
String description
description of the parameter
Definition: ParameterInformation.h:50
bool required
flag that indicates if this parameter is required i.e. it must differ from the default value
Definition: ParameterInformation.h:54
double min_float
Definition: ParameterInformation.h:65
ParameterInformation & operator=(const ParameterInformation &rhs)
String name
name of the parameter (internal and external)
Definition: ParameterInformation.h:44
Int min_int
Definition: ParameterInformation.h:63
bool advanced
flag the indicates that the parameter is advanced (this is used for writing the INI file only)
Definition: ParameterInformation.h:56
StringList valid_strings
Definition: ParameterInformation.h:62
ParameterTypes
Parameter types.
Definition: ParameterInformation.h:25
@ INTLIST
More than one Integer Parameter.
Definition: ParameterInformation.h:34
@ OUTPUT_PREFIX
String parameter that denotes an output file prefix.
Definition: ParameterInformation.h:30
@ OUTPUT_FILE
String parameter that denotes an output file.
Definition: ParameterInformation.h:29
@ DOUBLE
Floating point number parameter.
Definition: ParameterInformation.h:31
@ FLAG
Parameter without argument.
Definition: ParameterInformation.h:38
@ OUTPUT_FILE_LIST
More than one String Parameter that denotes output files.
Definition: ParameterInformation.h:37
@ INPUT_FILE
String parameter that denotes an input file.
Definition: ParameterInformation.h:28
@ TEXT
Left aligned text, see addText_.
Definition: ParameterInformation.h:39
@ STRINGLIST
More than one String Parameter.
Definition: ParameterInformation.h:33
@ STRING
String parameter.
Definition: ParameterInformation.h:27
@ INPUT_FILE_LIST
More than one String Parameter that denotes input files.
Definition: ParameterInformation.h:36
@ DOUBLELIST
More than one String Parameter.
Definition: ParameterInformation.h:35
@ INT
Integer parameter.
Definition: ParameterInformation.h:32
ParameterInformation(const String &n, ParameterTypes t, const String &arg, const ParamValue &def, const String &desc, bool req, bool adv, const StringList &tag_values=StringList())
Constructor that takes all members in declaration order.
Int max_int
Definition: ParameterInformation.h:64