Param::ParamEntry Struct Reference

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

#include <OpenMS/DATASTRUCTURES/Param.h>

Collaboration diagram for Param::ParamEntry:

Public Member Functions
	ParamEntry ()
	Default constructor.
	ParamEntry (const std::string &n, const ParamValue &v, const std::string &d, const std::vector< std::string > &t=std::vector< std::string >())
	Constructor with name, description, value and advanced flag.
	ParamEntry (const ParamEntry &)=default
	Copy constructor.
	ParamEntry (ParamEntry &&)=default
	Move constructor.
	~ParamEntry ()
	Destructor.
ParamEntry &	operator= (const ParamEntry &)=default
	Assignment operator.
ParamEntry &	operator= (ParamEntry &&) &=default
	Move assignment operator.
bool	isValid (std::string &message) const
	Check if 'value' fulfills restrictions.
bool	operator== (const ParamEntry &rhs) const
	Equality operator (only name and value are compared)

Public Attributes
std::string	name
	Name of the entry.
std::string	description
	Description of the entry.
ParamValue	value
	Value associated with the entry.
std::set< std::string >	tags
	Tags list, used e.g. for advanced parameter tag.
Restrictions to accepted values (used in checkDefaults)
double	min_float
	Default: - std::numeric_limits<double>::max()
double	max_float
	Default: std::numeric_limits<double>::max()
int	min_int
	Default: - std::numeric_limits<Int>::max()
int	max_int
	Default: std::numeric_limits<Int>::max()
std::vector< std::string >	valid_strings
	Default: empty.

Detailed Description

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

Constructor & Destructor Documentation

ParamEntry() [1/4]

ParamEntry

(

)

Default constructor.

ParamEntry() [2/4]

ParamEntry	(	const std::string &	n,
		const ParamValue &	v,
		const std::string &	d,
		const std::vector< std::string > &	t = std::vector< std::string >()
	)

Constructor with name, description, value and advanced flag.

ParamEntry() [3/4]

ParamEntry ( const ParamEntry &  )

default

Copy constructor.

ParamEntry() [4/4]

ParamEntry ( ParamEntry &&  )

default

Move constructor.

~ParamEntry()

~ParamEntry

(

)

Destructor.

Member Function Documentation

isValid()

bool isValid

(

std::string &

message

)

const

Check if 'value' fulfills restrictions.

operator=() [1/2]

ParamEntry & operator= ( const ParamEntry &  )

default

Assignment operator.

operator=() [2/2]

ParamEntry & operator= ( ParamEntry &&  ) &

default

Move assignment operator.

operator==()

bool operator==

(

const ParamEntry &

rhs

)

const

Equality operator (only name and value are compared)

Member Data Documentation

description

std::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

std::string name

Name of the entry.

tags

std::set<std::string> tags

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

valid_strings

std::vector<std::string> valid_strings

Default: empty.

value

ParamValue value

Value associated with the entry.