ParameterInformation Struct Reference

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

#include <OpenMS/APPLICATIONS/TOPPBase.h>

List of all members.

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.
	ParameterInformation ()
ParameterInformation &	operator= (const ParameterInformation &rhs)
Public Attributes
String	name
	name of the parameter (internal and external)
ParameterTypes	type
	type of the parameter
DataValue	default_value
	default value of the parameter stored as string
String	description
	description of the parameter
String	argument
	argument in the description
bool	required
	flag that indicates if this parameter is required i.e. it must differ from the default value
bool	advanced
	flag the indicates that the parameter is advanced (this is used for writing the INI file only)
StringList	tags
	StringList for special tags.
Restrictions for different parameter types
std::vector< String >	valid_strings
Int	min_int
Int	max_int
DoubleReal	min_float
DoubleReal	max_float

---

Detailed Description

Struct that captures all information of a command line parameter.

Note:

had to move this out of the TOPPBase class scope to use it in Param, because foward declaration of nested classes is not possible and there would be a mutual inclusion problem otherwise

---

Member Enumeration Documentation

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

---

Constructor & Destructor Documentation

ParameterInformation	(	const String &	n,
		ParameterTypes	t,
		const String &	arg,
		const DataValue &	def,
		const String &	desc,
		bool	req,
		bool	adv,
		const StringList &	tag_values = StringList()
	)			[inline]

Constructor that takes all members in declaration order.

ParameterInformation

(

)

[inline]

---

Member Function Documentation

ParameterInformation& operator=

(

const ParameterInformation &

rhs

)

[inline]

References ParameterInformation::advanced, ParameterInformation::argument, ParameterInformation::default_value, ParameterInformation::description, ParameterInformation::max_float, ParameterInformation::max_int, ParameterInformation::min_float, ParameterInformation::min_int, ParameterInformation::name, ParameterInformation::required, ParameterInformation::tags, ParameterInformation::type, and ParameterInformation::valid_strings.

---

Member Data Documentation

bool advanced

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

Referenced by ParameterInformation::operator=().

String argument

argument in the description

Referenced by ParameterInformation::operator=().

DataValue default_value

default value of the parameter stored as string

Referenced by ParameterInformation::operator=().

String description

description of the parameter

Referenced by ParameterInformation::operator=().

DoubleReal max_float

Referenced by ParameterInformation::operator=().

Int max_int

Referenced by ParameterInformation::operator=().

DoubleReal min_float

Referenced by ParameterInformation::operator=().

Int min_int

Referenced by ParameterInformation::operator=().

String name

name of the parameter (internal and external)

Referenced by ParameterInformation::operator=().

bool required

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

Referenced by ParameterInformation::operator=().

StringList tags

StringList for special tags.

Referenced by ParameterInformation::operator=().

ParameterTypes type

type of the parameter

Referenced by ParameterInformation::operator=().

std::vector<String> valid_strings

Referenced by ParameterInformation::operator=().