Struct that captures all information of a command line parameter. More...
#include <OpenMS/APPLICATIONS/ParameterInformation.h>
Public Types | |
enum | ParameterTypes { NONE = 0, STRING, INPUT_FILE, OUTPUT_FILE, DOUBLE, INT, STRINGLIST, INTLIST, DOUBLELIST, INPUT_FILE_LIST, OUTPUT_FILE_LIST, FLAG, TEXT, NEWLINE } |
Parameter types. More... | |
Public Member Functions | |
ParameterInformation (const String &n, ParameterTypes t, const String &arg, const DataValue &def, const String &desc, bool req, bool adv, const StringList &tag_values=StringList()) | |
Constructor that takes all members in declaration order. More... | |
ParameterInformation () | |
ParameterInformation & | operator= (const ParameterInformation &rhs) |
Public Attributes | |
String | name |
name of the parameter (internal and external) More... | |
ParameterTypes | type |
type of the parameter More... | |
DataValue | default_value |
default value of the parameter stored as string More... | |
String | description |
description of the parameter More... | |
String | argument |
argument in the description More... | |
bool | required |
flag that indicates if this parameter is required i.e. it must differ from the default value More... | |
bool | advanced |
flag the indicates that the parameter is advanced (this is used for writing the INI file only) More... | |
StringList | tags |
StringList for special tags. More... | |
Restrictions for different parameter types | |
std::vector< String > | valid_strings |
Int | min_int |
Int | max_int |
double | min_float |
double | max_float |
Struct that captures all information of a command line parameter.
enum ParameterTypes |
Parameter types.
Enumerator | |
---|---|
NONE | Undefined type. |
STRING | String parameter. |
INPUT_FILE | String parameter that denotes an input file. |
OUTPUT_FILE | String parameter that denotes an output file. |
DOUBLE | Floating point number parameter. |
INT | Integer parameter. |
STRINGLIST | More than one String Parameter. |
INTLIST | More than one Integer Parameter. |
DOUBLELIST | More than one String Parameter. |
INPUT_FILE_LIST | More than one String Parameter that denotes input files. |
OUTPUT_FILE_LIST | More than one String Parameter that denotes output files. |
FLAG | Parameter without argument. |
TEXT | Left aligned text, see addText_. |
NEWLINE | An empty line, see addEmptyLine_. |
ParameterInformation | ( | const String & | n, |
ParameterTypes | t, | ||
const String & | arg, | ||
const DataValue & | def, | ||
const String & | desc, | ||
bool | req, | ||
bool | adv, | ||
const StringList & | tag_values = StringList() |
||
) |
Constructor that takes all members in declaration order.
ParameterInformation& operator= | ( | const ParameterInformation & | rhs | ) |
bool advanced |
flag the indicates that the parameter is advanced (this is used for writing the INI file only)
String argument |
argument in the description
DataValue default_value |
default value of the parameter stored as string
String description |
description of the parameter
double max_float |
Int max_int |
double min_float |
Int min_int |
String name |
name of the parameter (internal and external)
bool required |
flag that indicates if this parameter is required i.e. it must differ from the default value
StringList tags |
StringList for special tags.
ParameterTypes type |
type of the parameter
std::vector<String> valid_strings |
OpenMS / TOPP release 2.3.0 | Documentation generated on Tue Jan 9 2018 18:22:11 using doxygen 1.8.13 |