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

Param::ParamEntry Struct Reference

#include <OpenMS/DATASTRUCTURES/Param.h>

List of all members.


Detailed Description

Parameter entry used to store the actual information inside of a Param entry.

Public Member Functions

 ParamEntry ()
 Default constructor.
 ParamEntry (const String &n, const DataValue &v, const String &d, bool a)
 Constructor with name, description, value and advanced flag.
bool operator== (const ParamEntry &rhs) const
 Equality operator (only name and value are compared).

Public Attributes

String name
 Name of the entry.
String description
 Description of the entry.
DataValue value
 Value associated with the entry.
bool advanced
 Advanced parameter flag (If 'true' it is only shown in advanced mode).
Restrictions to accepted values (used in checkDefaults)
DoubleReal min_float
 Default: -stdnumeric_limits<DoubleReal>::max().
DoubleReal max_float
 Default: std::numeric_limits<DoubleReal>::max().
Int min_int
 Default: -stdnumeric_limits<Int>::max().
Int max_int
 Default: std::numeric_limits<Int>::max().
std::vector< Stringvalid_strings
 Default: empty.

Constructor & Destructor Documentation

ParamEntry (  ) 

Default constructor.

ParamEntry ( const String n,
const DataValue v,
const String d,
bool  a 
)

Constructor with name, description, value and advanced flag.


Member Function Documentation

bool operator== ( const ParamEntry rhs  )  const

Equality operator (only name and value are compared).


Member Data Documentation

String name

Name of the entry.

String description

Description of the entry.

DataValue value

Value associated with the entry.

bool advanced

Advanced parameter flag (If 'true' it is only shown in advanced mode).

DoubleReal min_float

Default: -stdnumeric_limits<DoubleReal>::max().

DoubleReal max_float

Default: std::numeric_limits<DoubleReal>::max().

Int min_int

Default: -stdnumeric_limits<Int>::max().

Int max_int

Default: std::numeric_limits<Int>::max().

std::vector<String> valid_strings

Default: empty.


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