Enumerations Classes

Helper classes and defines for enumeration items. More...

Collaboration diagram for Enumerations Classes:

Classes

class  Murl::Enum< EnumType >
 Enumeration string mapping template class. More...
 
class  Murl::EnumContainer
 A container holding individual enumeration objects by name. More...
 
class  Murl::StaticEnumContainer
 The static enum container in the Murl namespace. More...
 
#define MURL_DECLARE_ENUM_VALUE(prefix, name)
 Declare an enumeration entry. More...
 
#define MURL_DECLARE_ENUM_VALUE_PREDEFINED(prefix, name, value)
 Declare an enumeration entry with a value. More...
 
#define MURL_DECLARE_ENUM_ACCESSOR(name)
 Declare an enumeration string mapping accessor. More...
 
#define MURL_DEFINE_ENUM_BEGIN(name)
 Start defining a Enum::Item array. More...
 
#define MURL_DEFINE_ENUM_ITEM(prefix, name)
 Define a Enum::Item array entry. More...
 
#define MURL_DEFINE_ENUM_ITEM_DEFAULT(defaultName)
 Define the default Enum::Item array. More...
 
#define MURL_DEFINE_ENUM_END(name)
 Create an instance of the enumeration string mapping class and a getter method "Get##name##Enum()". More...
 
#define NUMBER_OF_ARRAY_ELEMENTS(name)
 Get the number of array elements. More...
 

Detailed Description

Helper classes and defines for enumeration items.

Macro Definition Documentation

◆ MURL_DECLARE_ENUM_VALUE

#define MURL_DECLARE_ENUM_VALUE (   prefix,
  name 
)

Declare an enumeration entry.

Creates "prefix##_##name,".

Parameters
prefixThe prefix of the entry.
nameThe name of the entry.

◆ MURL_DECLARE_ENUM_VALUE_PREDEFINED

#define MURL_DECLARE_ENUM_VALUE_PREDEFINED (   prefix,
  name,
  value 
)

Declare an enumeration entry with a value.

Creates "prefix##_##name = value,".

Parameters
prefixThe prefix of the entry.
nameThe name of the entry.
valueThe value of the entry.

◆ MURL_DECLARE_ENUM_ACCESSOR

#define MURL_DECLARE_ENUM_ACCESSOR (   name)

Declare an enumeration string mapping accessor.

Creates "const Enum<name>& Get##name##Enum();".

Parameters
nameThe name of the enumerator.

◆ MURL_DEFINE_ENUM_BEGIN

#define MURL_DEFINE_ENUM_BEGIN (   name)

Start defining a Enum::Item array.

Parameters
nameThe name of the enumerator.

◆ MURL_DEFINE_ENUM_ITEM

#define MURL_DEFINE_ENUM_ITEM (   prefix,
  name 
)

Define a Enum::Item array entry.

Parameters
prefixThe prefix of the enumeration value.
nameThe name of the enumeration value and the string.

◆ MURL_DEFINE_ENUM_ITEM_DEFAULT

#define MURL_DEFINE_ENUM_ITEM_DEFAULT (   defaultName)

Define the default Enum::Item array.

Parameters
defaultNameThe name of the default enumeration value.

◆ MURL_DEFINE_ENUM_END

#define MURL_DEFINE_ENUM_END (   name)

Create an instance of the enumeration string mapping class and a getter method "Get##name##Enum()".

Parameters
nameThe name of the enumerator.

◆ NUMBER_OF_ARRAY_ELEMENTS

#define NUMBER_OF_ARRAY_ELEMENTS (   name)

Get the number of array elements.

Parameters
nameThe name of the array.


Copyright © 2011-2018 Spraylight GmbH.