SDL enum implementation with common features. Enum value and string mapping are done in a brute-force way. This SDL enum type supports enum entries with identical value or name, which is useful for giving the user more tolerance on specifying inputs (e.g., case inconsistency). See getTypedEntry() for more details. More...

#include <TSdlGeneralEnum.h>

Inheritance diagram for ph::TSdlGeneralEnum< InEnumType, MAX_ENTRIES >:

Public Types
using	EnumType = InEnumType

Public Types inherited from ph::SdlEnum
using	Entry = TEntry<int64>

Public Member Functions
	TSdlGeneralEnum (std::string name)

Entry	getEntry (const std::size_t entryIndex) const override

std::size_t	numEntries () const override

TSdlGeneralEnum &	addEntry (const EnumType enumValue, const std::string_view valueName, std::string description="")

TEntry< EnumType >	getTypedEntry (const std::size_t entryIndex) const

TEntry< EnumType >	getTypedEntry (const std::string_view entryName) const
	Get an enum entry via an enum name. Note that the method cannot distinguish between identical enum names, i.e., if two entries have the same enum name, their entries cannot be uniquely identified and returned (however, the returned entry is consistent within the same SDL version).

TEntry< EnumType >	getTypedEntry (const EnumType enumValue) const
	Get an enum entry via an enum value. Note that the method cannot distinguish between identical enum values, i.e., if two entries have the same enum value, their entries cannot be uniquely identified and returned (however, the returned entry is consistent within the same SDL version).

TSdlGeneralEnum &	description (std::string descriptionStr)

Public Member Functions inherited from ph::SdlEnum
	SdlEnum (std::string name)

const std::string &	getName () const

const std::string &	getDescription () const

std::string	getEntryDescription (std::size_t entryIndex) const

Additional Inherited Members
Protected Member Functions inherited from ph::SdlEnum
SdlEnum &	setDescription (std::string description)

SdlEnum &	setEntryDescription (std::size_t entryIndex, std::string description)

Detailed Description

template<typename InEnumType, std::size_t MAX_ENTRIES = 64>
class ph::TSdlGeneralEnum< InEnumType, MAX_ENTRIES >

SDL enum implementation with common features. Enum value and string mapping are done in a brute-force way. This SDL enum type supports enum entries with identical value or name, which is useful for giving the user more tolerance on specifying inputs (e.g., case inconsistency). See getTypedEntry() for more details.