.. _`Conditional error/warning`:

.. _`org.sysess.sympathy.data.table.conditionalerror`:

Conditional error/warning
`````````````````````````

.. image:: error.svg
   :width: 48


Raise an error if a predicate is True.




Documentation
:::::::::::::

Raise an error if the supplied predicate function returns True.

See https://docs.python.org/3/tutorial/controlflow.html#lambda-expressions
for a description of lambda functions. Have a look at the :ref:`Data type
APIs<datatypeapis>` to see what methods and attributes are available on the
data type that you are working with.


Definition
::::::::::


Input ports
...........

    **in**  <a>
        Input


Output ports
............

    **out**  <a>
        Output




Configuration
.............

    **Error message:** (error_msg)
        Error message to display to the user.
    **Severity:** (error_type)
        The level "Error" stops flow execution.
    **Predicate function:** (predicate)
        Error message is printed if this function returns True.







Examples
........

* :download:`Test.syx </Examples/Sympathy/Development/Test/Test.syx>`




Implementation
..............

.. automodule:: node_conditional_error
    :noindex:

.. class:: ConditionalError
    :noindex: