======
Limit
======

Module: `thinkiq.model.limit`
=============================

.. automodule:: thinkiq.model.limit
.. currentmodule:: thinkiq.model.limit


:class:`Limit`
--------------

.. autoclass:: Limit

    A Limit represents a single threshold for an Attribute, such as HiHi, Hi, Lo, LoLo, or Target.  
    Each limit row stores the direction (greater/less/target) and the numeric threshold value.

    **Properties:**

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

    .. py:attribute:: part_of_id
        :type: int

    .. py:attribute:: display_name
        :type: str

        Human-readable name of the limit (e.g., "HiHi", "LoLo").

    .. py:attribute:: relative_name
        :type: str

        Internal key for the limit (e.g., "hihi", "lo", "target").

    .. py:attribute:: direction
        :type: str

        Direction of the limit ("greater", "less", "target").

    .. py:attribute:: float_value
        :type: float

        Threshold value for the limit.

    **Methods**

    .. automethod:: __init__

    .. automethod:: save

    .. automethod:: delete


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

Limits are attached to :class:`Attribute` objects.  
You can load and evaluate them as follows:

- **Load limits for an Attribute**

  .. automethod:: thinkiq.model.attribute.Attribute.get_limits

- **Evaluate current value against limits**

  .. automethod:: thinkiq.model.attribute.Attribute.evaluate_limits