from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ValidCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("valid", core, parent)
[docs]
def get(self, zone=repcap.Zone.Default, area=repcap.Area.Default, point=repcap.Point.Default) -> bool:
"""
``ZONE<*>:AREA<*>:POINt<*>:VALid`` \n
Snippet: ``value: bool = driver.zone.area.point.valid.get(zone = repcap.Zone.Default, area = repcap.Area.Default, point = repcap.Point.Default)`` \n
Checks the validity of the selected point. See Figure 'Invalid zone area (left) and valid zone area (right) '.
:param zone: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Zone')
:param area: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Area')
:param point: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Point')
:return: valid: OFF | ON
"""
zone_cmd_val = self._cmd_group.get_repcap_cmd_value(zone, repcap.Zone)
area_cmd_val = self._cmd_group.get_repcap_cmd_value(area, repcap.Area)
point_cmd_val = self._cmd_group.get_repcap_cmd_value(point, repcap.Point)
response = self._core.io.query_str(f'ZONE{zone_cmd_val}:AREA{area_cmd_val}:POINt{point_cmd_val}:VALid?')
return Conversions.str_to_bool(response)