MultiOption Class Reference

Stores a single option for minimization algorithm. More...

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

Public Member Functions
template<typename T >
	MultiOption (const std::string &name, const T &t, const std::string &descripion="")
	MultiOption (const 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 ()

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

Detailed Description

Stores a single option for minimization algorithm.

Int, double, string values are available. Relies on boost::variant, will be switched to std::variant in C++-17.

Definition at line 30 of file MultiOption.h.

Member Typedef Documentation

variant_t

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

Definition at line 32 of file MultiOption.h.

Constructor & Destructor Documentation

MultiOption() [1/2]

MultiOption::MultiOption ( const std::string &  name = "" )

explicit

Definition at line 18 of file MultiOption.cpp.

: m_name(name) {}

MultiOption() [2/2]

template<typename T >

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

explicit

Definition at line 63 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 40 of file MultiOption.cpp.

{
    return m_default_value;
}

References m_default_value.

description()

std::string MultiOption::description

(

)

const

Definition at line 25 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 71 of file MultiOption.h.

{
    return boost::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 76 of file MultiOption.h.

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

References m_default_value.

name()

std::string MultiOption::name

(

)

const

Definition at line 20 of file MultiOption.cpp.

{
    return m_name;
}

References m_name.

Referenced by MultiOption().

setDescription()

void MultiOption::setDescription

(

const std::string &

description

)

Definition at line 30 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.

TODO find more elegant way (without if/else and boost::lexical_cast

Definition at line 48 of file MultiOption.cpp.

{
    if (m_value.which() == 0)
        m_value = boost::lexical_cast<int>(value);
 
    else if (m_value.which() == 1)
        m_value = boost::lexical_cast<double>(value);
 
    else
        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 35 of file MultiOption.cpp.

{
    return m_value;
}

References m_value.

Referenced by setFromString().

Member Data Documentation

m_default_value

variant_t MultiOption::m_default_value

private

Definition at line 59 of file MultiOption.h.

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

m_description

std::string MultiOption::m_description

private

Definition at line 57 of file MultiOption.h.

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

m_name

std::string MultiOption::m_name

private

Definition at line 56 of file MultiOption.h.

Referenced by MultiOption(), and name().

m_value

variant_t MultiOption::m_value

private

Definition at line 58 of file MultiOption.h.

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

---

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

• /home/www/ba/Fit/Tools/MultiOption.h
• /home/www/ba/Fit/Tools/MultiOption.cpp