from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class HighlightCls:
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("highlight", core, parent)
[docs]
def get_state(self) -> bool:
"""
``MTESt:HIGHlight:STATe`` \n
Snippet: ``value: bool = driver.mtest.highlight.get_state()`` \n
If ON, the mask hits are highlighted on the screen. You can define the color and the time of the hit display.
:return: highlight_hits: OFF | ON
"""
response = self._core.io.query_str_with_opc('MTESt:HIGHlight:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, highlight_hits: bool) -> None:
"""
``MTESt:HIGHlight:STATe`` \n
Snippet: ``driver.mtest.highlight.set_state(highlight_hits = False)`` \n
If ON, the mask hits are highlighted on the screen. You can define the color and the time of the hit display.
:param highlight_hits: OFF | ON
"""
param = Conversions.bool_to_str(highlight_hits)
self._core.io.write_with_opc(f'MTESt:HIGHlight:STATe {param}')
[docs]
def get_infinite(self) -> bool:
"""
``MTESt:HIGHlight:INFinite`` \n
Snippet: ``value: bool = driver.mtest.highlight.get_infinite()`` \n
If ON, the mask hits are highlighted for an unlimited period of time.
"""
response = self._core.io.query_str_with_opc('MTESt:HIGHlight:INFinite?')
return Conversions.str_to_bool(response)
[docs]
def set_infinite(self, inf_highlight: bool) -> None:
"""
``MTESt:HIGHlight:INFinite`` \n
Snippet: ``driver.mtest.highlight.set_infinite(inf_highlight = False)`` \n
If ON, the mask hits are highlighted for an unlimited period of time.
:param inf_highlight: OFF | ON
"""
param = Conversions.bool_to_str(inf_highlight)
self._core.io.write_with_opc(f'MTESt:HIGHlight:INFinite {param}')
[docs]
def get_time(self) -> float:
"""
``MTESt:HIGHlight:TIME`` \n
Snippet: ``value: float = driver.mtest.highlight.get_time()`` \n
Sets the time how long the mask hits are highlighted.
:return: highlight_time: 0.05 to 50
"""
response = self._core.io.query_str_with_opc('MTESt:HIGHlight:TIME?')
return Conversions.str_to_float(response)
[docs]
def set_time(self, highlight_time: float) -> None:
"""
``MTESt:HIGHlight:TIME`` \n
Snippet: ``driver.mtest.highlight.set_time(highlight_time = 1.0)`` \n
Sets the time how long the mask hits are highlighted.
:param highlight_time: 0.05 to 50
"""
param = Conversions.decimal_value_to_str(highlight_time)
self._core.io.write_with_opc(f'MTESt:HIGHlight:TIME {param}')