Source code for RsAreg800.Implementations.System.Date

from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
from ...Internal.Types import DataType
from ...Internal.Utilities import trim_str_response
from ...Internal.StructBase import StructBase
from ...Internal.ArgStruct import ArgStruct
from ...Internal.ArgSingleList import ArgSingleList
from ...Internal.ArgSingle import ArgSingle


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs] class DateCls: """Date commands group definition. 3 total commands, 0 Subgroups, 3 group commands""" def __init__(self, core: Core, parent): self._core = core self._cmd_group = CommandsGroup("date", core, parent)
[docs] def set(self, year: int, month: int, day: int) -> None: """SCPI: SYSTem:DATE \n Snippet: driver.system.date.set(year = 1, month = 1, day = 1) \n Queries or sets the date for the instrument-internal calendar. This is a password-protected function. Unlock the protection level 1 to access it. See method RsAreg800.System.Protect.State.set. \n :param year: No help available :param month: No help available :param day: No help available """ param = ArgSingleList().compose_cmd_string(ArgSingle('year', year, DataType.Integer), ArgSingle('month', month, DataType.Integer), ArgSingle('day', day, DataType.Integer)) self._core.io.write(f'SYSTem:DATE {param}'.rstrip())
# noinspection PyTypeChecker
[docs] class DateStruct(StructBase): """Response structure. Fields: \n - Year: int: No parameter help available - Month: int: No parameter help available - Day: int: No parameter help available""" __meta_args_list = [ ArgStruct.scalar_int('Year'), ArgStruct.scalar_int('Month'), ArgStruct.scalar_int('Day')] def __init__(self): StructBase.__init__(self, self) self.Year: int = None self.Month: int = None self.Day: int = None
[docs] def get(self) -> DateStruct: """SCPI: SYSTem:DATE \n Snippet: value: DateStruct = driver.system.date.get() \n Queries or sets the date for the instrument-internal calendar. This is a password-protected function. Unlock the protection level 1 to access it. See method RsAreg800.System.Protect.State.set. \n :return: structure: for return value, see the help for DateStruct structure arguments.""" return self._core.io.query_struct(f'SYSTem:DATE?', self.__class__.DateStruct())
[docs] def get_local(self) -> str: """SCPI: SYSTem:DATE:LOCal \n Snippet: value: str = driver.system.date.get_local() \n No command help available \n :return: pseudo_string: No help available """ response = self._core.io.query_str('SYSTem:DATE:LOCal?') return trim_str_response(response)
[docs] def set_local(self, pseudo_string: str) -> None: """SCPI: SYSTem:DATE:LOCal \n Snippet: driver.system.date.set_local(pseudo_string = 'abc') \n No command help available \n :param pseudo_string: No help available """ param = Conversions.value_to_quoted_str(pseudo_string) self._core.io.write(f'SYSTem:DATE:LOCal {param}')
[docs] def get_utc(self) -> str: """SCPI: SYSTem:DATE:UTC \n Snippet: value: str = driver.system.date.get_utc() \n No command help available \n :return: pseudo_string: No help available """ response = self._core.io.query_str('SYSTem:DATE:UTC?') return trim_str_response(response)
[docs] def set_utc(self, pseudo_string: str) -> None: """SCPI: SYSTem:DATE:UTC \n Snippet: driver.system.date.set_utc(pseudo_string = 'abc') \n No command help available \n :param pseudo_string: No help available """ param = Conversions.value_to_quoted_str(pseudo_string) self._core.io.write(f'SYSTem:DATE:UTC {param}')