atlas::option::flt class
#include <atlas/option/TransOptions.h>

Base classes

class atlas::util::Config
Configuration class used to construct various atlas components.

Constructors, destructors, conversion operators

flt(bool)

Public functions

template<typename ValueT>
auto operator()(const std::string& name, const ValueT& value) -> Config
Operator that sets a key-value pair.
template<typename ValueT>
auto operator()(const std::string& name, std::initializer_list<ValueT>&& value) -> Config
auto operator|(const eckit::Configuration& other) const -> Config
auto set(const std::string& name, const std::vector<Config>&) -> Config&
auto set(const eckit::Configuration&) -> Config&
template<typename T>
auto set(const std::string& name, std::initializer_list<T>&& value) -> Config&
template<typename ValueT>
auto set(const std::string& name, std::initializer_list<ValueT>&& value) -> Config&
auto set(const std::string& name, const std::string& value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, const char* value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, bool value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, int value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, long value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, long long value) -> LocalConfiguration&
Set a key-value parameter.
auto set(const std::string& name, size_t value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, float value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, double value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, const std::vector<int>& value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, const std::vector<long>& value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, const std::vector<long long>& value) -> LocalConfiguration&
Set a key-value parameter.
auto set(const std::string& name, const std::vector<size_t>& value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, const std::vector<float>& value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, const std::vector<double>& value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, const std::vector<std::string>& value) -> LocalConfiguration& override
Set a key-value parameter.
auto set(const std::string& name, const Configuration& value) -> LocalConfiguration&
Set a key-value parameter.
template<typename ConfigurationT, typename = std::enable_if_t<std::is_base_of_v<Configuration, std::decay_t<ConfigurationT>>>>
auto set(const std::string& name, const std::vector<ConfigurationT>& value) -> LocalConfiguration&
Set a key-value parameter.
template<typename ConfigurationT, typename = std::enable_if_t<std::is_base_of_v<Configuration, std::decay_t<ConfigurationT>>>>
auto set(const std::string& name, std::initializer_list<ConfigurationT>&& value) -> LocalConfiguration&
Set a key-value parameter.
auto remove(const std::string& name) -> Config&
auto get(const std::string& name, std::vector<Config>& value) const -> bool
auto get(const std::string& name, std::string& value) const -> bool override
auto get(const std::string& name, bool& value) const -> bool override
auto get(const std::string& name, int& value) const -> bool override
auto get(const std::string& name, long& value) const -> bool override
auto get(const std::string& name, long long& value) const -> bool override
auto get(const std::string& name, std::size_t& value) const -> bool override
auto get(const std::string& name, float& value) const -> bool override
auto get(const std::string& name, double& value) const -> bool override
auto get(const std::string& name, std::vector<int>& value) const -> bool override
auto get(const std::string& name, std::vector<long>& value) const -> bool override
auto get(const std::string& name, std::vector<long long>& value) const -> bool override
auto get(const std::string& name, std::vector<std::size_t>& value) const -> bool override
auto get(const std::string& name, std::vector<float>& value) const -> bool override
auto get(const std::string& name, std::vector<double>& value) const -> bool override
auto get(const std::string& name, std::vector<std::string>& value) const -> bool override
auto get(const std::string& name, std::vector<LocalConfiguration>&) const -> bool
auto get(const std::string& name, LocalConfiguration&) const -> bool
auto get() const -> const Value&
auto get(const std::string& name, size_t& value) const -> bool pure virtual
auto get(const std::string& name, std::vector<size_t>& value) const -> bool pure virtual
auto keys() const -> std::vector<std::string>
auto json(eckit::JSON::Formatting = eckit::JSON::Formatting::indent()) const -> std::string
auto getBool(const std::string& name) const -> bool
auto getBool(const std::string& name, const bool& defaultValue) const -> bool
auto getInt(const std::string& name) const -> int
auto getInt(const std::string& name, const int& defaultValue) const -> int
auto getLong(const std::string& name) const -> long
auto getLong(const std::string& name, const long& defaultValue) const -> long
auto getUnsigned(const std::string& name) const -> std::size_t
auto getUnsigned(const std::string& name, const std::size_t& defaultValue) const -> std::size_t
auto getInt32(const std::string& name) const -> std::int32_t
auto getInt32(const std::string& name, const std::int32_t& defaultValue) const -> std::int32_t
auto getInt64(const std::string& name) const -> std::int64_t
auto getInt64(const std::string& name, const std::int64_t& defaultValue) const -> std::int64_t
auto getFloat(const std::string& name) const -> float
auto getFloat(const std::string& name, const float& defaultValue) const -> float
auto getDouble(const std::string& name) const -> double
auto getDouble(const std::string& name, const double& defaultValue) const -> double
auto getString(const std::string& name) const -> std::string
auto getString(const std::string& name, const std::string& defaultValue) const -> std::string
auto getIntVector(const std::string& name) const -> std::vector<int>
auto getIntVector(const std::string& name, const std::vector<int>& defaultValue) const -> std::vector<int>
auto getLongVector(const std::string& name) const -> std::vector<long>
auto getLongVector(const std::string& name, const std::vector<long>& defaultValue) const -> std::vector<long>
auto getUnsignedVector(const std::string& name) const -> std::vector<std::size_t>
auto getUnsignedVector(const std::string& name, const std::vector<std::size_t>& defaultValue) const -> std::vector<std::size_t>
auto getInt32Vector(const std::string& name) const -> std::vector<std::int32_t>
auto getInt32Vector(const std::string& name, const std::vector<std::int32_t>& defaultValue) const -> std::vector<std::int32_t>
auto getInt64Vector(const std::string& name) const -> std::vector<std::int64_t>
auto getInt64Vector(const std::string& name, const std::vector<std::int64_t>& defaultValue) const -> std::vector<std::int64_t>
auto getFloatVector(const std::string& name) const -> std::vector<float>
auto getFloatVector(const std::string& name, const std::vector<float>& defaultValue) const -> std::vector<float>
auto getDoubleVector(const std::string& name) const -> std::vector<double>
auto getDoubleVector(const std::string& name, const std::vector<double>& defaultValue) const -> std::vector<double>
auto getStringVector(const std::string& name) const -> std::vector<std::string>
auto getStringVector(const std::string& name, const std::vector<std::string>& defaultValue) const -> std::vector<std::string>
auto empty() const -> bool
auto getSubConfigurations(const std::string& name) const -> std::vector<LocalConfiguration>
auto getSubConfigurations() const -> std::vector<LocalConfiguration>
auto getSubConfiguration(const std::string& name) const -> LocalConfiguration
auto separator() const -> char
auto has(const std::string& name) const -> bool override
void hash(eckit::Hash&) const virtual
auto isSubConfiguration(const std::string& name) const -> bool
auto isIntegral(const std::string& name) const -> bool
auto isBoolean(const std::string& name) const -> bool
auto isFloatingPoint(const std::string& name) const -> bool
auto isString(const std::string& name) const -> bool
auto isList(const std::string& name) const -> bool
auto isSubConfigurationList(const std::string& name) const -> bool
auto isIntegralList(const std::string& name) const -> bool
auto isBooleanList(const std::string& name) const -> bool
auto isFloatingPointList(const std::string& name) const -> bool
auto isStringList(const std::string& name) const -> bool
auto isNull(const std::string& name) const -> bool
template<typename T>
auto isConvertible(const std::string& name) const -> bool
template<typename T>
auto isConvertible(const std::string& name, T&) const -> bool

