============================
EnumUnion (hwx.inspire.core)
============================

Group of mutually exclusive attributes where only one is active at at time.

The active attribute is controlled by a separate Enum Attribute.

--------------
Public Methods
--------------

  +----------------------------------+
  | castForSet_ (self, obj, value)   |
  +----------------------------------+
  | getActiveAttribute_ (self, obj)  |
  +----------------------------------+
  | getDisplayName_ (self, obj)      |
  +----------------------------------+
  | getUnits_ (self, obj)            |
  +----------------------------------+
  | getValue_ (self, obj)            |
  +----------------------------------+
  | initialize_ (self, objCls, name) |
  +----------------------------------+
  | setValue_ (self, obj, value)     |
  +----------------------------------+
  | values_ (self)                   |
  +----------------------------------+

--------------
Method Details
--------------

.. _castForSet:
.. method:: castForSet(self, obj, value)

Validates and returns the active attribute value before setting.

.. _getActiveAttribute:
.. method:: getActiveAttribute(self, obj)

Returns the active attribute.

.. _getDisplayName:
.. method:: getDisplayName(self, obj)

Returns the display name of the active attribute.

.. _getUnits:
.. method:: getUnits(self, obj)

Returns the units for the active attribute.

.. _getValue:
.. method:: getValue(self, obj)

Returns the value of the active attribute.

.. _initialize:
.. method:: initialize(self, objCls, name)

Initializes the attribute.

.. _setValue:
.. method:: setValue(self, obj, value)

Sets the specified value for the active attribute.

.. _values:
.. method:: values(self)

Returns all the values from all the attributes.