Param::ParamEntry Struct Reference

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

#include <OpenMS/DATASTRUCTURES/Param.h>

List of all members.

Public Member Functions
	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 ()
	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).
Public Attributes
String	name
	Name of the entry.
String	description
	Description of the entry.
DataValue	value
	Value associated with the entry.
std::set< String >	tags
	Tags list, used e.g. for advanced parameter tag.
Restrictions to accepted values (used in checkDefaults)
DoubleReal	min_float
	Default: - std::numeric_limits<DoubleReal>::max().
DoubleReal	max_float
	Default: std::numeric_limits<DoubleReal>::max().
Int	min_int
	Default: - std::numeric_limits<Int>::max().
Int	max_int
	Default: std::numeric_limits<Int>::max().
std::vector< String >	valid_strings
	Default: empty.

---

Detailed Description

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

---

Constructor & Destructor Documentation

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

(

)

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.

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.