Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Public Attributes | List of all members
Param::ParamEntry Struct Reference

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< Stringtags
 Tags list, used e.g. for advanced parameter tag. More...
 
Restrictions to accepted values (used in checkDefaults)
double min_float
 Default: - std::numeric_limits<double>::max() More...
 
double max_float
 Default: std::numeric_limits<double>::max() More...
 
Int min_int
 Default: - std::numeric_limits<Int>::max() More...
 
Int max_int
 Default: std::numeric_limits<Int>::max() More...
 
std::vector< Stringvalid_strings
 Default: empty. More...
 

Detailed Description

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

Constructor & Destructor Documentation

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.

Member Function Documentation

bool isValid ( String message) const

Check if 'value' fulfills restrictions.

bool operator== ( const ParamEntry rhs) const

Equality operator (only name and value are compared)

Member Data Documentation

String description

Description of the entry.

double max_float

Default: std::numeric_limits<double>::max()

Int max_int

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

double min_float

Default: - std::numeric_limits<double>::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 2.0.0 Documentation generated on Wed Mar 30 2016 12:49:29 using doxygen 1.8.11