#####################################################################
# lvack.py
#
# (c) Copyright 2021, Benjamin Parzella. All rights reserved.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This software is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#####################################################################
"""LVACK data item."""
from secsgem.secs import variables
from .base import DataItemBase
[docs]
class LVACK(DataItemBase):
"""Acknowledgement code for variable limit.
:Type: :class:`Binary <secsgem.secs.variables.Binary>`
:Length: 1
**Values**
+-------+-------------------------+-----------------------------------------------------------+
| Value | Description | Constant |
+=======+=========================+===========================================================+
| 0 | OK | :const:`secsgem.secs.data_items.LVACK.OK` |
+-------+-------------------------+-----------------------------------------------------------+
| 1 | Variable does not exist | :const:`secsgem.secs.data_items.LVACK.VARIABLE_UNKNOWN` |
+-------+-------------------------+-----------------------------------------------------------+
| 2 | Variable has no limits | :const:`secsgem.secs.data_items.LVACK.NO_LIMITS` |
+-------+-------------------------+-----------------------------------------------------------+
| 3 | Variable repeated | :const:`secsgem.secs.data_items.LVACK.DUPLICATE_VARIABLE` |
+-------+-------------------------+-----------------------------------------------------------+
| 4 | Limit value error | :const:`secsgem.secs.data_items.LVACK.LIMIT_ERROR` |
+-------+-------------------------+-----------------------------------------------------------+
| 5-63 | Reserved | |
+-------+-------------------------+-----------------------------------------------------------+
**Used In Function**
- :class:`SecsS02F46 <secsgem.secs.functions.SecsS02F46>`
"""
name = "LVACK"
__type__ = variables.Binary
__count__ = 1
OK = 0
VARIABLE_UNKNOWN = 1
NO_LIMITS = 2
DUPLICATE_VARIABLE = 3
LIMIT_ERROR = 4
_values = {
"OK": 0,
"VARIABLE_UNKNOWN": 1,
"NO_LIMITS": 2,
"DUPLICATE_VARIABLE": 3,
"LIMIT_ERROR": 4,
}