from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class YearCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("year", core, parent)
[docs]
def get_state(self) -> bool:
"""
``HCOPy:FILE:[NAME]:AUTO:[FILE]:YEAR:STATe`` \n
Snippet: ``value: bool = driver.hardCopy.file.name.auto.file.year.get_state()`` \n
Uses the date parameters (year, month or day) for the automatic naming. You can activate each of the date parameters
separately.
:return: state: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('HCOPy:FILE:NAME:AUTO:FILE:YEAR:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, state: bool) -> None:
"""
``HCOPy:FILE:[NAME]:AUTO:[FILE]:YEAR:STATe`` \n
Snippet: ``driver.hardCopy.file.name.auto.file.year.set_state(state = False)`` \n
Uses the date parameters (year, month or day) for the automatic naming. You can activate each of the date parameters
separately.
:param state: 1 | ON | 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'HCOPy:FILE:NAME:AUTO:FILE:YEAR:STATe {param}')