| OpenMS 2.5.0

ParameterInformation.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2020.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Marc Sturm, Clemens Groepl $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/DATASTRUCTURES/String.h>
38 #include <OpenMS/DATASTRUCTURES/StringListUtils.h>
39 #include <OpenMS/DATASTRUCTURES/DataValue.h>
40
41 namespace OpenMS
42 {
43
47 struct OPENMS_DLLAPI ParameterInformation
48 {
50 enum ParameterTypes
51 {
52 NONE = 0,
53 STRING,
54 INPUT_FILE,
55 OUTPUT_FILE,
56 DOUBLE,
57 INT,
58 STRINGLIST,
59 INTLIST,
60 DOUBLELIST,
61 INPUT_FILE_LIST,
62 OUTPUT_FILE_LIST,
63 FLAG,
64 TEXT,
65 NEWLINE
66 };
67
69 String name;
71 ParameterTypes type;
73 DataValue default_value;
75 String description;
77 String argument;
79 bool required;
81 bool advanced;
83 StringList tags;
84
86
87 std::vector<String> valid_strings;
88 Int min_int;
89 Int max_int;
90 double min_float;
91 double max_float;
93
95 ParameterInformation(const String& n, ParameterTypes t, const String& arg, const DataValue& def, const String& desc, bool req, bool adv, const StringList& tag_values = StringList());
96
97 ParameterInformation();
98
99 ParameterInformation& operator=(const ParameterInformation& rhs);
100
101 };
102
103 } // namespace
104
OpenMS::ParameterInformation::valid_strings
std::vector< String > valid_strings
Definition: ParameterInformation.h:87
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::DataValue
Class to hold strings, numeric values, lists of strings and lists of numeric values.
Definition: DataValue.h:56
OpenMS::ParameterInformation::description
String description
description of the parameter
Definition: ParameterInformation.h:75
OpenMS::ParameterInformation::INPUT_FILE
String parameter that denotes an input file.
Definition: ParameterInformation.h:54
OpenMS::ParameterInformation::default_value
DataValue default_value
default value of the parameter stored as string
Definition: ParameterInformation.h:73
OpenMS::ParameterInformation::INT
Integer parameter.
Definition: ParameterInformation.h:57
OpenMS::ParameterInformation::DOUBLE
Floating point number parameter.
Definition: ParameterInformation.h:56
OpenMS::ParameterInformation::required
bool required
flag that indicates if this parameter is required i.e. it must differ from the default value ...
Definition: ParameterInformation.h:79
OpenMS::ParameterInformation::argument
String argument
argument in the description
Definition: ParameterInformation.h:77
OpenMS::ParameterInformation::OUTPUT_FILE_LIST
More than one String Parameter that denotes output files.
Definition: ParameterInformation.h:62
OpenMS::ParameterInformation::ParameterTypes
ParameterTypes
Parameter types.
Definition: ParameterInformation.h:50
OpenMS::ParameterInformation::max_int
Int max_int
Definition: ParameterInformation.h:89
OpenMS::ParameterInformation
Struct that captures all information of a command line parameter.
Definition: ParameterInformation.h:47
OpenMS::ParameterInformation::INTLIST
More than one Integer Parameter.
Definition: ParameterInformation.h:59
OpenMS::ParameterInformation::max_float
double max_float
Definition: ParameterInformation.h:91
OpenMS::ParameterInformation::INPUT_FILE_LIST
More than one String Parameter that denotes input files.
Definition: ParameterInformation.h:61
StringListUtils.h
OpenMS::ParameterInformation::STRING
String parameter.
Definition: ParameterInformation.h:53
String.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::ParameterInformation::STRINGLIST
More than one String Parameter.
Definition: ParameterInformation.h:58
OpenMS::ParameterInformation::min_int
Int min_int
Definition: ParameterInformation.h:88
OpenMS::ParameterInformation::FLAG
Parameter without argument.
Definition: ParameterInformation.h:63
OpenMS::ParameterInformation::name
String name
name of the parameter (internal and external)
Definition: ParameterInformation.h:69
OpenMS::ParameterInformation::min_float
double min_float
Definition: ParameterInformation.h:90
OpenMS::ParameterInformation::advanced
bool advanced
flag the indicates that the parameter is advanced (this is used for writing the INI file only) ...
Definition: ParameterInformation.h:81
OpenMS::ParameterInformation::DOUBLELIST
More than one String Parameter.
Definition: ParameterInformation.h:60
OpenMS::StringList
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
int
OpenMS::ParameterInformation::tags
StringList tags
StringList for special tags.
Definition: ParameterInformation.h:83
OpenMS::ParameterInformation::TEXT
Left aligned text, see addText_.
Definition: ParameterInformation.h:64
DataValue.h
OpenMS::ParameterInformation::OUTPUT_FILE
String parameter that denotes an output file.
Definition: ParameterInformation.h:55
OpenMS::ParameterInformation::type
ParameterTypes type
type of the parameter
Definition: ParameterInformation.h:71