#####################################################################
# hcack.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.
#####################################################################
"""HCACK data item."""
from secsgem.secs import variables
from .base import DataItemBase
[docs]class HCACK(DataItemBase):
"""Host command parameter acknowledge code.
:Type: :class:`Binary <secsgem.secs.variables.Binary>`
:Length: 1
**Values**
+-------+--------------------------------+-------------------------------------------------------------+
| Value | Description | Constant |
+=======+================================+=============================================================+
| 0 | Acknowledge | :const:`secsgem.secs.data_items.HCACK.ACK` |
+-------+--------------------------------+-------------------------------------------------------------+
| 1 | Denied, invalid command | :const:`secsgem.secs.data_items.HCACK.INVALID_COMMAND` |
+-------+--------------------------------+-------------------------------------------------------------+
| 2 | Denied, cannot perform now | :const:`secsgem.secs.data_items.HCACK.CANT_PERFORM_NOW` |
+-------+--------------------------------+-------------------------------------------------------------+
| 3 | Denied, parameter invalid | :const:`secsgem.secs.data_items.HCACK.PARAMETER_INVALID` |
+-------+--------------------------------+-------------------------------------------------------------+
| 4 | Acknowledge, will finish later | :const:`secsgem.secs.data_items.HCACK.ACK_FINISH_LATER` |
+-------+--------------------------------+-------------------------------------------------------------+
| 5 | Rejected, already in condition | :const:`secsgem.secs.data_items.HCACK.ALREADY_IN_CONDITION` |
+-------+--------------------------------+-------------------------------------------------------------+
| 6 | No such object | :const:`secsgem.secs.data_items.HCACK.NO_OBJECT` |
+-------+--------------------------------+-------------------------------------------------------------+
| 7-63 | Reserved | |
+-------+--------------------------------+-------------------------------------------------------------+
**Used In Function**
- :class:`SecsS02F42 <secsgem.secs.functions.SecsS02F42>`
- :class:`SecsS02F50 <secsgem.secs.functions.SecsS02F50>`
"""
name = "HCACK"
__type__ = variables.Binary
__count__ = 1
ACK = 0
INVALID_COMMAND = 1
CANT_PERFORM_NOW = 2
PARAMETER_INVALID = 3
ACK_FINISH_LATER = 4
ALREADY_IN_CONDITION = 5
NO_OBJECT = 6
_values = {
"ACK": 0,
"INVALID_COMMAND": 1,
"CANT_PERFORM_NOW": 2,
"PARAMETER_INVALID": 3,
"ACK_FINISH_LATER": 4,
"ALREADY_IN_CONDITION": 5,
"NO_OBJECT": 6,
}