Arp::Base::Core::EnumDictionaryBase< T > Class Template Reference

This class implements an adapter for enums to define the string literals of the enum entries. More...

#include <EnumDictionaryBase.hxx>

Inheritance diagram for Arp::Base::Core::EnumDictionaryBase< T >:

Protected Types
using	Fields = std::map< T, const char * >
	The container type containing the value/name pairs of all enum fields.
using	InitializerList = std::initializer_list< typename Fields::value_type >
	The initializer list type of the Fields container.
using	U = typename std::underlying_type< T >::type
	The underlying integral type of the enum.

Protected Member Functions
	EnumDictionaryBase (const InitializerList &fields)
	Constructor passing the enum fields as initializer list. More...
	EnumDictionaryBase (const char *invalidValueString, const InitializerList &fields)
	Constructor passing the enum fields as initializer list. More...
	EnumDictionaryBase (const EnumDictionaryBase &arg)
	Copy constructor.
	EnumDictionaryBase (EnumDictionaryBase &&arg) noexcept
	Move constructor.
EnumDictionaryBase &	operator= (const EnumDictionaryBase &arg)
	Copy-assignment operator.
EnumDictionaryBase &	operator= (EnumDictionaryBase &&arg) noexcept
	Move-assignment operator.
	~EnumDictionaryBase (void)
	Destructor.
bool	TryGetEnumStringInternal (T value, const char *&pResult) const
	Returns the string of the specified enum value or nullptr if the value could not be found. More...
bool	TryGetEnumValueInternal (const char *fieldName, T &value) const
	Tries to get the enum value of the specified string. More...

Protected Attributes
Fields	fields
String	invalidValueString

Static Protected Attributes
static const T	zeroValue = static_cast<T>(0)

Detailed Description

template<class T>
class Arp::Base::Core::EnumDictionaryBase< T >

This class implements an adapter for enums to define the string literals of the enum entries.

Template Parameters

T	The type of the enum.

This is a helper class to make enums parsable and loggable or formattable, respectively.

Constructor & Destructor Documentation

EnumDictionaryBase() [1/2]

template<class T >

Arp::Base::Core::EnumDictionaryBase< T >::EnumDictionaryBase ( const InitializerList &  fields )

inlineexplicitprotected

Constructor passing the enum fields as initializer list.

Parameters

fields

The enum fields as value string pairs.

EnumDictionaryBase() [2/2]

template<class T >

Arp::Base::Core::EnumDictionaryBase< T >::EnumDictionaryBase ( const char *  invalidValueString, const InitializerList &  fields  )

inlineprotected

Constructor passing the enum fields as initializer list.

Parameters

fields	The enum fields as value string pairs.
invalidValueString	A string which is used for formatting an invalid enum value.

Member Function Documentation

TryGetEnumStringInternal()

template<class T >

bool Arp::Base::Core::EnumDictionaryBase< T >::TryGetEnumStringInternal ( T  value, const char *&  pResult  ) const

inlineprotected

Returns the string of the specified enum value or nullptr if the value could not be found.

Parameters

value	The enum value of enum T to get the associated string from.
pResult	The string of the as argument passed enum value or nullptr if it could not be found.

Returns

true on success, otherwise false.

TryGetEnumValueInternal()

template<class T >

bool Arp::Base::Core::EnumDictionaryBase< T >::TryGetEnumValueInternal ( const char *  fieldName, T &  value  ) const

inlineprotected

Tries to get the enum value of the specified string.

Parameters

fieldName	The string to get the associated enum value from.
value	The resulting enum value or T{} if it could not be found.

Returns

true on success, otherwise false.

---

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

• Arp/Base/Core/Detail/EnumDictionaryBase.hxx