File StringListDescriptor.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 StringListDescriptor : public Scine::Utils::UniversalSettings::SettingDescriptor

#include <StringListDescriptor.h>

SettingDescriptor for a list of strings.

Public Types

using StringList = GenericValue::StringList

Public Functions

StringListDescriptor(std::string propertyDescription)

std::unique_ptr<SettingDescriptor> clone() const

Create a heap-allocated base pointer copy of this instance.

Return

A heap-allocated copy of this instance

GenericValue getDefaultGenericValue() const

Creates a type-erased representation of the setting’s default value.

Return

A type-erased representation of the setting’s default value

bool validValue(const GenericValue &v) const

Checks if a particular type-erased representation of a setting is a valid value for this kind of setting.

Return

Whether the type-erased representation is a valid value for this kind of setting

Parameters

• v: A type-erased setting representation

StringListDescriptor::StringList getDefaultValue() const

Returns the default string list value.

void setDefaultValue(StringList def)

Sets the default string list value.

std::string getDefaultItemValue() const

Returns the default value for an individual string in the list.

void setDefaultItemValue(std::string def)

Get the default value for an individual string in the list.

Private Members

StringList defaultValue_ = {}

StringList::value_type defaultItemValue_ = {}