OptionContainer Class Reference

Description

Stores multi option (int,double,string) in a container.

Definition at line 31 of file OptionContainer.h.

Inheritance diagram for OptionContainer:

Collaboration diagram for OptionContainer:

Public Types
using	const_iterator = container_t::const_iterator
using	container_t = std::vector< option_t >
using	iterator = container_t::iterator
using	option_t = std::shared_ptr< MultiOption >

Public Member Functions
	OptionContainer ()=default
	OptionContainer (const OptionContainer &other)
	Returns true if option with such name already exists. More...
template<class T >
option_t	addOption (const std::string &optionName, T value, const std::string &description="")
iterator	begin ()
const_iterator	begin () const
bool	empty () const
iterator	end ()
const_iterator	end () const
OptionContainer &	operator= (const OptionContainer &other)
option_t	option (const std::string &optionName)
option_t	option (const std::string &optionName) const
template<class T >
T	optionValue (const std::string &optionName) const
template<class T >
void	setOptionValue (const std::string &optionName, T value)
	Sets the value of option. Option should hold same value type already. More...
size_t	size () const

Protected Member Functions
bool	exists (const std::string &name)
void	swapContent (OptionContainer &other)

Protected Attributes
container_t	m_options

Member Typedef Documentation

const_iterator

using OptionContainer::const_iterator = container_t::const_iterator

Definition at line 36 of file OptionContainer.h.

container_t

using OptionContainer::container_t = std::vector<option_t>

Definition at line 34 of file OptionContainer.h.

iterator

using OptionContainer::iterator = container_t::iterator

Definition at line 35 of file OptionContainer.h.

option_t

using OptionContainer::option_t = std::shared_ptr<MultiOption>

Definition at line 33 of file OptionContainer.h.

Constructor & Destructor Documentation

OptionContainer() [1/2]

OptionContainer::OptionContainer ( )

default

OptionContainer() [2/2]

OptionContainer::OptionContainer

(

const OptionContainer &

other

)

Returns true if option with such name already exists.

Definition at line 19 of file OptionContainer.cpp.

{
    for (const auto& option : other.m_options)
        m_options.push_back(option_t(new MultiOption(*option)));
}

References m_options, and option().

Here is the call graph for this function:

Member Function Documentation

addOption()

template<class T >

OptionContainer::option_t OptionContainer::addOption	(	const std::string &	optionName,
		T	value,
		const std::string &	description = ""
	)

Definition at line 71 of file OptionContainer.h.

{
    if (exists(optionName))
        throw std::runtime_error("OptionContainer::addOption() -> Error. Option '" + optionName
                                 + "' exists.");
 
    option_t result(new MultiOption(optionName, value, description));
    m_options.push_back(result);
    return result;
}

References exists(), and m_options.

Referenced by MinimizerAdapter::addOption().

Here is the call graph for this function:

begin() [1/2]

iterator OptionContainer::begin ( )

inline

Definition at line 55 of file OptionContainer.h.

{ return m_options.begin(); }

References m_options.

begin() [2/2]

const_iterator OptionContainer::begin ( ) const

inline

Definition at line 56 of file OptionContainer.h.

{ return m_options.begin(); }

References m_options.

empty()

bool OptionContainer::empty ( ) const

inline

Definition at line 62 of file OptionContainer.h.

{ return size() == 0; }

References size().

Here is the call graph for this function:

end() [1/2]

iterator OptionContainer::end ( )

inline

Definition at line 58 of file OptionContainer.h.

{ return m_options.end(); }

References m_options.

end() [2/2]

const_iterator OptionContainer::end ( ) const

inline

Definition at line 59 of file OptionContainer.h.

{ return m_options.end(); }

References m_options.

exists()

bool OptionContainer::exists ( const std::string &  name )

protected

Definition at line 56 of file OptionContainer.cpp.

{
    for (const auto& option : m_options) {
        if (option->name() == name)
            return true;
    }
    return false;
}

References m_options, and option().

Referenced by addOption().

Here is the call graph for this function:

operator=()

OptionContainer & OptionContainer::operator=

(

const OptionContainer &

other

)

Definition at line 25 of file OptionContainer.cpp.

{
    if (this != &other) {
        OptionContainer tmp(other);
        tmp.swapContent(*this);
    }
    return *this;
}

References swapContent().

Here is the call graph for this function:

option() [1/2]

OptionContainer::option_t OptionContainer::option

(

const std::string &

optionName

)

Definition at line 34 of file OptionContainer.cpp.

{
    for (const auto& option : m_options) {
        if (option->name() == optionName)
            return option;
    }
 
    throw std::runtime_error("Configurable::getOption() -> Error. No option with name '"
                             + optionName + "'.");
}

References m_options.

Referenced by OptionContainer(), exists(), option(), optionValue(), MinimizerOptions::processCommand(), setOptionValue(), and MinimizerOptions::toOptionString().

option() [2/2]

OptionContainer::option_t OptionContainer::option

(

const std::string &

optionName

)

const

Definition at line 45 of file OptionContainer.cpp.

{
    for (const auto& option : m_options) {
        if (option->name() == optionName)
            return option;
    }
 
    throw std::runtime_error("Configurable::getOption() -> Error. No option with name '"
                             + optionName + "'.");
}

References m_options, and option().

Here is the call graph for this function:

optionValue()

template<class T >

T OptionContainer::optionValue

(

const std::string &

optionName

)

const

Definition at line 84 of file OptionContainer.h.

{
    return option(optionName)->get<T>();
}

References option().

Referenced by MinimizerAdapter::optionValue().

Here is the call graph for this function:

setOptionValue()

template<class T >

void OptionContainer::setOptionValue	(	const std::string &	optionName,
		T	value
	)

Sets the value of option. Option should hold same value type already.

Definition at line 90 of file OptionContainer.h.

{
    option(optionName)->value() = value;
    if (option(optionName)->value().index() != option(optionName)->defaultValue().index())
        throw std::runtime_error(
            "OptionContainer::setOptionValue() -> Error. Attempt to set different"
            "type to option '"
            + optionName + "'");
}

References option().

Referenced by MinimizerAdapter::setOptionValue().

Here is the call graph for this function:

size()

size_t OptionContainer::size ( ) const

inline

Definition at line 61 of file OptionContainer.h.

{ return m_options.size(); }

References m_options.

Referenced by empty().

swapContent()

void OptionContainer::swapContent ( OptionContainer &  other )

protected

Definition at line 65 of file OptionContainer.cpp.

{
    std::swap(m_options, other.m_options);
}

References m_options.

Referenced by operator=().

Member Data Documentation

m_options

container_t OptionContainer::m_options

protected

Definition at line 67 of file OptionContainer.h.

Referenced by OptionContainer(), addOption(), begin(), end(), exists(), option(), size(), swapContent(), and MinimizerOptions::toOptionString().

---

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

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