atlas::util::Config class

#include <atlas/util/Config.h>

Base classes

class eckit::LocalConfiguration

Derived classes

struct atlas::linalg::dense::Backend

struct atlas::linalg::sparse::Backend

class atlas::option::alignment

class atlas::option::datatype

template<typename T>

class atlas::option::datatypeT

class atlas::option::fft

class atlas::option::flt

class atlas::option::global

class atlas::option::halo

class atlas::option::levels

class atlas::option::name

class atlas::option::nproma

class atlas::option::pole_edges

class atlas::option::radius

class atlas::option::read_fft

class atlas::option::read_legendre

class atlas::option::scalar_derivatives

class atlas::option::shape

class atlas::option::split_latitudes

class atlas::option::type

class atlas::option::variables

class atlas::option::vector

class atlas::option::vorticity_divergence_fields

class atlas::option::warning

class atlas::option::wind_EW_derivatives

class atlas::option::write_fft

class atlas::option::write_legendre

class NoConfig

Constructors, destructors, conversion operators

Config()

Config(const eckit::PathName&)

Constructor starting from a path.

Config(std::istream&, const std::string& format = "json")

Constructor starting from a stream.

Config(const eckit::Configuration&)

Constructor starting from a Configuration.

template<typename ValueT>

Config(const std::string& name, const ValueT& value)

Constructor immediately setting a value.

Config(const std::string& name, const std::string_view value)

template<typename ValueT>

Config(const std::string& name, std::initializer_list<ValueT>&& value)

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&

auto remove(const std::string& name) -> Config&

auto get(const std::string& name, std::vector<Config>& value) const -> bool

auto keys() const -> std::vector<std::string>

auto json(eckit::JSON::Formatting = eckit::JSON::Formatting::indent()) const -> std::string

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

auto set(const std::string& name, const char* value) -> LocalConfiguration& override

auto set(const std::string& name, bool value) -> LocalConfiguration& override

auto set(const std::string& name, int value) -> LocalConfiguration& override

auto set(const std::string& name, long value) -> LocalConfiguration& override

auto set(const std::string& name, long long value) -> LocalConfiguration&

auto set(const std::string& name, size_t value) -> LocalConfiguration& override

auto set(const std::string& name, float value) -> LocalConfiguration& override

auto set(const std::string& name, double value) -> LocalConfiguration& override

auto set(const std::string& name, const std::vector<int>& value) -> LocalConfiguration& override

auto set(const std::string& name, const std::vector<long>& value) -> LocalConfiguration& override

auto set(const std::string& name, const std::vector<long long>& value) -> LocalConfiguration&

auto set(const std::string& name, const std::vector<size_t>& value) -> LocalConfiguration& override

auto set(const std::string& name, const std::vector<float>& value) -> LocalConfiguration& override

auto set(const std::string& name, const std::vector<double>& value) -> LocalConfiguration& override

auto set(const std::string& name, const std::vector<std::string>& value) -> LocalConfiguration& override

auto set(const std::string& name, const Configuration& value) -> LocalConfiguration&

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&

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&

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

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

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