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< String >	tags
	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< String >	valid_strings
	Default: empty. More...

Detailed Description

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

Constructor & Destructor Documentation

ParamEntry() [1/3]

ParamEntry

(

)

Default constructor.

ParamEntry() [2/3]

ParamEntry	(	const String &	n,
		const DataValue &	v,
		const String &	d,
		const StringList &	t = StringList()
	)

Constructor with name, description, value and advanced flag.

ParamEntry() [3/3]

ParamEntry

(

const ParamEntry &

other

)

Copy constructor.

~ParamEntry()

~ParamEntry

(

)

Destructor.

Member Function Documentation

isValid()

bool isValid

(

String &

message

)

const

Check if 'value' fulfills restrictions.

operator==()

bool operator==

(

const ParamEntry &

rhs

)

const

Equality operator (only name and value are compared)

Member Data Documentation

description

String description

Description of the entry.

max_float

double max_float

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

max_int

Int max_int

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

min_float

double min_float

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

min_int

Int min_int

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

name

String name

Name of the entry.

tags

std::set<String> tags

Tags list, used e.g. for advanced parameter tag.

valid_strings

std::vector<String> valid_strings

Default: empty.

value

DataValue value

Value associated with the entry.