gmx::StringToEnumValueConverter< EnumType,, stringCompareType, stripStrings > Class Template Reference

#include <gromacs/utility/include/gromacs/utility/stringtoenumvalueconverter.h>

Description

template<typename EnumType, const char *, StringCompareType stringCompareType = StringCompareType::Exact, StripStrings stripStrings = StripStrings::No>
class gmx::StringToEnumValueConverter< EnumType,, stringCompareType, stripStrings >

A class to convert a string to an enum value of type EnumType.

It can be configured:

• to match different enumerations,
• to convert enumerations to strings in a custom way,
• either strip strings of leading and trailing whitespace before comparison or not,
• with different handling of how the string characters are compared.

Usage example:

enum class Foo : int { Fizz, Buzz, Count, Default = Fizz }; StringToEnumValueConverter<Foo, enumValueToString> converter; Foo type = converter.valueFrom(theString);

Template Parameters

EnumType	A class enum for which enumValueToString is defined and maps all values (except EnumType::Count) to a string.
enumValueToStringFunction	Function to convert EnumValue to string, which is typically enumValueToString, per convention
stringCompareType	Indicates how the string should be compared with respect to case, hyphens, underscores, etc.
stripStrings	Indicates whether strings should have leading and trailing whitespace removed before comparison

Public Member Functions
std::optional< EnumType >	valueFrom (const std::string &s) const
	Return an optional enum value identified from the s (which is never EnumType::Count)

---

The documentation for this class was generated from the following file:

• src/gromacs/utility/include/gromacs/utility/stringtoenumvalueconverter.h