Function documentation

#include <atlas/util/Config.h>
template<typename ValueT>
Config atlas::option::flt::operator()(const std::string& name, const ValueT& value)

Operator that sets a key-value pair.

#include <atlas/util/Config.h>
template<typename ValueT>
Config atlas::option::flt::operator()(const std::string& name, std::initializer_list<ValueT>&& value)

Config atlas::option::flt::operator|(const eckit::Configuration& other) const
#include <atlas/util/Config.h>

Config& atlas::option::flt::set(const std::string& name, const std::vector<Config>&)
#include <atlas/util/Config.h>

Config& atlas::option::flt::set(const eckit::Configuration&)
#include <atlas/util/Config.h>

#include <atlas/util/Config.h>
template<typename T>
Config& atlas::option::flt::set(const std::string& name, std::initializer_list<T>&& value)

#include <atlas/util/Config.h>
template<typename ValueT>
Config& atlas::option::flt::set(const std::string& name, std::initializer_list<ValueT>&& value)

LocalConfiguration& atlas::option::flt::set(const std::string& name, const std::string& value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, const char* value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, bool value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, int value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, long value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, long long value)
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, size_t value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, float value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, double value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, const std::vector<int>& value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, const std::vector<long>& value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, const std::vector<long long>& value)
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, const std::vector<size_t>& value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, const std::vector<float>& value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, const std::vector<double>& value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, const std::vector<std::string>& value) override
#include <atlas/util/Config.h>

