from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal.StructBase import StructBase
from ......Internal.ArgStruct import ArgStruct
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class FilterPyCls:
"""FilterPy commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("filterPy", core, parent)
# noinspection PyTypeChecker
[docs] class FilterPyStruct(StructBase):
"""Structure for setting input parameters. Fields: \n
- Binput: bool: No parameter help available
- Boutput: bool: No parameter help available
- Berror: bool: No parameter help available
- Btrigger: bool: No parameter help available
- Bdevice_Clear: bool: No parameter help available
- Bstatus_Register: bool: No parameter help available
- Bconnection: bool: No parameter help available
- Bremote_Local_Events: bool: No parameter help available"""
__meta_args_list = [
ArgStruct.scalar_bool('Binput'),
ArgStruct.scalar_bool('Boutput'),
ArgStruct.scalar_bool('Berror'),
ArgStruct.scalar_bool('Btrigger'),
ArgStruct.scalar_bool('Bdevice_Clear'),
ArgStruct.scalar_bool('Bstatus_Register'),
ArgStruct.scalar_bool('Bconnection'),
ArgStruct.scalar_bool('Bremote_Local_Events')]
def __init__(self):
StructBase.__init__(self, self)
self.Binput: bool = None
self.Boutput: bool = None
self.Berror: bool = None
self.Btrigger: bool = None
self.Bdevice_Clear: bool = None
self.Bstatus_Register: bool = None
self.Bconnection: bool = None
self.Bremote_Local_Events: bool = None
[docs] def set(self, structure: FilterPyStruct, instrument=repcap.Instrument.Default) -> None:
"""SCPI: TRACe:REMote:MODE:FILE<instrument>:FILTer \n
Snippet with structure: \n
structure = driver.trace.remote.mode.file.filterPy.FilterPyStruct() \n
structure.Binput: bool = False \n
structure.Boutput: bool = False \n
structure.Berror: bool = False \n
structure.Btrigger: bool = False \n
structure.Bdevice_Clear: bool = False \n
structure.Bstatus_Register: bool = False \n
structure.Bconnection: bool = False \n
structure.Bremote_Local_Events: bool = False \n
driver.trace.remote.mode.file.filterPy.set(structure, instrument = repcap.Instrument.Default) \n
Specifies a filter for tracing of the remote control interface. The filter defines which message types and events are
traced to a file. \n
:param structure: for set value, see the help for FilterPyStruct structure arguments.
:param instrument: optional repeated capability selector. Default value: Nr1 (settable in the interface 'File')
"""
instrument_cmd_val = self._cmd_group.get_repcap_cmd_value(instrument, repcap.Instrument)
self._core.io.write_struct(f'TRACe:REMote:MODE:FILE{instrument_cmd_val}:FILTer', structure)
[docs] def get(self, instrument=repcap.Instrument.Default) -> FilterPyStruct:
"""SCPI: TRACe:REMote:MODE:FILE<instrument>:FILTer \n
Snippet: value: FilterPyStruct = driver.trace.remote.mode.file.filterPy.get(instrument = repcap.Instrument.Default) \n
Specifies a filter for tracing of the remote control interface. The filter defines which message types and events are
traced to a file. \n
:param instrument: optional repeated capability selector. Default value: Nr1 (settable in the interface 'File')
:return: structure: for return value, see the help for FilterPyStruct structure arguments."""
instrument_cmd_val = self._cmd_group.get_repcap_cmd_value(instrument, repcap.Instrument)
return self._core.io.query_struct(f'TRACe:REMote:MODE:FILE{instrument_cmd_val}:FILTer?', self.__class__.FilterPyStruct())