from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Types import DataType
from ......Internal.ArgSingleList import ArgSingleList
from ......Internal.ArgSingle import ArgSingle
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class WidthCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("width", core, parent)
[docs]
def set(self, search: str, width: float) -> None:
"""
``SEARch:TRIGger:PATTern:WIDTh[:WIDTh]`` \n
Snippet: ``driver.search.trigger.pattern.width.width.set(search = 'abc', width = 1.0)`` \n
For the ranges WITHin and OUTSide, the width defines the center of a range that is defined by the limits ±delta. For the
ranges SHORter and LONGer, the width defines the maximum and minimum pulse width, respectively. To set the range mode,
use method ``RsRtx.search.trigger.pattern.width.range.set()`` . To set the delta value, use method
``RsRtx.search.trigger.pattern.width.delta.set()`` .
:param search: String with the name of the search
:param width: 100E-12 to 864
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('search', search, DataType.String), ArgSingle('width', width, DataType.Float))
self._core.io.write_with_opc(f'SEARch:TRIGger:PATTern:WIDTh:WIDTh {param}'.rstrip())
[docs]
def get(self, search: str) -> float:
"""
``SEARch:TRIGger:PATTern:WIDTh[:WIDTh]`` \n
Snippet: ``value: float = driver.search.trigger.pattern.width.width.get(search = 'abc')`` \n
For the ranges WITHin and OUTSide, the width defines the center of a range that is defined by the limits ±delta. For the
ranges SHORter and LONGer, the width defines the maximum and minimum pulse width, respectively. To set the range mode,
use method ``RsRtx.search.trigger.pattern.width.range.set()`` . To set the delta value, use method
``RsRtx.search.trigger.pattern.width.delta.set()`` .
:param search: String with the name of the search
:return: width: 100E-12 to 864
"""
param = Conversions.value_to_quoted_str(search)
response = self._core.io.query_str_with_opc(f'SEARch:TRIGger:PATTern:WIDTh:WIDTh? {param}')
return Conversions.str_to_float(response)