from ........Internal.Core import Core
from ........Internal.CommandsGroup import CommandsGroup
from ........Internal.Types import DataType
from ........Internal.StructBase import StructBase
from ........Internal.ArgStruct import ArgStruct
from ........Internal.ArgSingleList import ArgSingleList
from ........Internal.ArgSingle import ArgSingle
from ........ import enums
from ........ import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PmStimeCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("pmStime", core, parent)
[docs]
def set(self, state: bool, scaling: enums.TimeScaling=None, window=repcap.Window.Default) -> None:
"""
``CALCulate<n>:HOPDetection:TABLe:PMSettling:PMSTime`` \n
Snippet: ``driver.applications.k60Transient.calculate.hopDetection.table.pmSettling.pmStime.set(state = False, scaling = enums.TimeScaling.MS, window = repcap.Window.Default)`` \n
If enabled, the PM settling time parameter is included in the result tables (see 'PM settling time') . Note that only the
enabled columns are returned for the method
``RsFsw.applications.k60Transient.calculate.hopDetection.table.results.get()`` query.
:param state: ON | OFF | 0 | 1 OFF | 0 Switches the function off ON | 1 Switches the function on
:param scaling: S | MS | US | NS Defines the scaling for the FM settling parameters
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('state', state, DataType.Boolean), ArgSingle('scaling', scaling, DataType.Enum, enums.TimeScaling, is_optional=True))
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
self._core.io.write(f'CALCulate{window_cmd_val}:HOPDetection:TABLe:PMSettling:PMSTime {param}'.rstrip())
# noinspection PyTypeChecker
[docs]
class PmStimeStruct(StructBase):
"""
Response structure. Fields: \n
- 1 State: bool: ON | OFF | 0 | 1 OFF | 0 Switches the function off ON | 1 Switches the function on
- 2 Scaling: enums.TimeScaling: S | MS | US | NS Defines the scaling for the FM settling parameters
"""
__meta_args_list = [
ArgStruct.scalar_bool('State'),
ArgStruct.scalar_enum('Scaling', enums.TimeScaling)]
def __init__(self):
StructBase.__init__(self, self)
self.State: bool = None
self.Scaling: enums.TimeScaling = None
[docs]
def get(self, window=repcap.Window.Default) -> PmStimeStruct:
"""
``CALCulate<n>:HOPDetection:TABLe:PMSettling:PMSTime`` \n
Snippet: ``value: PmStimeStruct = driver.applications.k60Transient.calculate.hopDetection.table.pmSettling.pmStime.get(window = repcap.Window.Default)`` \n
If enabled, the PM settling time parameter is included in the result tables (see 'PM settling time') . Note that only the
enabled columns are returned for the method
``RsFsw.applications.k60Transient.calculate.hopDetection.table.results.get()`` query.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:return: structure: for return value, see the help for PmStimeStruct structure arguments.
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
return self._core.io.query_struct(f'CALCulate{window_cmd_val}:HOPDetection:TABLe:PMSettling:PMSTime?', self.__class__.PmStimeStruct())