#####################################################################
# s02f33.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 02 function 33."""
from secsgem.secs.functions.base import SecsStreamFunction
from secsgem.secs.data_items import DATAID
from secsgem.secs.data_items import RPTID
from secsgem.secs.data_items import VID
[docs]class SecsS02F33(SecsStreamFunction):
"""
define report.
**Data Items**
- :class:`DATAID <secsgem.secs.data_items.DATAID>`
- :class:`RPTID <secsgem.secs.data_items.RPTID>`
- :class:`VID <secsgem.secs.data_items.VID>`
**Structure**::
>>> import secsgem.secs
>>> secsgem.secs.functions.SecsS02F33
{
DATAID: U1/U2/U4/U8/I1/I2/I4/I8/A
DATA: [
{
RPTID: U1/U2/U4/U8/I1/I2/I4/I8/A
VID: [
DATA: U1/U2/U4/U8/I1/I2/I4/I8/A
...
]
}
...
]
}
**Example**::
>>> import secsgem.secs
>>> secsgem.secs.functions.SecsS02F33({"DATAID": 1, "DATA": [{"RPTID": 1000, "VID": [12, 1337]},
... {"RPTID": 1001, "VID": [1, 2355]}]})
S2F33 W
<L [2]
<U1 1 >
<L [2]
<L [2]
<U2 1000 >
<L [2]
<U1 12 >
<U2 1337 >
>
>
<L [2]
<U2 1001 >
<L [2]
<U1 1 >
<U2 2355 >
>
>
>
> .
:param value: parameters for this function (see example)
:type value: dict
"""
_stream = 2
_function = 33
_data_format = [
DATAID,
[
[
RPTID,
[VID]
]
]
]
_to_host = False
_to_equipment = True
_has_reply = True
_is_reply_required = True
_is_multi_block = True