ParameterLists Class Reference

Defines parameter name and value, and stores them in maps for settng values from XML. More...

#include <Parameters.h>

Inheritance diagram for ParameterLists:

Public Member Functions
void	set_xml_element_name (const std::string &name)
void	set_parameter (const std::string &name, const bool value, bool required, Parameter< bool > &param)
	Set the name, default value and the parameter required flag.
void	set_parameter (const std::string &name, const double value, bool required, Parameter< double > &param)
void	set_parameter (const std::string &name, std::initializer_list< double > value, bool required, VectorParameter< double > &param)
void	set_parameter (const std::string &name, std::initializer_list< int > value, bool required, VectorParameter< int > &param)
void	set_parameter (const std::string &name, std::initializer_list< std::string > value, bool required, VectorParameter< std::string > &param)
void	set_parameter (const std::string &name, const int value, bool required, Parameter< int > &param, std::vector< int > range={})
void	set_parameter (const std::string &name, const std::string &value, bool required, Parameter< std::string > &param)
void	set_parameter_value_CANN (const std::string &name, const std::string &value)
	set_parameter function to handle CANNRow
void	set_parameter_value (const std::string &name, const std::string &value)
	Set the value of a paramter from a string.
void	check_required ()
	Check if any required parameters have not been set.
std::map< std::string, std::string >	get_parameter_list ()
	Get the defined parameters as a map of strings.
void	print_parameter_list ()
	Print the parameters.

Public Attributes
std::map< std::string, std::variant< Parameter< bool > *, Parameter< double > *, Parameter< int > *, Parameter< std::string > *, VectorParameter< double > *, VectorParameter< int > *, VectorParameter< std::string > * > >	params_map
	Map used for storing parameters by name / Parameter template union.
std::string	xml_element_name = ""

Detailed Description

Defines parameter name and value, and stores them in maps for settng values from XML.

Member Function Documentation

check_required()

void ParameterLists::check_required ( )

inline

Check if any required parameters have not been set.

get_parameter_list()

std::map< std::string, std::string > ParameterLists::get_parameter_list ( )

inline

Get the defined parameters as a map of strings.

print_parameter_list()

void ParameterLists::print_parameter_list ( )

inline

Print the parameters.

set_parameter()

void ParameterLists::set_parameter ( const std::string &  name, const bool  value, bool  required, Parameter< bool > &  param  )

inline

Set the name, default value and the parameter required flag.

set_parameter_value()

void ParameterLists::set_parameter_value ( const std::string &  name, const std::string &  value  )

inline

Set the value of a paramter from a string.

set_parameter_value_CANN()

void ParameterLists::set_parameter_value_CANN ( const std::string &  name, const std::string &  value  )

inline

set_parameter function to handle CANNRow

Member Data Documentation

params_map

std::map<std::string, std::variant<Parameter<bool>*, Parameter<double>*, Parameter<int>*, Parameter<std::string>*, VectorParameter<double>*, VectorParameter<int>*, VectorParameter<std::string>* > > ParameterLists::params_map

Map used for storing parameters by name / Parameter template union.

---

The documentation for this class was generated from the following file:

• solver/Parameters.h