from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class MarkerCls:
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("marker", core, parent)
# noinspection PyTypeChecker
[docs]
def get_esegment(self) -> enums.ArbWaveSegmRest:
"""
``[SOURce<HW>]:BB:ARBitrary:WSEGment:CONFigure:MARKer:ESEGment`` \n
Snippet: ``value: enums.ArbWaveSegmRest = driver.source.bb.arbitrary.wsegment.configure.marker.get_esegment()`` \n
Enables/disables the generation of an additional marker restart signal at the beginning of the first segment (FSEGment)
or at the beginning of each segment (ESEGment) . If additional marker generation is enabled, the existing marker signals
in the individual segment waveform files are not considered.
:return: mode: OFF | MRK1 | MRK2 | MRK3 | MRK4
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:WSEGment:CONFigure:MARKer:ESEGment?')
return Conversions.str_to_scalar_enum(response, enums.ArbWaveSegmRest)
[docs]
def set_esegment(self, mode: enums.ArbWaveSegmRest) -> None:
"""
``[SOURce<HW>]:BB:ARBitrary:WSEGment:CONFigure:MARKer:ESEGment`` \n
Snippet: ``driver.source.bb.arbitrary.wsegment.configure.marker.set_esegment(mode = enums.ArbWaveSegmRest.MRK1)`` \n
Enables/disables the generation of an additional marker restart signal at the beginning of the first segment (FSEGment)
or at the beginning of each segment (ESEGment) . If additional marker generation is enabled, the existing marker signals
in the individual segment waveform files are not considered.
:param mode: OFF | MRK1 | MRK2 | MRK3 | MRK4
"""
param = Conversions.enum_scalar_to_str(mode, enums.ArbWaveSegmRest)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:WSEGment:CONFigure:MARKer:ESEGment {param}')
# noinspection PyTypeChecker
[docs]
def get_fsegment(self) -> enums.ArbWaveSegmRest:
"""
``[SOURce<HW>]:BB:ARBitrary:WSEGment:CONFigure:MARKer:FSEGment`` \n
Snippet: ``value: enums.ArbWaveSegmRest = driver.source.bb.arbitrary.wsegment.configure.marker.get_fsegment()`` \n
Enables/disables the generation of an additional marker restart signal at the beginning of the first segment (FSEGment)
or at the beginning of each segment (ESEGment) . If additional marker generation is enabled, the existing marker signals
in the individual segment waveform files are not considered.
:return: mode: OFF | MRK1 | MRK2 | MRK3 | MRK4
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:WSEGment:CONFigure:MARKer:FSEGment?')
return Conversions.str_to_scalar_enum(response, enums.ArbWaveSegmRest)
[docs]
def set_fsegment(self, mode: enums.ArbWaveSegmRest) -> None:
"""
``[SOURce<HW>]:BB:ARBitrary:WSEGment:CONFigure:MARKer:FSEGment`` \n
Snippet: ``driver.source.bb.arbitrary.wsegment.configure.marker.set_fsegment(mode = enums.ArbWaveSegmRest.MRK1)`` \n
Enables/disables the generation of an additional marker restart signal at the beginning of the first segment (FSEGment)
or at the beginning of each segment (ESEGment) . If additional marker generation is enabled, the existing marker signals
in the individual segment waveform files are not considered.
:param mode: OFF | MRK1 | MRK2 | MRK3 | MRK4
"""
param = Conversions.enum_scalar_to_str(mode, enums.ArbWaveSegmRest)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:WSEGment:CONFigure:MARKer:FSEGment {param}')
# noinspection PyTypeChecker
[docs]
def get_mode(self) -> enums.ArbWaveSegmMarkMode:
"""
``[SOURce<HW>]:BB:ARBitrary:WSEGment:CONFigure:MARKer:MODE`` \n
Snippet: ``value: enums.ArbWaveSegmMarkMode = driver.source.bb.arbitrary.wsegment.configure.marker.get_mode()`` \n
Defines the way the marker information within the separate segments is processed.
:return: mode: IGNore | TAKE
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:WSEGment:CONFigure:MARKer:MODE?')
return Conversions.str_to_scalar_enum(response, enums.ArbWaveSegmMarkMode)
[docs]
def set_mode(self, mode: enums.ArbWaveSegmMarkMode) -> None:
"""
``[SOURce<HW>]:BB:ARBitrary:WSEGment:CONFigure:MARKer:MODE`` \n
Snippet: ``driver.source.bb.arbitrary.wsegment.configure.marker.set_mode(mode = enums.ArbWaveSegmMarkMode.IGNore)`` \n
Defines the way the marker information within the separate segments is processed.
:param mode: IGNore | TAKE
"""
param = Conversions.enum_scalar_to_str(mode, enums.ArbWaveSegmMarkMode)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:WSEGment:CONFigure:MARKer:MODE {param}')