Separator class
#include <eckit/option/Separator.h>

Base classes

class eckit::option::Option

Public types

using args_t = std::vector<std::string>

Public static functions

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

Constructors, destructors, conversion operators

Separator(const std::string& description)
~Separator() override

Public functions

auto set(Configured& parameter, size_t values, args_t::const_iterator begin, args_t::const_iterator end) const -> size_t override
void setDefault(Configured&) const override
auto name() const -> const std::string&
auto description() const -> const std::string&
auto set(Configured& param, size_t values, args_t::const_iterator begin, args_t::const_iterator end) const -> size_t pure virtual
void copy(const Configuration& from, Configured& to) const pure virtual
void setDefault(Configured&) const pure virtual

Private functions

void print(std::ostream&) const override
auto active() const -> bool override

Typedef documentation

using Separator::args_t = std::vector<std::string>
#include <eckit/option/Option.h>

Function documentation

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

const std::string& Separator::name() const
#include <eckit/option/Option.h>

const std::string& Separator::description() const
#include <eckit/option/Option.h>

size_t Separator::set(Configured& param, size_t values, args_t::const_iterator begin, args_t::const_iterator end) const pure virtual
#include <eckit/option/Option.h>

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).

void Separator::copy(const Configuration& from, Configured& to) const pure virtual
#include <eckit/option/Option.h>

void Separator::setDefault(Configured&) const pure virtual
#include <eckit/option/Option.h>