Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

TOPPBase::ParameterInformation Struct Reference

#include <OpenMS/APPLICATIONS/TOPPBase.h>

List of all members.


Detailed Description

Stuct that captures all information of a parameter.

Public Types

enum  ParameterTypes {
  NONE = 0, STRING, INPUT_FILE, OUTPUT_FILE,
  DOUBLE, INT, FLAG, TEXT,
  NEWLINE
}
 Parameter types. More...

Public Member Functions

 ParameterInformation (const String &n, ParameterTypes t, const String &arg, const String &def, const String &desc, bool req)
 Constructor that takes all members in declaration order.
 ParameterInformation ()
ParameterInformationoperator= (const ParameterInformation &rhs)

Public Attributes

String name
 name of the parameter (internal and external)
ParameterTypes type
 type of the parameter
String 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
Restrictions for different parameter types
std::vector< Stringvalid_strings
Int min_int
Int max_int
DoubleReal min_float
DoubleReal max_float

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.
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 String def,
const String desc,
bool  req 
) [inline]

Constructor that takes all members in declaration order.

ParameterInformation (  )  [inline]


Member Function Documentation

ParameterInformation& operator= ( const ParameterInformation rhs  )  [inline]


Member Data Documentation

String name

name of the parameter (internal and external)

ParameterTypes type

type of the parameter

String 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

std::vector<String> valid_strings

Int min_int

Int max_int

DoubleReal min_float

DoubleReal max_float


The documentation for this struct was generated from the following file:
Generated Tue Apr 1 15:36:42 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1