Class Scine::Utils::UniversalSettings::StringDescriptor

class StringDescriptor : public Scine::Utils::UniversalSettings::SettingDescriptor

SettingDescriptor for a string value.

Public Functions

StringDescriptor(std::string propertyDescription)

Constructor.

Parameters

• propertyDescription: A string describing what the string setting is for

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

const std::string &getDefaultValue() const

Returns the default value.

void setDefaultValue(std::string def)

Sets the default string value.