from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Types import DataType
from ......Internal.Utilities import trim_str_response
from ......Internal.ArgSingleList import ArgSingleList
from ......Internal.ArgSingle import ArgSingle
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DataCls:
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("data", core, parent)
[docs]
def set(self, data: str) -> None:
"""
``[SOURce<HW>]:BB:DM:DLISt:DATA`` \n
Snippet: ``driver.source.bb.dm.dlist.data.set(data = rawAbc)`` \n
The setting command sends the bit data to the selected data list. Any existing content in the list is overwritten. This
command only writes data into the data section of the file. Data can be sent as block data in binary or packet format
(FORMat ASCii | PACKed) , each byte being interpreted as 8 data bits. When binary data transmission is in use, use the
command SYSTem:COMMunicate:GPIB:LTERminator EOI to set the termination character mode to 'EOI control data message only'
so that a random LF in the data sequence is not interpreted as End, thereby prematurely terminating the data transmission.
The command ...LTER STAN resets the mode. According to the specifications, the byte sequence is defined as 'most
significant byte first'. The query command reads out the data part of the list file. If the query is expanded by using
the two parameters <Start> and <Count>, the list is read out in smaller sections. Without the parameters, the total
length is always read out starting from address 1. The command ``*RST`` has no effect on data lists.
:param data: integer bit data
"""
param = Conversions.value_to_str(data)
self._core.io.write(f'SOURce<HwInstance>:BB:DM:DLISt:DATA {param}')
[docs]
def get(self, start: int=None, count: int=None) -> str:
"""
``[SOURce<HW>]:BB:DM:DLISt:DATA`` \n
Snippet: ``value: str = driver.source.bb.dm.dlist.data.get(start = 1, count = 1)`` \n
The setting command sends the bit data to the selected data list. Any existing content in the list is overwritten. This
command only writes data into the data section of the file. Data can be sent as block data in binary or packet format
(FORMat ASCii | PACKed) , each byte being interpreted as 8 data bits. When binary data transmission is in use, use the
command SYSTem:COMMunicate:GPIB:LTERminator EOI to set the termination character mode to 'EOI control data message only'
so that a random LF in the data sequence is not interpreted as End, thereby prematurely terminating the data transmission.
The command ...LTER STAN resets the mode. According to the specifications, the byte sequence is defined as 'most
significant byte first'. The query command reads out the data part of the list file. If the query is expanded by using
the two parameters <Start> and <Count>, the list is read out in smaller sections. Without the parameters, the total
length is always read out starting from address 1. The command ``*RST`` has no effect on data lists.
:param start: integer Range: 1 to 2147483647
:param count: integer Range: 1 to 2147483647
:return: data: integer bit data
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('start', start, DataType.Integer, None, is_optional=True), ArgSingle('count', count, DataType.Integer, None, is_optional=True))
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:DM:DLISt:DATA? {param}'.rstrip())
return trim_str_response(response)
[docs]
def set_append(self, bits: str) -> None:
"""
``[SOURce<HW>]:BB:DM:DLISt:DATA:APPend`` \n
Snippet: ``driver.source.bb.dm.dlist.data.set_append(bits = rawAbc)`` \n
Appends the bit data onto the end of the existing data in the selected data list. Existing content in the data list is
not overwritten. Hence, you can create long data lists piecemeal. The command cannot be used with an empty data list, for
example, a data list that has been created. Use the command method ``RsSmw.source.bb.dm.dlist.data.set()`` first and
enter modulation data in the list. The command ``*RST`` has no effect on data lists.
:param bits: 0 | 1 {,0 | 1 } | block data
"""
param = Conversions.value_to_str(bits)
self._core.io.write(f'SOURce<HwInstance>:BB:DM:DLISt:DATA:APPend {param}')