from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class TimeCls:
"""Time commands group definition. 8 total commands, 3 Subgroups, 5 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("time", core, parent)
@property
def date(self):
"""date commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_date'):
from .Date import DateCls
self._date = DateCls(self._core, self._cmd_group)
return self._date
@property
def time(self):
"""time commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_time'):
from .Time import TimeCls
self._time = TimeCls(self._core, self._cmd_group)
return self._time
@property
def snow(self):
"""snow commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_snow'):
from .Snow import SnowCls
self._snow = SnowCls(self._core, self._cmd_group)
return self._snow
# noinspection PyTypeChecker
[docs]
def get_tsource(self) -> enums.SourceTime:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:CELL:TIME:TSOurce \n
Snippet: value: enums.SourceTime = driver.configure.cell.time.get_tsource() \n
Selects the date and time source.
INTRO_CMD_HELP: The time source DATE is configured via the following commands: \n
- method RsCmwLteSig.Configure.Cell.Time.Date.set
- method RsCmwLteSig.Configure.Cell.Time.Time.set
- method RsCmwLteSig.Configure.Cell.Time.daylightSavingTime
- method RsCmwLteSig.Configure.Cell.Time.ltzOffset \n
:return: source_time: CMWTime | DATE CMWTime: Windows date and time DATE: Date and time specified via remote commands
"""
response = self._core.io.query_str('CONFigure:LTE:SIGNaling<Instance>:CELL:TIME:TSOurce?')
return Conversions.str_to_scalar_enum(response, enums.SourceTime)
[docs]
def set_tsource(self, source_time: enums.SourceTime) -> None:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:CELL:TIME:TSOurce \n
Snippet: driver.configure.cell.time.set_tsource(source_time = enums.SourceTime.CMWTime) \n
Selects the date and time source.
INTRO_CMD_HELP: The time source DATE is configured via the following commands: \n
- method RsCmwLteSig.Configure.Cell.Time.Date.set
- method RsCmwLteSig.Configure.Cell.Time.Time.set
- method RsCmwLteSig.Configure.Cell.Time.daylightSavingTime
- method RsCmwLteSig.Configure.Cell.Time.ltzOffset \n
:param source_time: CMWTime | DATE CMWTime: Windows date and time DATE: Date and time specified via remote commands
"""
param = Conversions.enum_scalar_to_str(source_time, enums.SourceTime)
self._core.io.write(f'CONFigure:LTE:SIGNaling<Instance>:CELL:TIME:TSOurce {param}')
# noinspection PyTypeChecker
[docs]
def get_daylight_saving_time(self) -> enums.DsTime:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:CELL:TIME:DSTime \n
Snippet: value: enums.DsTime = driver.configure.cell.time.get_daylight_saving_time() \n
Specifies a daylight saving time (DST) offset for the time source DATE (see method RsCmwLteSig.Configure.Cell.Time.
tsource) . \n
:return: enable: P1H | P2H P1H: +1h offset if DST is ON P2H: +2h offset if DST is ON Additional parameters: OFF | ON (disables | enables DST)
"""
response = self._core.io.query_str('CONFigure:LTE:SIGNaling<Instance>:CELL:TIME:DSTime?')
return Conversions.str_to_scalar_enum(response, enums.DsTime)
[docs]
def set_daylight_saving_time(self, enable: enums.DsTime) -> None:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:CELL:TIME:DSTime \n
Snippet: driver.configure.cell.time.set_daylight_saving_time(enable = enums.DsTime.OFF) \n
Specifies a daylight saving time (DST) offset for the time source DATE (see method RsCmwLteSig.Configure.Cell.Time.
tsource) . \n
:param enable: P1H | P2H P1H: +1h offset if DST is ON P2H: +2h offset if DST is ON Additional parameters: OFF | ON (disables | enables DST)
"""
param = Conversions.enum_scalar_to_str(enable, enums.DsTime)
self._core.io.write(f'CONFigure:LTE:SIGNaling<Instance>:CELL:TIME:DSTime {param}')
[docs]
def get_ltz_offset(self) -> float:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:CELL:TIME:LTZoffset \n
Snippet: value: float = driver.configure.cell.time.get_ltz_offset() \n
Specifies the time zone offset for the time source DATE (see method RsCmwLteSig.Configure.Cell.Time.tsource) . \n
:return: time_zone_offset: numeric Range: -19.75 h to 19.75 h, Unit: h
"""
response = self._core.io.query_str('CONFigure:LTE:SIGNaling<Instance>:CELL:TIME:LTZoffset?')
return Conversions.str_to_float(response)
[docs]
def set_ltz_offset(self, time_zone_offset: float) -> None:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:CELL:TIME:LTZoffset \n
Snippet: driver.configure.cell.time.set_ltz_offset(time_zone_offset = 1.0) \n
Specifies the time zone offset for the time source DATE (see method RsCmwLteSig.Configure.Cell.Time.tsource) . \n
:param time_zone_offset: numeric Range: -19.75 h to 19.75 h, Unit: h
"""
param = Conversions.decimal_value_to_str(time_zone_offset)
self._core.io.write(f'CONFigure:LTE:SIGNaling<Instance>:CELL:TIME:LTZoffset {param}')
[docs]
def get_sattach(self) -> bool:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:CELL:TIME:SATTach \n
Snippet: value: bool = driver.configure.cell.time.get_sattach() \n
Specifies whether the date and time information is sent to the UE during the attach procedure or not. \n
:return: enable: OFF | ON ON: send date and time at attach OFF: do not send date and time at attach
"""
response = self._core.io.query_str('CONFigure:LTE:SIGNaling<Instance>:CELL:TIME:SATTach?')
return Conversions.str_to_bool(response)
[docs]
def set_sattach(self, enable: bool) -> None:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:CELL:TIME:SATTach \n
Snippet: driver.configure.cell.time.set_sattach(enable = False) \n
Specifies whether the date and time information is sent to the UE during the attach procedure or not. \n
:param enable: OFF | ON ON: send date and time at attach OFF: do not send date and time at attach
"""
param = Conversions.bool_to_str(enable)
self._core.io.write(f'CONFigure:LTE:SIGNaling<Instance>:CELL:TIME:SATTach {param}')
[docs]
def get_snname(self) -> bool:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:CELL:TIME:SNName \n
Snippet: value: bool = driver.configure.cell.time.get_snname() \n
Selects whether the network name is sent together with the date and time information. \n
:return: enable: OFF | ON OFF: Do not send name ON: Send full and short network name
"""
response = self._core.io.query_str('CONFigure:LTE:SIGNaling<Instance>:CELL:TIME:SNName?')
return Conversions.str_to_bool(response)
[docs]
def set_snname(self, enable: bool) -> None:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:CELL:TIME:SNName \n
Snippet: driver.configure.cell.time.set_snname(enable = False) \n
Selects whether the network name is sent together with the date and time information. \n
:param enable: OFF | ON OFF: Do not send name ON: Send full and short network name
"""
param = Conversions.bool_to_str(enable)
self._core.io.write(f'CONFigure:LTE:SIGNaling<Instance>:CELL:TIME:SNName {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