atlas::util::Metadata class

Base classes

class eckit::LocalConfiguration

Constructors, destructors, conversion operators

Metadata()
Metadata(const eckit::LocalConfiguration& p)

Public functions

template<typename ValueT>
auto set(const std::string& name, const ValueT& value) -> Metadata&
auto set(const eckit::Configuration&) -> Metadata&
template<typename ValueT>
auto get(const std::string& name) const -> ValueT
void broadcast()
void broadcast(idx_t root)
void broadcast(Metadata&)
void broadcast(Metadata&, idx_t root)
void broadcast(Metadata&) const
void broadcast(Metadata&, idx_t root) const
auto footprint() const -> size_t
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 remove(const std::string& name) -> 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 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

Friends

auto operator<<(std::ostream& s, const Metadata& v) -> std::ostream&

Function documentation

LocalConfiguration& atlas::util::Metadata::remove(const std::string& name)

bool atlas::util::Metadata::getBool(const std::string& name) const

bool atlas::util::Metadata::getBool(const std::string& name, const bool& defaultValue) const

int atlas::util::Metadata::getInt(const std::string& name) const

int atlas::util::Metadata::getInt(const std::string& name, const int& defaultValue) const

long atlas::util::Metadata::getLong(const std::string& name) const

long atlas::util::Metadata::getLong(const std::string& name, const long& defaultValue) const

std::size_t atlas::util::Metadata::getUnsigned(const std::string& name) const

std::size_t atlas::util::Metadata::getUnsigned(const std::string& name, const std::size_t& defaultValue) const

std::int32_t atlas::util::Metadata::getInt32(const std::string& name) const

std::int32_t atlas::util::Metadata::getInt32(const std::string& name, const std::int32_t& defaultValue) const

std::int64_t atlas::util::Metadata::getInt64(const std::string& name) const

std::int64_t atlas::util::Metadata::getInt64(const std::string& name, const std::int64_t& defaultValue) const

float atlas::util::Metadata::getFloat(const std::string& name) const

float atlas::util::Metadata::getFloat(const std::string& name, const float& defaultValue) const

double atlas::util::Metadata::getDouble(const std::string& name) const

double atlas::util::Metadata::getDouble(const std::string& name, const double& defaultValue) const

std::string atlas::util::Metadata::getString(const std::string& name) const

std::string atlas::util::Metadata::getString(const std::string& name, const std::string& defaultValue) const

std::vector<int> atlas::util::Metadata::getIntVector(const std::string& name) const

std::vector<int> atlas::util::Metadata::getIntVector(const std::string& name, const std::vector<int>& defaultValue) const

std::vector<long> atlas::util::Metadata::getLongVector(const std::string& name) const

std::vector<long> atlas::util::Metadata::getLongVector(const std::string& name, const std::vector<long>& defaultValue) const

std::vector<std::size_t> atlas::util::Metadata::getUnsignedVector(const std::string& name) const

std::vector<std::size_t> atlas::util::Metadata::getUnsignedVector(const std::string& name, const std::vector<std::size_t>& defaultValue) const

std::vector<std::int32_t> atlas::util::Metadata::getInt32Vector(const std::string& name) const

std::vector<std::int32_t> atlas::util::Metadata::getInt32Vector(const std::string& name, const std::vector<std::int32_t>& defaultValue) const

std::vector<std::int64_t> atlas::util::Metadata::getInt64Vector(const std::string& name) const

std::vector<std::int64_t> atlas::util::Metadata::getInt64Vector(const std::string& name, const std::vector<std::int64_t>& defaultValue) const

std::vector<float> atlas::util::Metadata::getFloatVector(const std::string& name) const

std::vector<float> atlas::util::Metadata::getFloatVector(const std::string& name, const std::vector<float>& defaultValue) const

std::vector<double> atlas::util::Metadata::getDoubleVector(const std::string& name) const

std::vector<double> atlas::util::Metadata::getDoubleVector(const std::string& name, const std::vector<double>& defaultValue) const

std::vector<std::string> atlas::util::Metadata::getStringVector(const std::string& name) const

std::vector<std::string> atlas::util::Metadata::getStringVector(const std::string& name, const std::vector<std::string>& defaultValue) const

bool atlas::util::Metadata::empty() const

std::vector<std::string> atlas::util::Metadata::keys() const

LocalConfiguration atlas::util::Metadata::getSubConfiguration(const std::string& name) const

char atlas::util::Metadata::separator() const

bool atlas::util::Metadata::has(const std::string& name) const override

bool atlas::util::Metadata::get(const std::string& name, std::string& value) const override

bool atlas::util::Metadata::get(const std::string& name, bool& value) const override

bool atlas::util::Metadata::get(const std::string& name, int& value) const override

bool atlas::util::Metadata::get(const std::string& name, long& value) const override

bool atlas::util::Metadata::get(const std::string& name, long long& value) const override

bool atlas::util::Metadata::get(const std::string& name, std::size_t& value) const override

bool atlas::util::Metadata::get(const std::string& name, float& value) const override

bool atlas::util::Metadata::get(const std::string& name, double& value) const override

bool atlas::util::Metadata::get(const std::string& name, std::vector<int>& value) const override

bool atlas::util::Metadata::get(const std::string& name, std::vector<long>& value) const override

bool atlas::util::Metadata::get(const std::string& name, std::vector<long long>& value) const override

bool atlas::util::Metadata::get(const std::string& name, std::vector<std::size_t>& value) const override

bool atlas::util::Metadata::get(const std::string& name, std::vector<float>& value) const override

bool atlas::util::Metadata::get(const std::string& name, std::vector<double>& value) const override

bool atlas::util::Metadata::get(const std::string& name, std::vector<std::string>& value) const override

bool atlas::util::Metadata::get(const std::string& name, std::vector<LocalConfiguration>&) const

bool atlas::util::Metadata::get(const std::string& name, LocalConfiguration&) const

const Value& atlas::util::Metadata::get() const

bool atlas::util::Metadata::get(const std::string& name, size_t& value) const pure virtual

bool atlas::util::Metadata::get(const std::string& name, std::vector<size_t>& value) const pure virtual

void atlas::util::Metadata::hash(eckit::Hash&) const virtual

bool atlas::util::Metadata::isSubConfiguration(const std::string& name) const

bool atlas::util::Metadata::isIntegral(const std::string& name) const

bool atlas::util::Metadata::isBoolean(const std::string& name) const

bool atlas::util::Metadata::isFloatingPoint(const std::string& name) const

bool atlas::util::Metadata::isString(const std::string& name) const

bool atlas::util::Metadata::isList(const std::string& name) const

bool atlas::util::Metadata::isSubConfigurationList(const std::string& name) const

bool atlas::util::Metadata::isIntegralList(const std::string& name) const

bool atlas::util::Metadata::isBooleanList(const std::string& name) const

bool atlas::util::Metadata::isFloatingPointList(const std::string& name) const

bool atlas::util::Metadata::isStringList(const std::string& name) const

bool atlas::util::Metadata::isNull(const std::string& name) const

template<typename T>
bool atlas::util::Metadata::isConvertible(const std::string& name) const

template<typename T>
bool atlas::util::Metadata::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.