eckit::YAMLConfiguration class

Base classes

class Configuration

Constructors, destructors, conversion operators

YAMLConfiguration(const PathName& path, char separator = '.')
YAMLConfiguration(std::istream&, char separator = '.')
YAMLConfiguration(Stream&, char separator = '.')
YAMLConfiguration(const std::string&, char separator = '.')
YAMLConfiguration(const SharedBuffer&, char separator = '.')
~YAMLConfiguration() override

Public functions

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 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&
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

Private functions

void print(std::ostream&) const override

Function documentation

bool eckit::YAMLConfiguration::getBool(const std::string& name) const

bool eckit::YAMLConfiguration::getBool(const std::string& name, const bool& defaultValue) const

int eckit::YAMLConfiguration::getInt(const std::string& name) const

int eckit::YAMLConfiguration::getInt(const std::string& name, const int& defaultValue) const

long eckit::YAMLConfiguration::getLong(const std::string& name) const

long eckit::YAMLConfiguration::getLong(const std::string& name, const long& defaultValue) const

std::size_t eckit::YAMLConfiguration::getUnsigned(const std::string& name) const

std::size_t eckit::YAMLConfiguration::getUnsigned(const std::string& name, const std::size_t& defaultValue) const

std::int32_t eckit::YAMLConfiguration::getInt32(const std::string& name) const

std::int32_t eckit::YAMLConfiguration::getInt32(const std::string& name, const std::int32_t& defaultValue) const

std::int64_t eckit::YAMLConfiguration::getInt64(const std::string& name) const

std::int64_t eckit::YAMLConfiguration::getInt64(const std::string& name, const std::int64_t& defaultValue) const

float eckit::YAMLConfiguration::getFloat(const std::string& name) const

float eckit::YAMLConfiguration::getFloat(const std::string& name, const float& defaultValue) const

double eckit::YAMLConfiguration::getDouble(const std::string& name) const

double eckit::YAMLConfiguration::getDouble(const std::string& name, const double& defaultValue) const

std::string eckit::YAMLConfiguration::getString(const std::string& name) const

std::string eckit::YAMLConfiguration::getString(const std::string& name, const std::string& defaultValue) const

std::vector<int> eckit::YAMLConfiguration::getIntVector(const std::string& name) const

std::vector<int> eckit::YAMLConfiguration::getIntVector(const std::string& name, const std::vector<int>& defaultValue) const

std::vector<long> eckit::YAMLConfiguration::getLongVector(const std::string& name) const

std::vector<long> eckit::YAMLConfiguration::getLongVector(const std::string& name, const std::vector<long>& defaultValue) const

std::vector<std::size_t> eckit::YAMLConfiguration::getUnsignedVector(const std::string& name) const

std::vector<std::size_t> eckit::YAMLConfiguration::getUnsignedVector(const std::string& name, const std::vector<std::size_t>& defaultValue) const

std::vector<std::int32_t> eckit::YAMLConfiguration::getInt32Vector(const std::string& name) const

std::vector<std::int32_t> eckit::YAMLConfiguration::getInt32Vector(const std::string& name, const std::vector<std::int32_t>& defaultValue) const

std::vector<std::int64_t> eckit::YAMLConfiguration::getInt64Vector(const std::string& name) const

std::vector<std::int64_t> eckit::YAMLConfiguration::getInt64Vector(const std::string& name, const std::vector<std::int64_t>& defaultValue) const

std::vector<float> eckit::YAMLConfiguration::getFloatVector(const std::string& name) const

std::vector<float> eckit::YAMLConfiguration::getFloatVector(const std::string& name, const std::vector<float>& defaultValue) const

std::vector<double> eckit::YAMLConfiguration::getDoubleVector(const std::string& name) const

std::vector<double> eckit::YAMLConfiguration::getDoubleVector(const std::string& name, const std::vector<double>& defaultValue) const

std::vector<std::string> eckit::YAMLConfiguration::getStringVector(const std::string& name) const

std::vector<std::string> eckit::YAMLConfiguration::getStringVector(const std::string& name, const std::vector<std::string>& defaultValue) const

bool eckit::YAMLConfiguration::empty() const

std::vector<std::string> eckit::YAMLConfiguration::keys() const

std::vector<LocalConfiguration> eckit::YAMLConfiguration::getSubConfigurations(const std::string& name) const

LocalConfiguration eckit::YAMLConfiguration::getSubConfiguration(const std::string& name) const

char eckit::YAMLConfiguration::separator() const

bool eckit::YAMLConfiguration::has(const std::string& name) const override

bool eckit::YAMLConfiguration::get(const std::string& name, std::string& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, bool& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, int& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, long& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, long long& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, std::size_t& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, float& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, double& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, std::vector<int>& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, std::vector<long>& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, std::vector<long long>& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, std::vector<std::size_t>& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, std::vector<float>& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, std::vector<double>& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, std::vector<std::string>& value) const override

bool eckit::YAMLConfiguration::get(const std::string& name, std::vector<LocalConfiguration>&) const

bool eckit::YAMLConfiguration::get(const std::string& name, LocalConfiguration&) const

const Value& eckit::YAMLConfiguration::get() const

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

bool eckit::YAMLConfiguration::get(const std::string& name, std::vector<size_t>& value) const pure virtual

void eckit::YAMLConfiguration::hash(eckit::Hash&) const virtual

bool eckit::YAMLConfiguration::isSubConfiguration(const std::string& name) const

bool eckit::YAMLConfiguration::isIntegral(const std::string& name) const

bool eckit::YAMLConfiguration::isBoolean(const std::string& name) const

bool eckit::YAMLConfiguration::isFloatingPoint(const std::string& name) const

bool eckit::YAMLConfiguration::isString(const std::string& name) const

bool eckit::YAMLConfiguration::isList(const std::string& name) const

bool eckit::YAMLConfiguration::isSubConfigurationList(const std::string& name) const

bool eckit::YAMLConfiguration::isIntegralList(const std::string& name) const

bool eckit::YAMLConfiguration::isBooleanList(const std::string& name) const

bool eckit::YAMLConfiguration::isFloatingPointList(const std::string& name) const

bool eckit::YAMLConfiguration::isStringList(const std::string& name) const

bool eckit::YAMLConfiguration::isNull(const std::string& name) const

template<typename T>
bool eckit::YAMLConfiguration::isConvertible(const std::string& name) const

template<typename T>
bool eckit::YAMLConfiguration::isConvertible(const std::string& name, T&) const