#include <eckit/option/SimpleOption.h>
template<class T>
eckit::option::SimpleOption class

Base classes

template<class T>
class BaseOption<T>

Public types

using base_t = BaseOption<T>
using args_t = Option::args_t

Public static functions

template<typename T>
static void copy(const std::string& name, const Configuration& from, Configured& to)

Constructors, destructors, conversion operators

SimpleOption(const std::string& name, const std::string& description)
SimpleOption(const std::string& name, const std::string& description, const T& default_value)
~SimpleOption() defaulted override

Public functions

auto set(Configured& param, size_t values, args_t::const_iterator begin, args_t::const_iterator end) const -> size_t override
auto defaultValue(const std::string& value) -> Option*
void setDefault(Configured& parametrisation) const final
auto name() const -> const std::string&
auto description() const -> const std::string&
auto active() const -> bool virtual

Private functions

void print(std::ostream&) const override
void set_value(const T& value, Configured&) const override
auto translate(const std::string& value) const -> T override
void copy(const Configuration& from, Configured& to) const override

Function documentation

#include <eckit/option/Option.h>
template<class T _1> template<typename T>
static void eckit::option::SimpleOption<_1>::copy(const std::string& name, const Configuration& from, Configured& to)

template<class T _1>
size_t eckit::option::SimpleOption<_1>::set(Configured& param, size_t values, args_t::const_iterator begin, args_t::const_iterator end) const override

Set the value of the option into parameter, taking as many values as necessary from the range [begin, end).

  • values indicates the number of items in [begin, end) that were provided as an option value. This parameter is expected to be either 0 (for –flag options) or 1 (for traditional –option=

)

Return: number of items consumed from the range [begin, end).

#include <eckit/option/Option.h>
template<class T _1>
Option* eckit::option::SimpleOption<_1>::defaultValue(const std::string& value)

#include <eckit/option/Option.h>
template<class T _1>
void eckit::option::SimpleOption<_1>::setDefault(Configured& parametrisation) const final

#include <eckit/option/Option.h>
template<class T _1>
const std::string& eckit::option::SimpleOption<_1>::name() const

#include <eckit/option/Option.h>
template<class T _1>
const std::string& eckit::option::SimpleOption<_1>::description() const

#include <eckit/option/Option.h>
template<class T _1>
bool eckit::option::SimpleOption<_1>::active() const virtual

This website is beyond its original expiry date and the content may be out of date. The site owner has been notified and may choose to extend the expiry date and remove this banner. If you have any questions about this, please visit our support portal.