OpenMS  2.8.0
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>

Collaboration diagram for Param::ParamEntry:
[legend]

Public Member Functions

 ParamEntry ()
 Default constructor. More...
 
 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. More...
 
 ParamEntry (const ParamEntry &)=default
 Copy constructor. More...
 
 ParamEntry (ParamEntry &&)=default
 Move constructor. More...
 
 ~ParamEntry ()
 Destructor. More...
 
ParamEntryoperator= (const ParamEntry &)=default
 Assignment operator. More...
 
ParamEntryoperator= (ParamEntry &&) &=default
 Move assignment operator. More...
 
bool isValid (std::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

std::string name
 Name of the entry. More...
 
std::string description
 Description of the entry. More...
 
ParamValue value
 Value associated with the entry. More...
 
std::set< std::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< std::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/4]

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.