Set a key-value parameter.

LocalConfiguration& atlas::option::flt::set(const std::string& name, const Configuration& value)
#include <atlas/util/Config.h>

Set a key-value parameter.

#include <atlas/util/Config.h>
template<typename ConfigurationT, typename = std::enable_if_t<std::is_base_of_v<Configuration, std::decay_t<ConfigurationT>>>>
LocalConfiguration& atlas::option::flt::set(const std::string& name, const std::vector<ConfigurationT>& value)

Set a key-value parameter.

#include <atlas/util/Config.h>
template<typename ConfigurationT, typename = std::enable_if_t<std::is_base_of_v<Configuration, std::decay_t<ConfigurationT>>>>
LocalConfiguration& atlas::option::flt::set(const std::string& name, std::initializer_list<ConfigurationT>&& value)

Set a key-value parameter.

Config& atlas::option::flt::remove(const std::string& name)
#include <atlas/util/Config.h>

bool atlas::option::flt::get(const std::string& name, std::vector<Config>& value) const
#include <atlas/util/Config.h>

bool atlas::option::flt::get(const std::string& name, std::string& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, bool& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, int& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, long& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, long long& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, std::size_t& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, float& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, double& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, std::vector<int>& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, std::vector<long>& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, std::vector<long long>& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, std::vector<std::size_t>& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, std::vector<float>& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, std::vector<double>& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, std::vector<std::string>& value) const override
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, std::vector<LocalConfiguration>&) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, LocalConfiguration&) const
#include <eckit/config/Configuration.h>

const Value& atlas::option::flt::get() const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::get(const std::string& name, size_t& value) const pure virtual
#include <eckit/config/Parametrisation.h>

bool atlas::option::flt::get(const std::string& name, std::vector<size_t>& value) const pure virtual
#include <eckit/config/Parametrisation.h>

std::vector<std::string> atlas::option::flt::keys() const
#include <atlas/util/Config.h>

