OpenMS  2.8.0
Public Types | Public Attributes | List of all members
ParameterInformation Struct Reference

Struct that captures all information of a command line parameter. More...

#include <OpenMS/APPLICATIONS/ParameterInformation.h>

Collaboration diagram for ParameterInformation:
[legend]

Public Types

enum  ParameterTypes {
  NONE = 0 , STRING , INPUT_FILE , OUTPUT_FILE ,
  OUTPUT_PREFIX , DOUBLE , INT , STRINGLIST ,
  INTLIST , DOUBLELIST , INPUT_FILE_LIST , OUTPUT_FILE_LIST ,
  FLAG , TEXT , NEWLINE
}
 Parameter types. More...
 

Public Attributes

String name
 name of the parameter (internal and external) More...
 
ParameterTypes type
 type of the parameter More...
 
ParamValue 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

StringList valid_strings
 
Int min_int
 
Int max_int
 
double min_float
 
double max_float
 
 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. More...
 
 ParameterInformation ()
 
 ParameterInformation (const ParameterInformation &rhs)=default
 
ParameterInformationoperator= (const ParameterInformation &rhs)
 

Detailed Description

Struct that captures all information of a command line parameter.

Member Enumeration Documentation

◆ 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.

OUTPUT_PREFIX 

String parameter that denotes an output file prefix.

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_.

Constructor & Destructor Documentation

◆ ParameterInformation() [1/3]

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.

◆ ParameterInformation() [2/3]

◆ ParameterInformation() [3/3]

ParameterInformation ( const ParameterInformation rhs)
default

Member Function Documentation

◆ operator=()

ParameterInformation& operator= ( const ParameterInformation rhs)

Member Data Documentation

◆ advanced

bool advanced

flag the indicates that the parameter is advanced (this is used for writing the INI file only)

◆ argument

String argument

argument in the description

◆ default_value

ParamValue default_value

default value of the parameter stored as string

◆ description

String description

description of the parameter

◆ max_float

double max_float

◆ max_int

Int max_int

◆ min_float

double min_float

◆ min_int

Int min_int

◆ name

String name

name of the parameter (internal and external)

◆ required

bool required

flag that indicates if this parameter is required i.e. it must differ from the default value

◆ tags

StringList tags

StringList for special tags.

◆ type

type of the parameter

◆ valid_strings

StringList valid_strings