Parameter entry used to store the actual information inside of a Param entry. More...
#include <OpenMS/DATASTRUCTURES/Param.h>
Public Member Functions | |
| ParamEntry () | |
| Default constructor. More... | |
| ParamEntry (const String &n, const DataValue &v, const String &d, const StringList &t=StringList()) | |
| Constructor with name, description, value and advanced flag. More... | |
| ParamEntry (const ParamEntry &other) | |
| Copy constructor. More... | |
| ~ParamEntry () | |
| Destructor. More... | |
| bool | isValid (String &message) const |
| Check if 'value' fulfills restrictions. More... | |
| bool | operator== (const ParamEntry &rhs) const |
| Equality operator (only name and value are compared) More... | |
Public Attributes | |
| String | name |
| Name of the entry. More... | |
| String | description |
| Description of the entry. More... | |
| DataValue | value |
| Value associated with the entry. More... | |
| std::set< String > | tags |
| Tags list, used e.g. for advanced parameter tag. More... | |
Restrictions to accepted values (used in checkDefaults) | |
| DoubleReal | min_float |
| Default: - std::numeric_limits<DoubleReal>::max() More... | |
| DoubleReal | max_float |
| Default: std::numeric_limits<DoubleReal>::max() More... | |
| Int | min_int |
| Default: - std::numeric_limits<Int>::max() More... | |
| Int | max_int |
| Default: std::numeric_limits<Int>::max() More... | |
| std::vector< String > | valid_strings |
| Default: empty. More... | |
Parameter entry used to store the actual information inside of a Param entry.
| ParamEntry | ( | ) |
Default constructor.
| ParamEntry | ( | const String & | n, |
| const DataValue & | v, | ||
| const String & | d, | ||
| const StringList & | t = StringList() |
||
| ) |
Constructor with name, description, value and advanced flag.
| ParamEntry | ( | const ParamEntry & | other | ) |
Copy constructor.
| ~ParamEntry | ( | ) |
Destructor.
| bool isValid | ( | String & | message | ) | const |
Check if 'value' fulfills restrictions.
| bool operator== | ( | const ParamEntry & | rhs | ) | const |
Equality operator (only name and value are compared)
| String description |
Description of the entry.
| DoubleReal max_float |
Default: std::numeric_limits<DoubleReal>::max()
| Int max_int |
Default: std::numeric_limits<Int>::max()
| DoubleReal min_float |
Default: - std::numeric_limits<DoubleReal>::max()
| Int min_int |
Default: - std::numeric_limits<Int>::max()
| String name |
Name of the entry.
| std::set<String> tags |
Tags list, used e.g. for advanced parameter tag.
| std::vector<String> valid_strings |
Default: empty.
| DataValue value |
Value associated with the entry.
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:29 using doxygen 1.8.5 |