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
from .... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class TimeCls:
"""
| Commands in total: 12
| Subgroups: 3
| Direct child commands: 4
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("time", core, parent)
@property
def daylightSavingTime(self):
"""
| Commands in total: 3
| Subgroups: 1
| Direct child commands: 1
"""
if not hasattr(self, '_daylightSavingTime'):
from .DaylightSavingTime import DaylightSavingTimeCls
self._daylightSavingTime = DaylightSavingTimeCls(self._core, self._cmd_group)
return self._daylightSavingTime
@property
def hrTimer(self):
"""
| Commands in total: 3
| Subgroups: 1
| Direct child commands: 1
"""
if not hasattr(self, '_hrTimer'):
from .HrTimer import HrTimerCls
self._hrTimer = HrTimerCls(self._core, self._cmd_group)
return self._hrTimer
@property
def zone(self):
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
if not hasattr(self, '_zone'):
from .Zone import ZoneCls
self._zone = ZoneCls(self._core, self._cmd_group)
return self._zone
[docs]
def set(self, hour: int, minute: int, second: int) -> None:
"""
``SYSTem:TIME`` \n
Snippet: ``driver.system.time.set(hour = 1, minute = 1, second = 1)`` \n
Queries or sets the time for the instrument-internal clock. This is a password-protected function. Unlock the protection
level 1 to access it. See method ``RsSmw.system.protect.state.set()`` .
:param hour: integer Range: 0 to 23
:param minute: integer Range: 0 to 59
:param second: integer Range: 0 to 59
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('hour', hour, DataType.Integer), ArgSingle('minute', minute, DataType.Integer), ArgSingle('second', second, DataType.Integer))
self._core.io.write(f'SYSTem:TIME {param}'.rstrip())
# noinspection PyTypeChecker
[docs]
class TimeStruct(StructBase):
"""
Response structure. Fields: \n
- 1 Hour: int: integer Range: 0 to 23
- 2 Minute: int: integer Range: 0 to 59
- 3 Second: int: integer Range: 0 to 59
"""
__meta_args_list = [
ArgStruct.scalar_int('Hour'),
ArgStruct.scalar_int('Minute'),
ArgStruct.scalar_int('Second')]
def __init__(self):
StructBase.__init__(self, self)
self.Hour: int = None
self.Minute: int = None
self.Second: int = None
[docs]
def get(self) -> TimeStruct:
"""
``SYSTem:TIME`` \n
Snippet: ``value: TimeStruct = driver.system.time.get()`` \n
Queries or sets the time for the instrument-internal clock. This is a password-protected function. Unlock the protection
level 1 to access it. See method ``RsSmw.system.protect.state.set()`` .
:return: structure: for return value, see the help for TimeStruct structure arguments.
"""
return self._core.io.query_struct(f'SYSTem:TIME?', self.__class__.TimeStruct())
[docs]
def get_local(self) -> str:
"""
``SYSTem:TIME:LOCal`` \n
Snippet: ``value: str = driver.system.time.get_local()`` \n
No help available
"""
response = self._core.io.query_str('SYSTem:TIME:LOCal?')
return trim_str_response(response)
[docs]
def set_local(self, pseudo_string: str) -> None:
"""
``SYSTem:TIME:LOCal`` \n
Snippet: ``driver.system.time.set_local(pseudo_string = 'abc')`` \n
No help available
"""
param = Conversions.value_to_quoted_str(pseudo_string)
self._core.io.write(f'SYSTem:TIME:LOCal {param}')
# noinspection PyTypeChecker
[docs]
def get_protocol(self) -> enums.TimeProtocol:
"""
``SYSTem:TIME:PROTocol`` \n
Snippet: ``value: enums.TimeProtocol = driver.system.time.get_protocol()`` \n
Sets the date and time of the operating system.
:return: time_protocol: OFF | NONE | 0| NTP | ON | 1 NONE Sets the date and time according to the selected timezone, see method ``RsSmw.system.time.zone.catalog()`` and method ``RsSmw.system.time.zone.value()`` . NTP Sets the date and time derived from the network time protocol. To select the NTP time server, use the commands method ``RsSmw.system.ntp.hostname()`` and SYSTem:NTP:STATe.
"""
response = self._core.io.query_str('SYSTem:TIME:PROTocol?')
return Conversions.str_to_scalar_enum(response, enums.TimeProtocol)
[docs]
def set_protocol(self, time_protocol: enums.TimeProtocol) -> None:
"""
``SYSTem:TIME:PROTocol`` \n
Snippet: ``driver.system.time.set_protocol(time_protocol = enums.TimeProtocol._0)`` \n
Sets the date and time of the operating system.
:param time_protocol: OFF | NONE | 0| NTP | ON | 1 NONE Sets the date and time according to the selected timezone, see method ``RsSmw.system.time.zone.catalog()`` and method ``RsSmw.system.time.zone.value()`` . NTP Sets the date and time derived from the network time protocol. To select the NTP time server, use the commands method ``RsSmw.system.ntp.hostname()`` and SYSTem:NTP:STATe.
"""
param = Conversions.enum_scalar_to_str(time_protocol, enums.TimeProtocol)
self._core.io.write(f'SYSTem:TIME:PROTocol {param}')
[docs]
def get_utc(self) -> str:
"""
``SYSTem:TIME:UTC`` \n
Snippet: ``value: str = driver.system.time.get_utc()`` \n
No help available
"""
response = self._core.io.query_str('SYSTem:TIME:UTC?')
return trim_str_response(response)
[docs]
def set_utc(self, pseudo_string: str) -> None:
"""
``SYSTem:TIME:UTC`` \n
Snippet: ``driver.system.time.set_utc(pseudo_string = 'abc')`` \n
No help available
"""
param = Conversions.value_to_quoted_str(pseudo_string)
self._core.io.write(f'SYSTem:TIME:UTC {param}')
def clone(self) -> 'TimeCls':
"""
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 = TimeCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group