File ValueCollection.h

Copyright

This code is licensed under the 3-clause BSD license.

Copyright ETH Zurich, Laboratory for Physical Chemistry, Reiher Group.

See LICENSE.txt for details.

namespace Scine

This header file contains functions that allow for common notation for common things that can be done at a different degree of derivatives.

This header contains alias definitions defining which classes to use for the different degrees of derivatives.

namespace Utils

namespace UniversalSettings

class ValueCollection

#include <ValueCollection.h>

Wrapper around vector<pair<string, GenericValue>>

Class holding values corresponding to some SettingDescriptorCollection. The functions addXXX() throw a AlreadyExistingValueException if the given name already exists. The functions getXXX() throw a InexistingValueException if the given value does not exist, and a InvalidValueConversionException if the incorrect type is requested. The functions modifyXXX() assume the key is already existing and throw a InexistingValueException if not, and a InvalidValueConversionException if the type is not the same.

Subclassed by Scine::Utils::Settings

Public Types

using KeyValuePair = std::pair<std::string, GenericValue>

using Container = std::vector<KeyValuePair>

Public Functions

int count() const

bool empty() const

std::vector<std::string> getKeys() const

bool valueExists(const std::string &name) const

void addGenericValue(std::string name, GenericValue value)

GenericValue getValue(const std::string &name) const

void modifyValue(const std::string &name, GenericValue value)

void addBool(std::string name, bool value)

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

void modifyBool(const std::string &name, bool value)

void addInt(std::string name, int value)

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

void modifyInt(const std::string &name, int value)

void addDouble(std::string name, double value)

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

void modifyDouble(const std::string &name, double value)

void addString(std::string name, std::string value)

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

void modifyString(const std::string &name, std::string value)

void addCollection(std::string name, ValueCollection value)

ValueCollection getCollection(const std::string &name) const

void modifyCollection(const std::string &name, ValueCollection value)

void addOptionWithSettings(std::string name, ParametrizedOptionValue value)

ParametrizedOptionValue getOptionWithSettings(const std::string &name) const

void modifyOptionsWithSettings(const std::string &name, ParametrizedOptionValue value)

void addIntList(std::string name, GenericValue::IntList value)

GenericValue::IntList getIntList(const std::string &name) const

void modifyIntList(const std::string &name, GenericValue::IntList value)

void addStringList(std::string name, GenericValue::StringList value)

GenericValue::StringList getStringList(const std::string &name) const

void modifyStringList(const std::string &name, GenericValue::StringList value)

void addCollectionList(std::string name, GenericValue::CollectionList value)

GenericValue::CollectionList getCollectionList(const std::string &name) const

void modifyCollectionList(const std::string &name, GenericValue::CollectionList value)

Private Functions

const GenericValue &getGenericValue(const std::string &name) const

Container::iterator findName(const std::string &name)

Container::const_iterator findName(const std::string &name) const

Private Members

Container values_