Source code for RsSmw.Implementations.HardCopy.File.Name.Auto

from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Utilities import trim_str_response


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class AutoCls: """Auto commands group definition. 11 total commands, 2 Subgroups, 2 group commands""" def __init__(self, core: Core, parent): self._core = core self._cmd_group = CommandsGroup("auto", core, parent) @property def directory(self): """directory commands group. 0 Sub-classes, 2 commands.""" if not hasattr(self, '_directory'): from .Directory import DirectoryCls self._directory = DirectoryCls(self._core, self._cmd_group) return self._directory @property def file(self): """file commands group. 4 Sub-classes, 2 commands.""" if not hasattr(self, '_file'): from .File import FileCls self._file = FileCls(self._core, self._cmd_group) return self._file
[docs] def get_state(self) -> bool: """SCPI: HCOPy:FILE:[NAME]:AUTO:STATe \n Snippet: value: bool = driver.hardCopy.file.name.auto.get_state() \n Activates automatic naming of the hard copy files. \n :return: state: 1| ON| 0| OFF """ response = self._core.io.query_str('HCOPy:FILE:NAME:AUTO:STATe?') return Conversions.str_to_bool(response)
[docs] def set_state(self, state: bool) -> None: """SCPI: HCOPy:FILE:[NAME]:AUTO:STATe \n Snippet: driver.hardCopy.file.name.auto.set_state(state = False) \n Activates automatic naming of the hard copy files. \n :param state: 1| ON| 0| OFF """ param = Conversions.bool_to_str(state) self._core.io.write(f'HCOPy:FILE:NAME:AUTO:STATe {param}')
[docs] def get_value(self) -> str: """SCPI: HCOPy:FILE:[NAME]:AUTO \n Snippet: value: str = driver.hardCopy.file.name.auto.get_value() \n Queries path and file name of the hardcopy file, if you have enabled Automatic Naming. \n :return: auto: string """ response = self._core.io.query_str('HCOPy:FILE:NAME:AUTO?') return trim_str_response(response)
def clone(self) -> 'AutoCls': """Clones the group by creating new object from it and its whole existing subgroups Also copies all the existing default Repeated Capabilities setting, which you can change independently without affecting the original group""" new_group = AutoCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group