MultiOption Class Reference

Description

Stores a single option for minimization algorithm. Int, double, string values are available.

Definition at line 28 of file MultiOption.h.

Collaboration diagram for MultiOption:

Public Types
using	variant_t = std::variant< int, double, std::string >

Public Member Functions
template<typename T >
	MultiOption (const std::string &name, const T &t, const std::string &descripion="")
	MultiOption (std::string name="")
variant_t &	defaultValue ()
std::string	description () const
template<typename T >
T	get () const
	Returns the option's value. More...
template<typename T >
T	getDefault () const
	Returns the option's default value (i.e. used during construction) More...
std::string	name () const
void	setDescription (const std::string &description)
void	setFromString (const std::string &value)
	Sets the value of option from string. More...
variant_t &	value ()
std::string	value_str ()
	Returns a string representation of the option's value. More...

Private Attributes
variant_t	m_default_value
std::string	m_description
std::string	m_name
variant_t	m_value

Member Typedef Documentation

variant_t

using MultiOption::variant_t = std::variant<int, double, std::string>

Definition at line 30 of file MultiOption.h.

Constructor & Destructor Documentation

MultiOption() [1/2]

MultiOption::MultiOption

(

std::string

name = ""

)

Definition at line 19 of file MultiOption.cpp.

    : m_name(std::move(name))
{
}

MultiOption() [2/2]

template<typename T >

MultiOption::MultiOption	(	const std::string &	name,
		const T &	t,
		const std::string &	descripion = ""
	)

Definition at line 66 of file MultiOption.h.

{
    m_name = name;
    m_description = descripion;
    m_value = t;
    m_default_value = t;
}

References m_default_value, m_description, m_name, m_value, and name().

Here is the call graph for this function:

Member Function Documentation

defaultValue()

MultiOption::variant_t & MultiOption::defaultValue

(

)

Definition at line 44 of file MultiOption.cpp.

{
    return m_default_value;
}

References m_default_value.

description()

std::string MultiOption::description

(

)

const

Definition at line 29 of file MultiOption.cpp.

{
    return m_description;
}

References m_description.

Referenced by setDescription().

get()

template<typename T >

T MultiOption::get

Returns the option's value.

Definition at line 75 of file MultiOption.h.

{
    return std::get<T>(m_value);
}

References m_value.

getDefault()

template<typename T >

T MultiOption::getDefault

Returns the option's default value (i.e. used during construction)

Definition at line 81 of file MultiOption.h.

{
    return std::get<T>(m_default_value);
}

References m_default_value.

name()

std::string MultiOption::name

(

)

const

Definition at line 24 of file MultiOption.cpp.

{
    return m_name;
}

References m_name.

Referenced by MultiOption().

setDescription()

void MultiOption::setDescription

(

const std::string &

description

)

Definition at line 34 of file MultiOption.cpp.

{
    m_description = description;
}

References description(), and m_description.

Here is the call graph for this function:

setFromString()

void MultiOption::setFromString

(

const std::string &

value

)

Sets the value of option from string.

Definition at line 50 of file MultiOption.cpp.

{
    const std::size_t idx = m_value.index();
    switch (idx) {
    case 0:
        m_value = std::stoi(value);
        break;
    case 1:
        m_value = std::stod(value);
        break;
    default:
        m_value = value;
    }
}

References m_value, and value().

Here is the call graph for this function:

value()

MultiOption::variant_t & MultiOption::value

(

)

Definition at line 39 of file MultiOption.cpp.

{
    return m_value;
}

References m_value.

Referenced by setFromString().

value_str()

std::string MultiOption::value_str

(

)

Returns a string representation of the option's value.

Sets the value of option from string.

Definition at line 66 of file MultiOption.cpp.

{
    if (std::holds_alternative<int>(m_value))
        return std::to_string(std::get<int>(m_value));
    else if (std::holds_alternative<double>(m_value))
        return std::to_string(std::get<double>(m_value));
    else // std::holds_alternative<std::string>(m_value)
        return std::get<std::string>(m_value);
}

References m_value.

Member Data Documentation

m_default_value

variant_t MultiOption::m_default_value

private

Definition at line 62 of file MultiOption.h.

Referenced by MultiOption(), defaultValue(), and getDefault().

m_description

std::string MultiOption::m_description

private

Definition at line 60 of file MultiOption.h.

Referenced by MultiOption(), description(), and setDescription().

m_name

std::string MultiOption::m_name

private

Definition at line 59 of file MultiOption.h.

Referenced by MultiOption(), and name().

m_value

variant_t MultiOption::m_value

private

Definition at line 61 of file MultiOption.h.

Referenced by MultiOption(), get(), setFromString(), value(), and value_str().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Tools/MultiOption.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Tools/MultiOption.cpp