================
Enumeration Type
================

Module: `thinkiq.model.enumeration_type`
========================================

.. automodule:: thinkiq.model.enumeration_type
.. currentmodule:: thinkiq.model.enumeration_type

:class:`EnumerationType`
------------------------

.. autoclass:: EnumerationType

    Enumeration types map numeric codes to human-readable names, descriptions, and color codes.

    **Properties:**

    .. py:attribute:: id
        :type: int

    .. py:attribute:: default_enumeration_values
        :type: list[str]

    .. py:attribute:: enumeration_names
        :type: list[str]

    .. py:attribute:: enumeration_descriptions
        :type: list[str]

    .. py:attribute:: enumeration_color_codes
        :type: list[str]

    .. py:attribute:: enum_lookup
        :type: dict

        Mapping from values to names.

    **Methods**

    .. automethod:: __init__
    .. automethod:: save
    .. automethod:: delete
    .. automethod:: decode
    .. automethod:: encode


Integration with Attribute
--------------------------

Attributes of type `"enumeration"` can attach an :class:`EnumerationType`.

- **Get enumeration type**
  .. automethod:: thinkiq.model.attribute.Attribute.get_enumeration_type

- **Decode values**
  .. automethod:: thinkiq.model.attribute.Attribute.decode

- **Encode names**
  .. automethod:: thinkiq.model.attribute.Attribute.encode