Source code for rsrtx.Implementations.Export.Waveform
from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from ....Internal.Utilities import trim_str_response
from .... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class WaveformCls:
"""
| Commands in total: 17
| Subgroups: 2
| Direct child commands: 15
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("waveform", core, parent)
@property
def zoom(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_zoom'):
from .Zoom import ZoomCls
self._zoom = ZoomCls(self._core, self._cmd_group)
return self._zoom
@property
def fastExport(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_fastExport'):
from .FastExport import FastExportCls
self._fastExport = FastExportCls(self._core, self._cmd_group)
return self._fastExport
# noinspection PyTypeChecker
[docs]
def get_scope(self) -> enums.WaveformExportScope:
"""
``EXPort:WAVeform:SCOPe`` \n
Snippet: ``value: enums.WaveformExportScope = driver.export.waveform.get_scope()`` \n
Defines the part of the waveform record that has to be stored.
:return: scope: WFM | ZOOM | CURSor | GATE | MANual \n
- WFM: Complete waveform
- ZOOM: Data included in the zoom area if a zoom is defined for the source waveform.
- CURSor: Data between the cursor lines if a cursor measurement is defined for the source waveform.
- GATE: data included in the measurement gate if a gated measurement is defined for the source waveform.
- MANual: Saves the data between user-defined start and stop values to be set with EXPort:WAVeform:STARt and EXPort:WAVeform:STOP.
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:SCOPe?')
return Conversions.str_to_scalar_enum(response, enums.WaveformExportScope)
[docs]
def set_scope(self, scope: enums.WaveformExportScope) -> None:
"""
``EXPort:WAVeform:SCOPe`` \n
Snippet: ``driver.export.waveform.set_scope(scope = enums.WaveformExportScope.CURSor)`` \n
Defines the part of the waveform record that has to be stored.
:param scope: WFM | ZOOM | CURSor | GATE | MANual \n
- WFM: Complete waveform
- ZOOM: Data included in the zoom area if a zoom is defined for the source waveform.
- CURSor: Data between the cursor lines if a cursor measurement is defined for the source waveform.
- GATE: data included in the measurement gate if a gated measurement is defined for the source waveform.
- MANual: Saves the data between user-defined start and stop values to be set with EXPort:WAVeform:STARt and EXPort:WAVeform:STOP.
"""
param = Conversions.enum_scalar_to_str(scope, enums.WaveformExportScope)
self._core.io.write_with_opc(f'EXPort:WAVeform:SCOPe {param}')
# noinspection PyTypeChecker
[docs]
def get_cursor_set(self) -> enums.CursorSet:
"""
``EXPort:WAVeform:CURSorset`` \n
Snippet: ``value: enums.CursorSet = driver.export.waveform.get_cursor_set()`` \n
Sets the cursor set to be used for limited data export if method ``RsRtx.export.waveform.scope()`` is set to CURSor.
:return: cursor_set: CURSOR1 = CURSor1, CURSOR2 = CURSor2, CURSOR3 = CURSor3, CURSOR4 = CURSor4
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:CURSorset?')
return Conversions.str_to_scalar_enum(response, enums.CursorSet)
[docs]
def set_cursor_set(self, cursor_set: enums.CursorSet) -> None:
"""
``EXPort:WAVeform:CURSorset`` \n
Snippet: ``driver.export.waveform.set_cursor_set(cursor_set = enums.CursorSet.CURSOR1)`` \n
Sets the cursor set to be used for limited data export if method ``RsRtx.export.waveform.scope()`` is set to CURSor.
:param cursor_set: CURSOR1 = CURSor1, CURSOR2 = CURSor2, CURSOR3 = CURSor3, CURSOR4 = CURSor4
"""
param = Conversions.enum_scalar_to_str(cursor_set, enums.CursorSet)
self._core.io.write_with_opc(f'EXPort:WAVeform:CURSorset {param}')
# noinspection PyTypeChecker
[docs]
def get_meas(self) -> enums.ArithmeticMeasGroup:
"""
``EXPort:WAVeform:MEAS`` \n
Snippet: ``value: enums.ArithmeticMeasGroup = driver.export.waveform.get_meas()`` \n
Sets the gate to be used for limited data export if method ``RsRtx.export.waveform.scope()`` is set to GATE.
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:MEAS?')
return Conversions.str_to_scalar_enum(response, enums.ArithmeticMeasGroup)
[docs]
def set_meas(self, meas_gte: enums.ArithmeticMeasGroup) -> None:
"""
``EXPort:WAVeform:MEAS`` \n
Snippet: ``driver.export.waveform.set_meas(meas_gte = enums.ArithmeticMeasGroup.IMEAS)`` \n
Sets the gate to be used for limited data export if method ``RsRtx.export.waveform.scope()`` is set to GATE.
:param meas_gte: Measurement for which the gate is defined.
"""
param = Conversions.enum_scalar_to_str(meas_gte, enums.ArithmeticMeasGroup)
self._core.io.write_with_opc(f'EXPort:WAVeform:MEAS {param}')
[docs]
def get_start(self) -> float:
"""
``EXPort:WAVeform:STARt`` \n
Snippet: ``value: float = driver.export.waveform.get_start()`` \n
Sets the start value of the waveform section for export, if method ``RsRtx.export.waveform.scope()`` is set to Manual.
:return: start: -100E+24 to 100E+24
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:STARt?')
return Conversions.str_to_float(response)
[docs]
def set_start(self, start: float) -> None:
"""
``EXPort:WAVeform:STARt`` \n
Snippet: ``driver.export.waveform.set_start(start = 1.0)`` \n
Sets the start value of the waveform section for export, if method ``RsRtx.export.waveform.scope()`` is set to Manual.
:param start: -100E+24 to 100E+24
"""
param = Conversions.decimal_value_to_str(start)
self._core.io.write_with_opc(f'EXPort:WAVeform:STARt {param}')
[docs]
def get_stop(self) -> float:
"""
``EXPort:WAVeform:STOP`` \n
Snippet: ``value: float = driver.export.waveform.get_stop()`` \n
Sets the end value of the waveform section for export, if method ``RsRtx.export.waveform.scope()`` is set to Manual.
:return: stop: -100E+24 to 100E+24
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:STOP?')
return Conversions.str_to_float(response)
[docs]
def set_stop(self, stop: float) -> None:
"""
``EXPort:WAVeform:STOP`` \n
Snippet: ``driver.export.waveform.set_stop(stop = 1.0)`` \n
Sets the end value of the waveform section for export, if method ``RsRtx.export.waveform.scope()`` is set to Manual.
:param stop: -100E+24 to 100E+24
"""
param = Conversions.decimal_value_to_str(stop)
self._core.io.write_with_opc(f'EXPort:WAVeform:STOP {param}')
[docs]
def save(self) -> None:
"""
``EXPort:WAVeform:SAVE`` \n
Snippet: ``driver.export.waveform.save()`` \n
Saves the waveform(s) to the file specified with method ``RsRtx.export.waveform.name()`` . The file format is also set
using the ...NAME command.
"""
self._core.io.write(f'EXPort:WAVeform:SAVE')
[docs]
def save_and_wait(self, opc_timeout_ms: int = -1) -> None:
"""
``EXPort:WAVeform:SAVE`` \n
Snippet: ``driver.export.waveform.save_and_wait()`` \n
Saves the waveform(s) to the file specified with method ``RsRtx.export.waveform.name()`` . The file format is also set
using the ...NAME command.
Same as save, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value.
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'EXPort:WAVeform:SAVE', opc_timeout_ms)
# noinspection PyTypeChecker
[docs]
def get_source(self) -> enums.SignalSource:
"""
``EXPort:WAVeform:SOURce`` \n
Snippet: ``value: enums.SignalSource = driver.export.waveform.get_source()`` \n
Selects the waveform to be exported to file. The commands takes effect if method
``RsRtx.export.waveform.multi_channel()`` is OFF.
:return: source: C1W1 | C1W2 | C1W3 | C2W1 | C2W2 | C2W3 | C3W1 | C3W2 | C3W3 | C4W1 | C4W2 | C4W3 | M1 | M2 | M3 | M4 | M5 | M6 | M7 | M8 | R1 | R2 | R3 | R4 | D0 | D1 | D2 | D3 | D4 | D5 | D6 | D7 | D8 | D9 | D10 | D11 | D12 | D13 | D14 | D15 | MSOB1 | MSOB2 | MSOB3 | MSOB4 | TRK1 | TRK2 | TRK3 | TRK4 | TRK5 | TRK6 | TRK7 | TRK8 | Z1V1 | Z1V2 | Z1V3 | Z1V4 | Z1I1 | Z1I2 | Z1I3 | Z1I4 | Z2V1 | Z2V2 | Z2V3 | Z2V4 | Z2I1 | Z2I2 | Z2I3 | Z2I4 | DIFF1 | DIFF2 | COMMON1 | COMMON2 | BATHtub1 | BMEas1 | SRESponse1 | SRHist1 | SDHist1 | TJHist1 | DJHist1 | DDJHist1 | PJHist1 | RJOHist1 | SRTRack1 | SDTRack1 | TJTRack1 | DJTRack1 | DDJTrack1 | PJTRack1 | RJOTrack1 | TJSPectrum1 | DDJSpectrum1 | PJSPectrum1 | RJOSpectrum1 | SEYE1 | BATHtub2 | BMEas2 | SRESponse2 | SRHist2 | SDHist2 | TJHist2 | DJHist2 | DDJHist2 | PJHist2 | RJOHist2 | SRTRack2 | SDTRack2 | TJTRack2 | DJTRack2 | DDJTrack2 | PJTRack2 | RJOTrack2 | TJSPectrum2 | DDJSpectrum2 | PJSPectrum2 | RJOSpectrum2 | SEYE2 | NBAThtub1 | NBMeas1 | TNHist1 | DNHist1 | DDNHist1 | PNHist1 | RNOHist1 | TNTRack1 | DNTRack1 | DDNTrack1 | PNTRack1 | RNOTrack1 | TNSPectrum1 | DDNSpectrum1 | PNSPectrum1 | RNOSpectrum1 | NBAThtub2 | NBMeas2 | TNHist2 | DNHist2 | DDNHist2 | PNHist2 | RNOHist2 | TNTRack2 | DNTRack2 | DDNTrack2 | PNTRack2 | RNOTrack2 | TNSPectrum2 | DDNSpectrum2 | PNSPectrum2 | RNOSpectrum2 | PJDHist1 | BUJHist1 | RJHist1 | PJDTrack1 | PJDSpectrum1 | PJDHist2 | BUJHist2 | RJHist2 | PJDTrack2 | PJDSpectrum2 | PNDHist1 | BUNHist1 | RNHist1 | PNDTrack1 | PNDSpectrum1 | PNDHist2 | BUNHist2 | RNHist2 | PNDTrack2 | PNDSpectrum2 | LANE1 | LANE2 | LANE3 | LANE4
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:SOURce?')
return Conversions.str_to_scalar_enum(response, enums.SignalSource)
[docs]
def set_source(self, source: enums.SignalSource) -> None:
"""
``EXPort:WAVeform:SOURce`` \n
Snippet: ``driver.export.waveform.set_source(source = enums.SignalSource.AJ1)`` \n
Selects the waveform to be exported to file. The commands takes effect if method
``RsRtx.export.waveform.multi_channel()`` is OFF.
:param source: C1W1 | C1W2 | C1W3 | C2W1 | C2W2 | C2W3 | C3W1 | C3W2 | C3W3 | C4W1 | C4W2 | C4W3 | M1 | M2 | M3 | M4 | M5 | M6 | M7 | M8 | R1 | R2 | R3 | R4 | D0 | D1 | D2 | D3 | D4 | D5 | D6 | D7 | D8 | D9 | D10 | D11 | D12 | D13 | D14 | D15 | MSOB1 | MSOB2 | MSOB3 | MSOB4 | TRK1 | TRK2 | TRK3 | TRK4 | TRK5 | TRK6 | TRK7 | TRK8 | Z1V1 | Z1V2 | Z1V3 | Z1V4 | Z1I1 | Z1I2 | Z1I3 | Z1I4 | Z2V1 | Z2V2 | Z2V3 | Z2V4 | Z2I1 | Z2I2 | Z2I3 | Z2I4 | DIFF1 | DIFF2 | COMMON1 | COMMON2 | BATHtub1 | BMEas1 | SRESponse1 | SRHist1 | SDHist1 | TJHist1 | DJHist1 | DDJHist1 | PJHist1 | RJOHist1 | SRTRack1 | SDTRack1 | TJTRack1 | DJTRack1 | DDJTrack1 | PJTRack1 | RJOTrack1 | TJSPectrum1 | DDJSpectrum1 | PJSPectrum1 | RJOSpectrum1 | SEYE1 | BATHtub2 | BMEas2 | SRESponse2 | SRHist2 | SDHist2 | TJHist2 | DJHist2 | DDJHist2 | PJHist2 | RJOHist2 | SRTRack2 | SDTRack2 | TJTRack2 | DJTRack2 | DDJTrack2 | PJTRack2 | RJOTrack2 | TJSPectrum2 | DDJSpectrum2 | PJSPectrum2 | RJOSpectrum2 | SEYE2 | NBAThtub1 | NBMeas1 | TNHist1 | DNHist1 | DDNHist1 | PNHist1 | RNOHist1 | TNTRack1 | DNTRack1 | DDNTrack1 | PNTRack1 | RNOTrack1 | TNSPectrum1 | DDNSpectrum1 | PNSPectrum1 | RNOSpectrum1 | NBAThtub2 | NBMeas2 | TNHist2 | DNHist2 | DDNHist2 | PNHist2 | RNOHist2 | TNTRack2 | DNTRack2 | DDNTrack2 | PNTRack2 | RNOTrack2 | TNSPectrum2 | DDNSpectrum2 | PNSPectrum2 | RNOSpectrum2 | PJDHist1 | BUJHist1 | RJHist1 | PJDTrack1 | PJDSpectrum1 | PJDHist2 | BUJHist2 | RJHist2 | PJDTrack2 | PJDSpectrum2 | PNDHist1 | BUNHist1 | RNHist1 | PNDTrack1 | PNDSpectrum1 | PNDHist2 | BUNHist2 | RNHist2 | PNDTrack2 | PNDSpectrum2 | LANE1 | LANE2 | LANE3 | LANE4
"""
param = Conversions.enum_scalar_to_str(source, enums.SignalSource)
self._core.io.write_with_opc(f'EXPort:WAVeform:SOURce {param}')
[docs]
def get_dlogging(self) -> bool:
"""
``EXPort:WAVeform:DLOGging`` \n
Snippet: ``value: bool = driver.export.waveform.get_dlogging()`` \n
The command enables the export of subsequent acquisitions of the selected waveforms. The waveforms are taken from a
running Nx Single acquisition (data logging, history is disabled) , or from the history (multiple waveforms, history is
enabled) . If the history is disabled (method ``RsRtx.channel.waveform.history.state.set()`` ) and data logging is
enabled, a specified number of waveforms is transferred to file directly during RUN Nx SINGLE acquisition. Enabling data
logging stops a running acquisition. Set the number of acquisitions to be acquired and stored with method
``RsRtx.acquire.count()`` and start export using method ``RsRtx.run.single()`` . If the history is enabled,
the subsequent waveforms are taken from the history. Specify the range with method
``RsRtx.channel.waveform.history.start.set()`` and method ``RsRtx.channel.waveform.history.stop.set()`` . Then play the
history with method ``RsRtx.channel.waveform.history.play.set()`` . The commands method ``RsRtx.export.waveform.save()`` ,
method ``RsRtx.channel.waveform.data.values.get()`` and method ``RsRtx.channel.waveform.data.header.get()`` are not
available if data logging is enabled. The method ``RsRtx.runContinous.set()`` command disables data logging.
If data logging is off, and the history is enabled, one waveform out of the history is written to file. Specify the
waveform using method ``RsRtx.channel.waveform.history.current.set()`` and save it using method
``RsRtx.export.waveform.save()`` .
:return: data_logging: OFF | ON
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:DLOGging?')
return Conversions.str_to_bool(response)
[docs]
def set_dlogging(self, data_logging: bool) -> None:
"""
``EXPort:WAVeform:DLOGging`` \n
Snippet: ``driver.export.waveform.set_dlogging(data_logging = False)`` \n
The command enables the export of subsequent acquisitions of the selected waveforms. The waveforms are taken from a
running Nx Single acquisition (data logging, history is disabled) , or from the history (multiple waveforms, history is
enabled) . If the history is disabled (method ``RsRtx.channel.waveform.history.state.set()`` ) and data logging is
enabled, a specified number of waveforms is transferred to file directly during RUN Nx SINGLE acquisition. Enabling data
logging stops a running acquisition. Set the number of acquisitions to be acquired and stored with method
``RsRtx.acquire.count()`` and start export using method ``RsRtx.run.single()`` . If the history is enabled,
the subsequent waveforms are taken from the history. Specify the range with method
``RsRtx.channel.waveform.history.start.set()`` and method ``RsRtx.channel.waveform.history.stop.set()`` . Then play the
history with method ``RsRtx.channel.waveform.history.play.set()`` . The commands method ``RsRtx.export.waveform.save()`` ,
method ``RsRtx.channel.waveform.data.values.get()`` and method ``RsRtx.channel.waveform.data.header.get()`` are not
available if data logging is enabled. The method ``RsRtx.runContinous.set()`` command disables data logging.
If data logging is off, and the history is enabled, one waveform out of the history is written to file. Specify the
waveform using method ``RsRtx.channel.waveform.history.current.set()`` and save it using method
``RsRtx.export.waveform.save()`` .
:param data_logging: OFF | ON
"""
param = Conversions.bool_to_str(data_logging)
self._core.io.write_with_opc(f'EXPort:WAVeform:DLOGging {param}')
[docs]
def get_name(self) -> str:
"""
``EXPort:WAVeform:NAME`` \n
Snippet: ``value: str = driver.export.waveform.get_name()`` \n
Sets the file name, file format and path to save the waveform to. See also: 'Waveform export files'
:return: filename: String with path and file name with extension .xml, .bin, or .csv
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:NAME?')
return trim_str_response(response)
[docs]
def set_name(self, filename: str) -> None:
"""
``EXPort:WAVeform:NAME`` \n
Snippet: ``driver.export.waveform.set_name(filename = 'abc')`` \n
Sets the file name, file format and path to save the waveform to. See also: 'Waveform export files'
:param filename: String with path and file name with extension .xml, .bin, or .csv
"""
param = Conversions.value_to_quoted_str(filename)
self._core.io.write_with_opc(f'EXPort:WAVeform:NAME {param}')
[docs]
def get_incx_values(self) -> bool:
"""
``EXPort:WAVeform:INCXvalues`` \n
Snippet: ``value: bool = driver.export.waveform.get_incx_values()`` \n
Includes horizontal values in the retrieved data (time or frequency values, depending on the waveform) . X and Y-values
are written alternately to the file. If disabled, only Y-values - mostly voltage values - are written. The X-values are
always returned in 64 bit real format, regardless of the defined data format. The setting is not available for the export
of raw data.
The command affects the content of export files as well as data retrieved with: \n
- method ``RsRtx.channel.waveform.data.values.get()``
- method ``RsRtx.calculate.math.data.values.get()``
- method ``RsRtx.refCurve.data.values.get()``
- method ``RsRtx.digital.data.values.get()``
- method ``RsRtx.bus.parallel.data.values.get()``
- method ``RsRtx.zvc.z.icurrent.data.values.get()``
- method ``RsRtx.zvc.z.voltage.data.values.get()``
:return: inc_hor_values: OFF | ON
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:INCXvalues?')
return Conversions.str_to_bool(response)
[docs]
def set_incx_values(self, inc_hor_values: bool) -> None:
"""
``EXPort:WAVeform:INCXvalues`` \n
Snippet: ``driver.export.waveform.set_incx_values(inc_hor_values = False)`` \n
Includes horizontal values in the retrieved data (time or frequency values, depending on the waveform) . X and Y-values
are written alternately to the file. If disabled, only Y-values - mostly voltage values - are written. The X-values are
always returned in 64 bit real format, regardless of the defined data format. The setting is not available for the export
of raw data.
The command affects the content of export files as well as data retrieved with: \n
- method ``RsRtx.channel.waveform.data.values.get()``
- method ``RsRtx.calculate.math.data.values.get()``
- method ``RsRtx.refCurve.data.values.get()``
- method ``RsRtx.digital.data.values.get()``
- method ``RsRtx.bus.parallel.data.values.get()``
- method ``RsRtx.zvc.z.icurrent.data.values.get()``
- method ``RsRtx.zvc.z.voltage.data.values.get()``
:param inc_hor_values: OFF | ON
"""
param = Conversions.bool_to_str(inc_hor_values)
self._core.io.write_with_opc(f'EXPort:WAVeform:INCXvalues {param}')
[docs]
def get_raw(self) -> bool:
"""
``EXPort:WAVeform:RAW`` \n
Snippet: ``value: bool = driver.export.waveform.get_raw()`` \n
Enables the export of raw sample data, and sets the data format to integer 8 bit. In high definition acquisition mode,
the data format is integer 16 bit. Fot INT16, you can set the byte order using the method ``RsRtx.formatPy.border()``
command. The raw format reduces the file size but changes also the precision of the values. Currently, the setting is not
available for the export of digital channel data and data of R&S RT-ZVC channels. The raw export of interleaved X/Y
values is not supported.
:return: raw_values: OFF | ON
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:RAW?')
return Conversions.str_to_bool(response)
[docs]
def set_raw(self, raw_values: bool) -> None:
"""
``EXPort:WAVeform:RAW`` \n
Snippet: ``driver.export.waveform.set_raw(raw_values = False)`` \n
Enables the export of raw sample data, and sets the data format to integer 8 bit. In high definition acquisition mode,
the data format is integer 16 bit. Fot INT16, you can set the byte order using the method ``RsRtx.formatPy.border()``
command. The raw format reduces the file size but changes also the precision of the values. Currently, the setting is not
available for the export of digital channel data and data of R&S RT-ZVC channels. The raw export of interleaved X/Y
values is not supported.
:param raw_values: OFF | ON
"""
param = Conversions.bool_to_str(raw_values)
self._core.io.write_with_opc(f'EXPort:WAVeform:RAW {param}')
[docs]
def get_display_off(self) -> bool:
"""
``EXPort:WAVeform:DISPlayoff`` \n
Snippet: ``value: bool = driver.export.waveform.get_display_off()`` \n
Enables or disables the display update during an Nx Single acquisition.
:return: fast_export: ON: Disables the display update for maximum export speed. OFF: Enables the display update. The export is slower.
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:DISPlayoff?')
return Conversions.str_to_bool(response)
[docs]
def set_display_off(self, fast_export: bool) -> None:
"""
``EXPort:WAVeform:DISPlayoff`` \n
Snippet: ``driver.export.waveform.set_display_off(fast_export = False)`` \n
Enables or disables the display update during an Nx Single acquisition.
:param fast_export: ON: Disables the display update for maximum export speed. OFF: Enables the display update. The export is slower.
"""
param = Conversions.bool_to_str(fast_export)
self._core.io.write_with_opc(f'EXPort:WAVeform:DISPlayoff {param}')
[docs]
def get_multi_channel(self) -> bool:
"""
``EXPort:WAVeform:MULTichannel`` \n
Snippet: ``value: bool = driver.export.waveform.get_multi_channel()`` \n
Enables or disables the multichannel export. If you enable the multichannel export, all active channels are included to
the export data. You can change the export state using the method ``RsRtx.channel.exportState.set()`` command.
If multichannel export is disabled, select the waveform to be exported using the method
``RsRtx.export.waveform.source()`` command. Note that method ``RsRtx.channel.waveform.data.values.get()`` returns the
data of all channels that are selected for export, no matter of the channel suffix.
:return: mlt_ch_xpt: OFF | ON
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:MULTichannel?')
return Conversions.str_to_bool(response)
[docs]
def set_multi_channel(self, mlt_ch_xpt: bool) -> None:
"""
``EXPort:WAVeform:MULTichannel`` \n
Snippet: ``driver.export.waveform.set_multi_channel(mlt_ch_xpt = False)`` \n
Enables or disables the multichannel export. If you enable the multichannel export, all active channels are included to
the export data. You can change the export state using the method ``RsRtx.channel.exportState.set()`` command.
If multichannel export is disabled, select the waveform to be exported using the method
``RsRtx.export.waveform.source()`` command. Note that method ``RsRtx.channel.waveform.data.values.get()`` returns the
data of all channels that are selected for export, no matter of the channel suffix.
:param mlt_ch_xpt: OFF | ON
"""
param = Conversions.bool_to_str(mlt_ch_xpt)
self._core.io.write_with_opc(f'EXPort:WAVeform:MULTichannel {param}')
[docs]
def get_timestamps(self) -> bool:
"""
``EXPort:WAVeform:TIMestamps`` \n
Snippet: ``value: bool = driver.export.waveform.get_timestamps()`` \n
Exports the relative timestamps of all history waveforms to the waveform data file. The time is written at the beginning
of each waveform record.
:return: use_timestamps: OFF | ON
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:TIMestamps?')
return Conversions.str_to_bool(response)
[docs]
def set_timestamps(self, use_timestamps: bool) -> None:
"""
``EXPort:WAVeform:TIMestamps`` \n
Snippet: ``driver.export.waveform.set_timestamps(use_timestamps = False)`` \n
Exports the relative timestamps of all history waveforms to the waveform data file. The time is written at the beginning
of each waveform record.
:param use_timestamps: OFF | ON
"""
param = Conversions.bool_to_str(use_timestamps)
self._core.io.write_with_opc(f'EXPort:WAVeform:TIMestamps {param}')
[docs]
def get_icdr(self) -> bool:
"""
``EXPort:WAVeform:ICDR`` \n
Snippet: ``value: bool = driver.export.waveform.get_icdr()`` \n
Includes the CDR information in the waveform file.
:return: include_cdr_information: OFF | ON
"""
response = self._core.io.query_str_with_opc('EXPort:WAVeform:ICDR?')
return Conversions.str_to_bool(response)
[docs]
def set_icdr(self, include_cdr_information: bool) -> None:
"""
``EXPort:WAVeform:ICDR`` \n
Snippet: ``driver.export.waveform.set_icdr(include_cdr_information = False)`` \n
Includes the CDR information in the waveform file.
:param include_cdr_information: OFF | ON
"""
param = Conversions.bool_to_str(include_cdr_information)
self._core.io.write_with_opc(f'EXPort:WAVeform:ICDR {param}')
def clone(self) -> 'WaveformCls':
"""
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 = WaveformCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group