#####################################################################
# s05f14.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.
#####################################################################
"""Class for stream 05 function 14."""
from secsgem.secs.functions.base import SecsStreamFunction
from secsgem.secs.data_items import EXID
from secsgem.secs.data_items import ACKA
from secsgem.secs.data_items import ERRCODE
from secsgem.secs.data_items import ERRTEXT
[docs]class SecsS05F14(SecsStreamFunction):
"""
exception recover - acknowledge.
**Data Items**
- :class:`EXID <secsgem.secs.data_items.EXID>`
- :class:`ACKA <secsgem.secs.data_items.ACKA>`
- :class:`ERRCODE <secsgem.secs.data_items.ERRCODE>`
- :class:`ERRTEXT <secsgem.secs.data_items.ERRTEXT>`
**Structure**::
>>> import secsgem.secs
>>> secsgem.secs.functions.SecsS05F14
{
EXID: A[20]
DATA: {
ACKA: BOOLEAN[1]
DATA: {
ERRCODE: I1/I2/I4/I8
ERRTEXT: A[120]
}
}
}
**Example**::
>>> import secsgem.secs
>>> secsgem.secs.functions.SecsS05F14({
... "EXID": "EX123",
... "DATA": {"ACKA": False,
... "DATA": {"ERRCODE": 10,
... "ERRTEXT": "Error"}}})
S5F14
<L [2]
<A "EX123">
<L [2]
<BOOLEAN False >
<L [2]
<I1 10 >
<A "Error">
>
>
> .
:param value: parameters for this function (see example)
:type value: dict
"""
_stream = 5
_function = 14
_data_format = [
EXID,
[
ACKA,
[
ERRCODE,
ERRTEXT
]
]
]
_to_host = True
_to_equipment = False
_has_reply = False
_is_reply_required = False
_is_multi_block = False