Class ParameterSet¶

Defined in File Parameters.h

Class Documentation¶

class ParameterSet¶

Public Functions

ParameterSet() = default¶: default constructor

ParameterSet(const std::map<std::string, std::vector<std::map<std::string, std::string>>> &functions_map)¶: construct from from map/vector/map structure

ParameterSet(const std::vector<OpenMS::DefaultParamHandler> &open_ms_params)¶: construct list of OpenMS Parameter Handlers

void merge(const ParameterSet &other)¶

Will merge with another ParameterSet.

Parameters: other – [in] the ParameterSet to merge with

Parameter *findParameter(const std::string &function_name, const std::string &parameter_name)¶

Find a parameter accross the ParameterSet, given a name and a Parameter name.

Parameters

function_name – [in] the function name to search
parameter_name – [in] the parameter name to search

const Parameter *findParameter(const std::string &function_name, const std::string &parameter_name) const¶

void setAsSchema(bool is_schema)¶

Mark all parameters as schema parameter.

Parameters: is_schema – [in] set as schema (true) or not (false)

void addFunctionParameters(FunctionParameters parameters)¶

Add FunctionParameter to the ParameterSet. If the function already exists, it will be replaced.

Parameters: parameters – [in] the FunctionParameters to add

void addParameter(const std::string &function_name, Parameter &parameter)¶

Add a Parameter to a FunctionParameter. If the parameter already exists, it will be replaced. If the FunctionParameter does not exists, it will be created.

Parameters

function_name – [in] the function name to add to
parameter – [in] the parameter to add

bool operator==(const ParameterSet &other) const¶

inline bool operator!=(const ParameterSet &other) const¶

void clear()¶

inline FunctionParameters &at(const std::string &function_name)¶

inline const FunctionParameters &at(const std::string &function_name) const¶

inline size_t count(const std::string &function_name) const¶

inline bool empty() const¶

inline size_t size() const¶

inline FunctionParameters &operator[](const std::string &function_name)¶

inline std::map<std::string, FunctionParameters>::iterator begin()¶

inline std::map<std::string, FunctionParameters>::iterator end()¶

inline std::map<std::string, FunctionParameters>::const_iterator begin() const¶

inline std::map<std::string, FunctionParameters>::const_iterator end() const¶

Protected Attributes

std::map<std::string, FunctionParameters> function_parameters_¶