bool atlas::option::flt::getBool(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::getBool(const std::string& name, const bool& defaultValue) const
#include <eckit/config/Configuration.h>

int atlas::option::flt::getInt(const std::string& name) const
#include <eckit/config/Configuration.h>

int atlas::option::flt::getInt(const std::string& name, const int& defaultValue) const
#include <eckit/config/Configuration.h>

long atlas::option::flt::getLong(const std::string& name) const
#include <eckit/config/Configuration.h>

long atlas::option::flt::getLong(const std::string& name, const long& defaultValue) const
#include <eckit/config/Configuration.h>

std::size_t atlas::option::flt::getUnsigned(const std::string& name) const
#include <eckit/config/Configuration.h>

std::size_t atlas::option::flt::getUnsigned(const std::string& name, const std::size_t& defaultValue) const
#include <eckit/config/Configuration.h>

std::int32_t atlas::option::flt::getInt32(const std::string& name) const
#include <eckit/config/Configuration.h>

std::int32_t atlas::option::flt::getInt32(const std::string& name, const std::int32_t& defaultValue) const
#include <eckit/config/Configuration.h>

std::int64_t atlas::option::flt::getInt64(const std::string& name) const
#include <eckit/config/Configuration.h>

std::int64_t atlas::option::flt::getInt64(const std::string& name, const std::int64_t& defaultValue) const
#include <eckit/config/Configuration.h>

float atlas::option::flt::getFloat(const std::string& name) const
#include <eckit/config/Configuration.h>

float atlas::option::flt::getFloat(const std::string& name, const float& defaultValue) const
#include <eckit/config/Configuration.h>

double atlas::option::flt::getDouble(const std::string& name) const
#include <eckit/config/Configuration.h>

double atlas::option::flt::getDouble(const std::string& name, const double& defaultValue) const
#include <eckit/config/Configuration.h>

std::string atlas::option::flt::getString(const std::string& name) const
#include <eckit/config/Configuration.h>

std::string atlas::option::flt::getString(const std::string& name, const std::string& defaultValue) const
#include <eckit/config/Configuration.h>

std::vector<int> atlas::option::flt::getIntVector(const std::string& name) const
#include <eckit/config/Configuration.h>

std::vector<int> atlas::option::flt::getIntVector(const std::string& name, const std::vector<int>& defaultValue) const
#include <eckit/config/Configuration.h>

std::vector<long> atlas::option::flt::getLongVector(const std::string& name) const
#include <eckit/config/Configuration.h>

std::vector<long> atlas::option::flt::getLongVector(const std::string& name, const std::vector<long>& defaultValue) const
#include <eckit/config/Configuration.h>

std::vector<std::size_t> atlas::option::flt::getUnsignedVector(const std::string& name) const
#include <eckit/config/Configuration.h>

std::vector<std::size_t> atlas::option::flt::getUnsignedVector(const std::string& name, const std::vector<std::size_t>& defaultValue) const
#include <eckit/config/Configuration.h>

std::vector<std::int32_t> atlas::option::flt::getInt32Vector(const std::string& name) const
#include <eckit/config/Configuration.h>

std::vector<std::int32_t> atlas::option::flt::getInt32Vector(const std::string& name, const std::vector<std::int32_t>& defaultValue) const
#include <eckit/config/Configuration.h>

std::vector<std::int64_t> atlas::option::flt::getInt64Vector(const std::string& name) const
#include <eckit/config/Configuration.h>

std::vector<std::int64_t> atlas::option::flt::getInt64Vector(const std::string& name, const std::vector<std::int64_t>& defaultValue) const
#include <eckit/config/Configuration.h>

std::vector<float> atlas::option::flt::getFloatVector(const std::string& name) const
#include <eckit/config/Configuration.h>

std::vector<float> atlas::option::flt::getFloatVector(const std::string& name, const std::vector<float>& defaultValue) const
#include <eckit/config/Configuration.h>

std::vector<double> atlas::option::flt::getDoubleVector(const std::string& name) const
#include <eckit/config/Configuration.h>

std::vector<double> atlas::option::flt::getDoubleVector(const std::string& name, const std::vector<double>& defaultValue) const
#include <eckit/config/Configuration.h>

std::vector<std::string> atlas::option::flt::getStringVector(const std::string& name) const
#include <eckit/config/Configuration.h>

std::vector<std::string> atlas::option::flt::getStringVector(const std::string& name, const std::vector<std::string>& defaultValue) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::empty() const
#include <eckit/config/Configuration.h>

LocalConfiguration atlas::option::flt::getSubConfiguration(const std::string& name) const
#include <eckit/config/Configuration.h>

char atlas::option::flt::separator() const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::has(const std::string& name) const override
#include <eckit/config/Configuration.h>

void atlas::option::flt::hash(eckit::Hash&) const virtual
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isSubConfiguration(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isIntegral(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isBoolean(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isFloatingPoint(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isString(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isList(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isSubConfigurationList(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isIntegralList(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isBooleanList(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isFloatingPointList(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isStringList(const std::string& name) const
#include <eckit/config/Configuration.h>

bool atlas::option::flt::isNull(const std::string& name) const
#include <eckit/config/Configuration.h>

#include <eckit/config/Configuration.h>
template<typename T>
bool atlas::option::flt::isConvertible(const std::string& name) const

#include <eckit/config/Configuration.h>
template<typename T>
bool atlas::option::flt::isConvertible(const std::string& name, T&) const

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.