Flip Reference

EnumClass Class Reference

Declared in

flip/EnumClass.h

template <class T>   class EnumClass;

flip::EnumClass is a type that represents a declaration of a flip Enumeration. A concrete instance of this enumeration is acquired using an instance of the DataModel

Member Functions Synopsys

Declaring

name

Set the name of the enumeration

member

Declare an enumerator of the enumeration

Accessing

name

Returns the name of the enumeration

enumerators

Returns information on the enumerators of the enumeration

Member Functions

name

EnumClass &  name (const char * name_0);

Set the name of the enumeration. The name must be in the ascii-7 character set, with exception of spaces, control characters as well as del character.

Names starting with flip are reserved.

This function returns a reference to the EnumClass to allow call chaining.


member

template <T val>   EnumClass &  enumerator (const char * name_0);

Declare an enumerator of the enumeration. The name must be in the ascii-7 character set, with exception of spaces, control characters as well as del character.

WARNING: flip Enumeration declaration must follow the same order as in the C++ enumeration declaration. must start from 0, and must be continguous.

This function returns a reference to the EnumClass to allow call chaining.


name

const char *   name () const

Returns the name of the enumeration.


enumerators

const Enumerators &   enumerators () const

Returns information on the enumerators of the enumeration. This allows for automatic introspection of an instance of the enumeration.