eckit::Configuration class

Base classes

class Parametrisation

Derived classes

class LocalConfiguration
class YAMLConfiguration

Constructors, destructors, conversion operators

~Configuration() override

Public functions

auto getBool(const std::string& name) const -> bool
auto getInt(const std::string& name) const -> int
auto getLong(const std::string& name) const -> long
auto getUnsigned(const std::string& name) const -> std::size_t
auto getInt32(const std::string& name) const -> std::int32_t
auto getInt64(const std::string& name) const -> std::int64_t
auto getFloat(const std::string& name) const -> float
auto getDouble(const std::string& name) const -> double
auto getString(const std::string& name) const -> std::string
auto getIntVector(const std::string& name) const -> std::vector<int>
auto getLongVector(const std::string& name) const -> std::vector<long>
auto getUnsignedVector(const std::string& name) const -> std::vector<std::size_t>
auto getInt32Vector(const std::string& name) const -> std::vector<std::int32_t>
auto getInt64Vector(const std::string& name) const -> std::vector<std::int64_t>
auto getFloatVector(const std::string& name) const -> std::vector<float>
auto getDoubleVector(const std::string& name) const -> std::vector<double>
auto getStringVector(const std::string& name) const -> std::vector<std::string>
auto getBool(const std::string& name, const bool& defaultValue) const -> bool
auto getInt(const std::string& name, const int& defaultValue) const -> int
auto getLong(const std::string& name, const long& defaultValue) const -> long
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& defaultValue) const -> std::int32_t
auto getInt64(const std::string& name, const std::int64_t& defaultValue) const -> std::int64_t
auto getFloat(const std::string& name, const float& defaultValue) const -> float
auto getDouble(const std::string& name, const double& defaultValue) const -> double
auto getString(const std::string& name, const std::string& defaultValue) const -> std::string
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>& defaultValue) const -> std::vector<long>
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>& defaultValue) const -> std::vector<std::int32_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>& defaultValue) const -> std::vector<float>
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>& defaultValue) const -> std::vector<std::string>
auto empty() const -> bool
auto keys() const -> std::vector<std::string>
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&
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
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

Private functions

void print(std::ostream&) const pure virtual

Friends

auto operator<<(JSON& s, const Configuration& v) -> JSON&
auto operator<<(std::ostream& s, const Configuration& p) -> std::ostream&

Function documentation

eckit::Configuration::~Configuration() override

bool eckit::Configuration::get(const std::string& name, size_t& value) const pure virtual

bool eckit::Configuration::get(const std::string& name, std::vector<size_t>& value) const pure 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.