diff --git a/CHANGELOG.md b/CHANGELOG.md index 88e0932c..6b7dd4ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,10 @@ ______________________________________________________________________ Things to be included in the next release go here. +### Removed + +- Removed some outdated and broken API files + ______________________________________________________________________ ## v0.1.24 (2023-10-30) diff --git a/README.rst b/README.rst index abaf3076..748170ba 100644 --- a/README.rst +++ b/README.rst @@ -56,8 +56,8 @@ .. |pre-commit status| image:: https://results.pre-commit.ci/badge/github/tektronix/tm_devices/main.svg :target: https://results.pre-commit.ci/latest/github/tektronix/tm_devices/main -.. |ReadTheDocs status| image:: https://readthedocs.org/projects/tm-devices/badge/?version=latest - :target: https://tm-devices.readthedocs.io/en/latest/?badge=latest +.. .. |ReadTheDocs status| image:: https://readthedocs.org/projects/tm-devices/badge/?version=latest +.. :target: https://tm-devices.readthedocs.io/en/latest/?badge=latest .. |GitHub Pages status| image:: https://github.com/tektronix/tm_devices/actions/workflows/deploy-documentation.yml/badge.svg?branch=main :target: https://github.com/tektronix/tm_devices/actions/workflows/deploy-documentation.yml diff --git a/docs/_static/favicon_readthedocs.png b/docs/_static/favicon_readthedocs.png new file mode 100644 index 00000000..851df927 Binary files /dev/null and b/docs/_static/favicon_readthedocs.png differ diff --git a/docs/conf.py b/docs/conf.py index 2ff2f51a..54133f48 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -135,6 +135,7 @@ def prep_jinja_env(jinja_env: JinjaEnvironment) -> None: "navigation_depth": 4, "collapse_navigation": True, } +html_favicon = "_static/favicon_readthedocs.png" intersphinx_mapping = { # pylint: disable=consider-using-namedtuple-or-dataclass "python": ("https://docs.python.org/3/", None), "pyvisa": ("https://pyvisa.readthedocs.io/en/latest/", None), diff --git a/src/tm_devices/commands/_c3g63_lpdmso/measu.py b/src/tm_devices/commands/_c3g63_lpdmso/measu.py deleted file mode 100644 index d59c770f..00000000 --- a/src/tm_devices/commands/_c3g63_lpdmso/measu.py +++ /dev/null @@ -1,1096 +0,0 @@ -# pylint: disable=too-many-lines -"""The measu commands module. - -These commands are used in the following models: -LPD6, MSO4, MSO5, MSO5B, MSO5LP, MSO6, MSO6B - -THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. - -Please report an issue if one is found. - -Commands and Queries: - -:: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum? - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN? - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum? - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK? - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation? - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev? - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum? - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN? - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum? - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK? - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation? - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev? -""" -from typing import Optional, TYPE_CHECKING - -from .._helpers import SCPICmdRead, SCPICmdReadWithArguments - -if TYPE_CHECKING: - from tm_devices.drivers.pi.pi_device import PIDevice - - -class MeasuMeas1SubgroupResultsCurrentacqStddev(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev`` command. - - **Description:** - - This query returns the standard deviation value of the measurement specified by the - string, for the current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - - -class MeasuMeas1SubgroupResultsCurrentacqPopulation(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation`` command. - - **Description:** - - This query returns the population value of the measurement specified by the string, for - the current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - - -class MeasuMeas1SubgroupResultsCurrentacqPk2pk(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK`` command. - - **Description:** - - This query returns the peak-to-peak value of the measurement specified by the string, for - the current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - - -class MeasuMeas1SubgroupResultsCurrentacqMinimum(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum`` command. - - **Description:** - - This query returns the minimum value of the measurement specified by the string, for the - current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL \|SPEED \|ACCELERATION \|DIRECTION - \|ANGLE \|TORQUE \|POWER \|ELECPWR \|MECHPWR \|SYSTEMEFFICIENCY \|EON \|EOFF \|TDON - \|TDOFF \|startlevel \|stoplevel \|TRR \|QRR \|TA \|TB \|RSF \|VPEAK \|IPEAK \|TR \|ERR - \|TF \|TON \|TOFF \|IRRM \|DBYDT. - """ - - -class MeasuMeas1SubgroupResultsCurrentacqMean(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN`` command. - - **Description:** - - This query returns the mean value of the measurement specified by the string, for the - current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN? - - **Info:** - - ```` = INPUT \|OUTPUT1 \|OUTPUT2 \|OUTPUT3 \|OUTPUT4 \|OUTPUT5 \|OUTPUT6 - \|OUTPUT7 \|RAIL1DPMOVERSHOOT \|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL \|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS \|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK \|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL \|L2LPH1VRMS - \|L2LPH1VCFactor \|L2LPH1TruePwr \|L2LPH1RePwr \|L2LPH1AppPwr \|L2LPH1PwrFactor - \|L2LPH1PhaseDiff \|L2LPH1VPhase \|L2LPH2VRMS \|L2LPH2VCFactor \|L2LPH2TruePwr - \|L2LPH2RePwr \|L2LPH2AppPwr \|L2LPH2PwrFactor \|L2LPH2PhaseDiff \|L2LPH2VPhase - \|L2LPH3VRMS \|L2LPH3VCFactor \|L2LPH3TruePwr \|L2LPH3RePwr \|L2LPH3AppPwr - \|L2LPH3PwrFactor \|L2LPH3PhaseDiff \|L2LPH3VPhase \|L2NPH1VRMS \|L2NPH1VCFactor - \|L2NPH1TruePwr \|L2NPH1RePwr \|L2NPH1AppPwr \|L2NPH1PwrFactor \|L2NPH1PhaseDiff - \|L2NPH1VPhase \|L2NPH2VRMS \|L2NPH2VCFactor \|L2NPH2TruePwr \|L2NPH2RePwr \|L2NPH2AppPwr - \|L2NPH2PwrFactor \|L2NPH2PhaseDiff \|L2NPH2VPhase \|L2NPH3VRMS \|L2NPH3VCFactor - \|L2NPH3TruePwr \|L2NPH3RePwr \|L2NPH3AppPwr \|L2NPH3PwrFactor \|L2NPH3PhaseDiff - \|L2NPH3VPhase \|PH1IRMS \|PH1IPhase \|PH1ICFactor \|PH2IRMS \|PH2IPhase \|PH2ICFactor - \|PH3IRMS \|PH3IPhase \|PH3ICFactor \|Frequency \|L2LPH1F1Mag \|L2LPH1F3Mag \|L2LPH1THDF - \|L2LPH1THDR \|L2LPH1RMS \|L2LPH1IRMS \|L2LPH1Status \|L2LPH1HarmonicsNumber - \|L2LPH1Frequency \|L2LPH1MagnitudeAbs \|L2LPH1MagnitudePct \|L2LPH1Phase \|L2LPH1Limits - \|L2LPH1PassFail \|L2LPH1Margin \|L2LPH2F1Mag \|L2LPH2F3Mag \|L2LPH2THDF \|L2LPH2THDR - \|L2LPH2RMS \|L2LPH2IRMS \|L2LPH2Status \|L2LPH2HarmonicsNumber \|L2LPH2Frequency - \|L2LPH2MagnitudeAbs \|L2LPH2MagnitudePct \|L2LPH2Phase \|L2LPH2Limits \|L2LPH2PassFail - \|L2LPH2Margin \|L2LPH3F1Mag \|L2LPH3F3Mag \|L2LPH3THDF \|L2LPH3THDR \|L2LPH3RMS - \|L2LPH3IRMS \|L2LPH3Status \|L2LPH3HarmonicsNumber \|L2LPH3Frequency \|L2LPH3MagnitudeAbs - \|L2LPH3MagnitudePct \|L2LPH3Phase \|L2LPH3Limits \|L2LPH3PassFail \|L2LPH3Margin - \|L2NPH1F1Mag \|L2NPH1F3Mag \|L2NPH1THDF \|L2NPH1THDR \|L2NPH1RMS \|L2NPH1IRMS - \|L2NPH1Status \|L2NPH1HarmonicsNumber \|L2NPH1Frequency \|L2NPH1MagnitudeAbs - \|L2NPH1MagnitudePct \|L2NPH1Phase\|L2NPH1Limits \|L2NPH1PassFail\|L2NPH1Margin - \|L2NPH2F1Mag\|L2NPH2F3Mag \|L2NPH2THDF\|L2NPH2THDR \|L2NPH2RMS\|L2NPH2IRMS \|L2NPH2Status - \|L2NPH2HarmonicsNumber \|L2NPH2Frequency \|L2NPH2MagnitudeAbs \|L2NPH2MagnitudePct - \|L2NPH2Phase\|L2NPH2Limits \|L2NPH2PassFail\|L2NPH2Margin \|L2NPH3F1Mag \|L2NPH3F3Mag - \|L2NPH3THDF \|L2NPH3THDR \|L2NPH3RMS \|L2NPH3IRMS \|L2NPH3Status \|L2NPH3HarmonicsNumber - \|L2NPH3Frequency \|L2NPH3MagnitudeAbs \|L2NPH3MagnitudePct \|L2NPH3Phase \|L2NPH3Limits - \|L2NPH3PassFail \|L2NPH3Margin \|ORDER\|PH1INPwr \|PH1OUTPwr \|PH1Efficiency \|PH2INPwr - \|PH2OUTPwr \|PH2Efficiency \|TotalEfficiency \|PH1LRIPRMS \|PH1LRIPPK2PK \|PH2LRIPRMS - \|PH2LRIPPK2PK \|PH3LRIPRMS \|PH3LRIPPK2PK \|PH1SWRIPRMS \|PH1SWRIPPK2PK \|PH2SWRIPRMS - \|PH2SWRIPPK2PK \|PH3SWRIPRMS \|PH3SWRIPPK2PK \|TruePwrSum \|RePwrSum \|AppPwrSum - \|InPwrSum \|OutPwrSum \|SPEED \|ACCELERATION \|DIRECTION \|ANGLE \|TORQUE \|POWER - \|ELECPWR \|MECHPWR \|SYSTEMEFFICIENCY \|EON \|EOFF \|TDON \|TDOFF \|startlevel - \|stoplevel \|TRR \|QRR \|TA \|TB \|RSF \|VPEAK \|IPEAK \|TR \|ERR \|TF \|TON \|TOFF - \|IRRM \|DBYDT. - """ - - -class MeasuMeas1SubgroupResultsCurrentacqMaximum(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum`` command. - - **Description:** - - This query returns the maximum value of the measurement specified by the string, for the - current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - - -class MeasuMeas1SubgroupResultsCurrentacq(SCPICmdRead): - """The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq?`` - query. - - Using the ``.verify(value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.maximum``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum`` command. - - ``.mean``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN`` command. - - ``.minimum``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum`` command. - - ``.pk2pk``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK`` command. - - ``.population``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation`` command. - - ``.stddev``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._maximum = MeasuMeas1SubgroupResultsCurrentacqMaximum( - device, f"{self._cmd_syntax}:MAXimum" - ) - self._mean = MeasuMeas1SubgroupResultsCurrentacqMean(device, f"{self._cmd_syntax}:MEAN") - self._minimum = MeasuMeas1SubgroupResultsCurrentacqMinimum( - device, f"{self._cmd_syntax}:MINimum" - ) - self._pk2pk = MeasuMeas1SubgroupResultsCurrentacqPk2pk(device, f"{self._cmd_syntax}:PK2PK") - self._population = MeasuMeas1SubgroupResultsCurrentacqPopulation( - device, f"{self._cmd_syntax}:POPUlation" - ) - self._stddev = MeasuMeas1SubgroupResultsCurrentacqStddev( - device, f"{self._cmd_syntax}:STDDev" - ) - - @property - def maximum(self) -> MeasuMeas1SubgroupResultsCurrentacqMaximum: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum`` command. - - **Description:** - - This query returns the maximum value of the measurement specified by the string, for - the current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - return self._maximum - - @property - def mean(self) -> MeasuMeas1SubgroupResultsCurrentacqMean: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN`` command. - - **Description:** - - This query returns the mean value of the measurement specified by the string, for the - current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN? - - **Info:** - - ```` = INPUT \|OUTPUT1 \|OUTPUT2 \|OUTPUT3 \|OUTPUT4 \|OUTPUT5 \|OUTPUT6 - \|OUTPUT7 \|RAIL1DPMOVERSHOOT \|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL \|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS \|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK \|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL - \|L2LPH1VRMS \|L2LPH1VCFactor \|L2LPH1TruePwr \|L2LPH1RePwr \|L2LPH1AppPwr - \|L2LPH1PwrFactor \|L2LPH1PhaseDiff \|L2LPH1VPhase \|L2LPH2VRMS \|L2LPH2VCFactor - \|L2LPH2TruePwr \|L2LPH2RePwr \|L2LPH2AppPwr \|L2LPH2PwrFactor \|L2LPH2PhaseDiff - \|L2LPH2VPhase \|L2LPH3VRMS \|L2LPH3VCFactor \|L2LPH3TruePwr \|L2LPH3RePwr - \|L2LPH3AppPwr \|L2LPH3PwrFactor \|L2LPH3PhaseDiff \|L2LPH3VPhase \|L2NPH1VRMS - \|L2NPH1VCFactor \|L2NPH1TruePwr \|L2NPH1RePwr \|L2NPH1AppPwr \|L2NPH1PwrFactor - \|L2NPH1PhaseDiff \|L2NPH1VPhase \|L2NPH2VRMS \|L2NPH2VCFactor \|L2NPH2TruePwr - \|L2NPH2RePwr \|L2NPH2AppPwr \|L2NPH2PwrFactor \|L2NPH2PhaseDiff \|L2NPH2VPhase - \|L2NPH3VRMS \|L2NPH3VCFactor \|L2NPH3TruePwr \|L2NPH3RePwr \|L2NPH3AppPwr - \|L2NPH3PwrFactor \|L2NPH3PhaseDiff \|L2NPH3VPhase \|PH1IRMS \|PH1IPhase \|PH1ICFactor - \|PH2IRMS \|PH2IPhase \|PH2ICFactor \|PH3IRMS \|PH3IPhase \|PH3ICFactor \|Frequency - \|L2LPH1F1Mag \|L2LPH1F3Mag \|L2LPH1THDF \|L2LPH1THDR \|L2LPH1RMS \|L2LPH1IRMS - \|L2LPH1Status \|L2LPH1HarmonicsNumber \|L2LPH1Frequency \|L2LPH1MagnitudeAbs - \|L2LPH1MagnitudePct \|L2LPH1Phase \|L2LPH1Limits \|L2LPH1PassFail \|L2LPH1Margin - \|L2LPH2F1Mag \|L2LPH2F3Mag \|L2LPH2THDF \|L2LPH2THDR \|L2LPH2RMS \|L2LPH2IRMS - \|L2LPH2Status \|L2LPH2HarmonicsNumber \|L2LPH2Frequency \|L2LPH2MagnitudeAbs - \|L2LPH2MagnitudePct \|L2LPH2Phase \|L2LPH2Limits \|L2LPH2PassFail \|L2LPH2Margin - \|L2LPH3F1Mag \|L2LPH3F3Mag \|L2LPH3THDF \|L2LPH3THDR \|L2LPH3RMS \|L2LPH3IRMS - \|L2LPH3Status \|L2LPH3HarmonicsNumber \|L2LPH3Frequency \|L2LPH3MagnitudeAbs - \|L2LPH3MagnitudePct \|L2LPH3Phase \|L2LPH3Limits \|L2LPH3PassFail \|L2LPH3Margin - \|L2NPH1F1Mag \|L2NPH1F3Mag \|L2NPH1THDF \|L2NPH1THDR \|L2NPH1RMS \|L2NPH1IRMS - \|L2NPH1Status \|L2NPH1HarmonicsNumber \|L2NPH1Frequency \|L2NPH1MagnitudeAbs - \|L2NPH1MagnitudePct \|L2NPH1Phase\|L2NPH1Limits \|L2NPH1PassFail\|L2NPH1Margin - \|L2NPH2F1Mag\|L2NPH2F3Mag \|L2NPH2THDF\|L2NPH2THDR \|L2NPH2RMS\|L2NPH2IRMS - \|L2NPH2Status \|L2NPH2HarmonicsNumber \|L2NPH2Frequency \|L2NPH2MagnitudeAbs - \|L2NPH2MagnitudePct \|L2NPH2Phase\|L2NPH2Limits \|L2NPH2PassFail\|L2NPH2Margin - \|L2NPH3F1Mag \|L2NPH3F3Mag \|L2NPH3THDF \|L2NPH3THDR \|L2NPH3RMS \|L2NPH3IRMS - \|L2NPH3Status \|L2NPH3HarmonicsNumber \|L2NPH3Frequency \|L2NPH3MagnitudeAbs - \|L2NPH3MagnitudePct \|L2NPH3Phase \|L2NPH3Limits \|L2NPH3PassFail \|L2NPH3Margin - \|ORDER\|PH1INPwr \|PH1OUTPwr \|PH1Efficiency \|PH2INPwr \|PH2OUTPwr \|PH2Efficiency - \|TotalEfficiency \|PH1LRIPRMS \|PH1LRIPPK2PK \|PH2LRIPRMS \|PH2LRIPPK2PK \|PH3LRIPRMS - \|PH3LRIPPK2PK \|PH1SWRIPRMS \|PH1SWRIPPK2PK \|PH2SWRIPRMS \|PH2SWRIPPK2PK - \|PH3SWRIPRMS \|PH3SWRIPPK2PK \|TruePwrSum \|RePwrSum \|AppPwrSum \|InPwrSum - \|OutPwrSum \|SPEED \|ACCELERATION \|DIRECTION \|ANGLE \|TORQUE \|POWER \|ELECPWR - \|MECHPWR \|SYSTEMEFFICIENCY \|EON \|EOFF \|TDON \|TDOFF \|startlevel \|stoplevel - \|TRR \|QRR \|TA \|TB \|RSF \|VPEAK \|IPEAK \|TR \|ERR \|TF \|TON \|TOFF \|IRRM - \|DBYDT. - """ - return self._mean - - @property - def minimum(self) -> MeasuMeas1SubgroupResultsCurrentacqMinimum: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum`` command. - - **Description:** - - This query returns the minimum value of the measurement specified by the string, for - the current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL \|SPEED - \|ACCELERATION \|DIRECTION \|ANGLE \|TORQUE \|POWER \|ELECPWR \|MECHPWR - \|SYSTEMEFFICIENCY \|EON \|EOFF \|TDON \|TDOFF \|startlevel \|stoplevel \|TRR \|QRR - \|TA \|TB \|RSF \|VPEAK \|IPEAK \|TR \|ERR \|TF \|TON \|TOFF \|IRRM \|DBYDT. - """ - return self._minimum - - @property - def pk2pk(self) -> MeasuMeas1SubgroupResultsCurrentacqPk2pk: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK`` command. - - **Description:** - - This query returns the peak-to-peak value of the measurement specified by the string, - for the current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - return self._pk2pk - - @property - def population(self) -> MeasuMeas1SubgroupResultsCurrentacqPopulation: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation`` command. - - **Description:** - - This query returns the population value of the measurement specified by the string, - for the current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - return self._population - - @property - def stddev(self) -> MeasuMeas1SubgroupResultsCurrentacqStddev: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev`` command. - - **Description:** - - This query returns the standard deviation value of the measurement specified by the - string, for the current acquisition. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - return self._stddev - - -class MeasuMeas1SubgroupResultsAllacqsStddev(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev`` command. - - **Description:** - - This query returns the standard deviation value of the measurement specified by the - string, for all acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - - -class MeasuMeas1SubgroupResultsAllacqsPopulation(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation`` command. - - **Description:** - - This query returns the population value of the measurement specified by the string, for - all acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - - -class MeasuMeas1SubgroupResultsAllacqsPk2pk(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK`` command. - - **Description:** - - This query returns the peak-to-peak value of the measurement specified by the string, for - all acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK? argument`` query and raise an AssertionError - if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - - -class MeasuMeas1SubgroupResultsAllacqsMinimum(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum`` command. - - **Description:** - - This query returns the minimum value of the measurement specified by the string, for all - acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - - -class MeasuMeas1SubgroupResultsAllacqsMean(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN`` command. - - **Description:** - - This query returns the mean value of the measurement specified by the string, for all - acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN? argument`` query and raise an AssertionError - if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - - -class MeasuMeas1SubgroupResultsAllacqsMaximum(SCPICmdReadWithArguments): - r"""The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum`` command. - - **Description:** - - This query returns the maximum value of the measurement specified by the string, for all - acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| OUTPUT6\|OUTPUT7\| - RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK \|RAIL1RMS - \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL \|RAIL3FREQUENCY - \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK \|RAIL4RMS - \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL \|RAIL6FREQUENCY - \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT \|RAIL7DPMUNDERSHOOT - \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - - -class MeasuMeas1SubgroupResultsAllacqs(SCPICmdRead): - """The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs?`` - query. - - Using the ``.verify(value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.maximum``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum`` command. - - ``.mean``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN`` command. - - ``.minimum``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum`` command. - - ``.pk2pk``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK`` command. - - ``.population``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation`` command. - - ``.stddev``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._maximum = MeasuMeas1SubgroupResultsAllacqsMaximum( - device, f"{self._cmd_syntax}:MAXimum" - ) - self._mean = MeasuMeas1SubgroupResultsAllacqsMean(device, f"{self._cmd_syntax}:MEAN") - self._minimum = MeasuMeas1SubgroupResultsAllacqsMinimum( - device, f"{self._cmd_syntax}:MINimum" - ) - self._pk2pk = MeasuMeas1SubgroupResultsAllacqsPk2pk(device, f"{self._cmd_syntax}:PK2PK") - self._population = MeasuMeas1SubgroupResultsAllacqsPopulation( - device, f"{self._cmd_syntax}:POPUlation" - ) - self._stddev = MeasuMeas1SubgroupResultsAllacqsStddev(device, f"{self._cmd_syntax}:STDDev") - - @property - def maximum(self) -> MeasuMeas1SubgroupResultsAllacqsMaximum: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum`` command. - - **Description:** - - This query returns the maximum value of the measurement specified by the string, for - all acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - return self._maximum - - @property - def mean(self) -> MeasuMeas1SubgroupResultsAllacqsMean: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN`` command. - - **Description:** - - This query returns the mean value of the measurement specified by the string, for all - acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - return self._mean - - @property - def minimum(self) -> MeasuMeas1SubgroupResultsAllacqsMinimum: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum`` command. - - **Description:** - - This query returns the minimum value of the measurement specified by the string, for - all acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - return self._minimum - - @property - def pk2pk(self) -> MeasuMeas1SubgroupResultsAllacqsPk2pk: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK`` command. - - **Description:** - - This query returns the peak-to-peak value of the measurement specified by the string, - for all acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - return self._pk2pk - - @property - def population(self) -> MeasuMeas1SubgroupResultsAllacqsPopulation: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation`` command. - - **Description:** - - This query returns the population value of the measurement specified by the string, - for all acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - return self._population - - @property - def stddev(self) -> MeasuMeas1SubgroupResultsAllacqsStddev: - r"""Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev`` command. - - **Description:** - - This query returns the standard deviation value of the measurement specified by the - string, for all acquisitions. - - **Usage:** - - Using the ``.query(argument)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev? argument`` query. - - Using the ``.verify(argument, value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev? argument`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev? - - **Info:** - - ```` = INPUT\|OUTPUT1\|OUTPUT2\|OUTPUT3\|OUTPUT4\|OUTPUT5\| - OUTPUT6\|OUTPUT7\| RAIL1DPMOVERSHOOT\|RAIL1DPMUNDERSHOOT \|RAIL1FREQUENCY \|RAIL1PK2PK - \|RAIL1RMS \|RAIL1RMSFULL\|RAIL2FREQUENCY \|RAIL2PK2PK \|RAIL2RMS \|RAIL2RMSFULL - \|RAIL3FREQUENCY \|RAIL3PK2PK \|RAIL3RMS\|RAIL3RMSFULL \|RAIL4FREQUENCY \|RAIL4PK2PK - \|RAIL4RMS \|RAIL4RMSFULL \|RAIL5FREQUENCY \|RAIL5PK2PK\|RAIL5RMS \|RAIL5RMSFULL - \|RAIL6FREQUENCY \|RAIL6PK2PK \|RAIL6RMS \|RAIL6RMSFULL \|RAIL7DPMOVERSHOOT - \|RAIL7DPMUNDERSHOOT \|RAIL7FREQUENCY \|RAIL7PK2PK \|RAIL7RMS \|RAIL7RMSFULL. - """ - return self._stddev - - -class MeasuMeas1SubgroupResults(SCPICmdRead): - """The ``MEASU:MEAS1:SUBGROUP:RESUlts`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``MEASU:MEAS1:SUBGROUP:RESUlts?`` query. - - Using the ``.verify(value)`` method will send the ``MEASU:MEAS1:SUBGROUP:RESUlts?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.allacqs``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs`` command tree. - - ``.currentacq``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._allacqs = MeasuMeas1SubgroupResultsAllacqs(device, f"{self._cmd_syntax}:ALLAcqs") - self._currentacq = MeasuMeas1SubgroupResultsCurrentacq( - device, f"{self._cmd_syntax}:CURRentacq" - ) - - @property - def allacqs(self) -> MeasuMeas1SubgroupResultsAllacqs: - """Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs?`` - query. - - Using the ``.verify(value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.maximum``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MAXimum`` command. - - ``.mean``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MEAN`` command. - - ``.minimum``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:MINimum`` command. - - ``.pk2pk``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:PK2PK`` command. - - ``.population``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:POPUlation`` command. - - ``.stddev``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs:STDDev`` command. - """ - return self._allacqs - - @property - def currentacq(self) -> MeasuMeas1SubgroupResultsCurrentacq: - """Return the ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq?`` query. - - Using the ``.verify(value)`` method will send the - ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.maximum``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MAXimum`` command. - - ``.mean``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MEAN`` command. - - ``.minimum``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:MINimum`` command. - - ``.pk2pk``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:PK2PK`` command. - - ``.population``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:POPUlation`` command. - - ``.stddev``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq:STDDev`` command. - """ - return self._currentacq - - -class MeasuMeas1Subgroup(SCPICmdRead): - """The ``MEASU:MEAS1:SUBGROUP`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``MEASU:MEAS1:SUBGROUP?`` query. - - Using the ``.verify(value)`` method will send the ``MEASU:MEAS1:SUBGROUP?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.results``: The ``MEASU:MEAS1:SUBGROUP:RESUlts`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._results = MeasuMeas1SubgroupResults(device, f"{self._cmd_syntax}:RESUlts") - - @property - def results(self) -> MeasuMeas1SubgroupResults: - """Return the ``MEASU:MEAS1:SUBGROUP:RESUlts`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``MEASU:MEAS1:SUBGROUP:RESUlts?`` query. - - Using the ``.verify(value)`` method will send the ``MEASU:MEAS1:SUBGROUP:RESUlts?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.allacqs``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:ALLAcqs`` command tree. - - ``.currentacq``: The ``MEASU:MEAS1:SUBGROUP:RESUlts:CURRentacq`` command tree. - """ - return self._results - - -class MeasuMeas1(SCPICmdRead): - """The ``MEASU:MEAS1`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``MEASU:MEAS1?`` query. - - Using the ``.verify(value)`` method will send the ``MEASU:MEAS1?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.subgroup``: The ``MEASU:MEAS1:SUBGROUP`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._subgroup = MeasuMeas1Subgroup(device, f"{self._cmd_syntax}:SUBGROUP") - - @property - def subgroup(self) -> MeasuMeas1Subgroup: - """Return the ``MEASU:MEAS1:SUBGROUP`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``MEASU:MEAS1:SUBGROUP?`` query. - - Using the ``.verify(value)`` method will send the ``MEASU:MEAS1:SUBGROUP?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.results``: The ``MEASU:MEAS1:SUBGROUP:RESUlts`` command tree. - """ - return self._subgroup - - -class Measu(SCPICmdRead): - """The ``MEASU`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``MEASU?`` query. - - Using the ``.verify(value)`` method will send the ``MEASU?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.meas1``: The ``MEASU:MEAS1`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "MEASU") -> None: - super().__init__(device, cmd_syntax) - self._meas1 = MeasuMeas1(device, f"{self._cmd_syntax}:MEAS1") - - @property - def meas1(self) -> MeasuMeas1: - """Return the ``MEASU:MEAS1`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``MEASU:MEAS1?`` query. - - Using the ``.verify(value)`` method will send the ``MEASU:MEAS1?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.subgroup``: The ``MEASU:MEAS1:SUBGROUP`` command tree. - """ - return self._meas1 diff --git a/src/tm_devices/commands/_c69b1_lpdmso/actonevent.py b/src/tm_devices/commands/_c69b1_lpdmso/actonevent.py deleted file mode 100644 index 7c16e110..00000000 --- a/src/tm_devices/commands/_c69b1_lpdmso/actonevent.py +++ /dev/null @@ -1,3045 +0,0 @@ -# pylint: disable=too-many-lines -"""The actonevent commands module. - -These commands are used in the following models: -LPD6, MSO2, MSO4, MSO5, MSO5B, MSO5LP, MSO6, MSO6B - -THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. - -Please report an issue if one is found. - -Commands and Queries: - -:: - - - ACTONEVent:ENable - - ACTONEVent:ENable? - - ACTONEVent:LIMITCount - - ACTONEVent:LIMITCount? - - ACTONEVent:LIMit - - ACTONEVent:LIMit? - - ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE? - - ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE? - - ACTONEVent:MASKFail:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:SRQ:STATE? - - ACTONEVent:MASKFail:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:STOPACQ:STATE? - - ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE? - - ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE? - - ACTONEVent:MASKHit:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:SRQ:STATE? - - ACTONEVent:MASKHit:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:STOPACQ:STATE? - - ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE? - - ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE? - - ACTONEVent:MASKPass:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:SRQ:STATE? - - ACTONEVent:MASKPass:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:STOPACQ:STATE? - - ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE? - - ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE? - - ACTONEVent:MEASUrement:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:SRQ:STATE? - - ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE? - - ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE? - - ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE? - - ACTONEVent:SEARCH:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:SRQ:STATE? - - ACTONEVent:SEARCH:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:STOPACQ:STATE? - - ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE? - - ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE? - - ACTONEVent:TRIGger:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:SRQ:STATE? - - ACTONEVent:TRIGger:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:STOPACQ:STATE? -""" -from typing import Optional, TYPE_CHECKING - -from .._helpers import SCPICmdRead, SCPICmdWrite - -if TYPE_CHECKING: - from tm_devices.drivers.pi.pi_device import PIDevice - - -class ActoneventTriggerActionStopacqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:TRIGger:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions on a trigger event from a single sequence or sequence of N - acquisition. Each acquisition in the sequence of N will perform a save operation. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:STOPACQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:TRIGger:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions on a trigger event feature. - - ``OFF`` disables the stop acquisitions on a trigger event feature. - - ```` is a number that enables or disables the stop acquisitions on a trigger event - feature. The number zero disables the feature, all other numbers enable the feature. - """ - - -class ActoneventTriggerActionStopacq(SCPICmdRead): - """The ``ACTONEVent:TRIGger:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:STOPACQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:TRIGger:ACTION:STOPACQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:TRIGger:ACTION:STOPACQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventTriggerActionStopacqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventTriggerActionStopacqState: - """Return the ``ACTONEVent:TRIGger:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions on a trigger event from a single sequence or sequence - of N acquisition. Each acquisition in the sequence of N will perform a save operation. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:TRIGger:ACTION:STOPACQ:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:TRIGger:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions on a trigger event feature. - - ``OFF`` disables the stop acquisitions on a trigger event feature. - - ```` is a number that enables or disables the stop acquisitions on a trigger - event feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventTriggerActionSrqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:TRIGger:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when a trigger event occurs. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:SRQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:TRIGger:ACTION:SRQ:STATE?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:TRIGger:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when a trigger event occurs feature. - - ``OFF`` disables the generate an SRQ event when a trigger event occurs feature. - - ```` is a number that enables or disables the generate an SRQ event when a trigger - event occurs feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventTriggerActionSrq(SCPICmdRead): - """The ``ACTONEVent:TRIGger:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:TRIGger:ACTION:SRQ?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:TRIGger:ACTION:SRQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventTriggerActionSrqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventTriggerActionSrqState: - """Return the ``ACTONEVent:TRIGger:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when a trigger event occurs. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:SRQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SRQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:TRIGger:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when a trigger event occurs feature. - - ``OFF`` disables the generate an SRQ event when a trigger event occurs feature. - - ```` is a number that enables or disables the generate an SRQ event when a - trigger event occurs feature. The number zero disables the feature, all other numbers - enable the feature. - """ - return self._state - - -class ActoneventTriggerActionSavewaveformState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) on a trigger event from a single - sequence or sequence of N acquisition. Each acquisition in the sequence of N will perform - a save operation. This command replaces ``SAVEON:WAVEFORM`` (still valid command, but only - an alias for this new command). - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) on a trigger event feature. - - ``OFF`` disables the save source waveform(s) on a trigger event feature. - - ```` is a number that enables or disables the save source waveform(s) on a trigger - event feature. The number zero disables the feature, all other numbers enable the feature. - """ - - -class ActoneventTriggerActionSavewaveform(SCPICmdRead): - """The ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventTriggerActionSavewaveformState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventTriggerActionSavewaveformState: - """Return the ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) on a trigger event from a single - sequence or sequence of N acquisition. Each acquisition in the sequence of N will - perform a save operation. This command replaces ``SAVEON:WAVEFORM`` (still valid - command, but only an alias for this new command). - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) on a trigger event feature. - - ``OFF`` disables the save source waveform(s) on a trigger event feature. - - ```` is a number that enables or disables the save source waveform(s) on a - trigger event feature. The number zero disables the feature, all other numbers enable - the feature. - """ - return self._state - - -class ActoneventTriggerActionSaveimageState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture on a trigger event from a single sequence or sequence - of N acquisition. Each acquisition in the sequence of N will perform a save operation. - This command replaces ``SAVE:IMAGE`` (still valid command, but only an alias for this new - command). - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture on a trigger event feature. - - ``OFF`` disables the save screen capture on a trigger event feature. - - ```` is a number that enables or disables the save screen capture on a trigger event - feature. The number zero disables the feature, all other numbers enable the feature. - """ - - -class ActoneventTriggerActionSaveimage(SCPICmdRead): - """The ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe?`` - query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventTriggerActionSaveimageState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventTriggerActionSaveimageState: - """Return the ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture on a trigger event from a single sequence or - sequence of N acquisition. Each acquisition in the sequence of N will perform a save - operation. This command replaces ``SAVE:IMAGE`` (still valid command, but only an - alias for this new command). - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture on a trigger event feature. - - ``OFF`` disables the save screen capture on a trigger event feature. - - ```` is a number that enables or disables the save screen capture on a trigger - event feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventTriggerAction(SCPICmdRead): - """The ``ACTONEVent:TRIGger:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:TRIGger:ACTION?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.saveimage``: The ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:TRIGger:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:TRIGger:ACTION:STOPACQ`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._saveimage = ActoneventTriggerActionSaveimage(device, f"{self._cmd_syntax}:SAVEIMAGe") - self._savewaveform = ActoneventTriggerActionSavewaveform( - device, f"{self._cmd_syntax}:SAVEWAVEform" - ) - self._srq = ActoneventTriggerActionSrq(device, f"{self._cmd_syntax}:SRQ") - self._stopacq = ActoneventTriggerActionStopacq(device, f"{self._cmd_syntax}:STOPACQ") - - @property - def saveimage(self) -> ActoneventTriggerActionSaveimage: - """Return the ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe:STATE`` command. - """ - return self._saveimage - - @property - def savewaveform(self) -> ActoneventTriggerActionSavewaveform: - """Return the ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform:STATE`` command. - """ - return self._savewaveform - - @property - def srq(self) -> ActoneventTriggerActionSrq: - """Return the ``ACTONEVent:TRIGger:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:TRIGger:ACTION:SRQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:TRIGger:ACTION:SRQ:STATE`` command. - """ - return self._srq - - @property - def stopacq(self) -> ActoneventTriggerActionStopacq: - """Return the ``ACTONEVent:TRIGger:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION:STOPACQ?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:TRIGger:ACTION:STOPACQ?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:TRIGger:ACTION:STOPACQ:STATE`` command. - """ - return self._stopacq - - -class ActoneventTrigger(SCPICmdRead): - """The ``ACTONEVent:TRIGger`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:TRIGger?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.action``: The ``ACTONEVent:TRIGger:ACTION`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._action = ActoneventTriggerAction(device, f"{self._cmd_syntax}:ACTION") - - @property - def action(self) -> ActoneventTriggerAction: - """Return the ``ACTONEVent:TRIGger:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:TRIGger:ACTION?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.saveimage``: The ``ACTONEVent:TRIGger:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:TRIGger:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:TRIGger:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:TRIGger:ACTION:STOPACQ`` command tree. - """ - return self._action - - -class ActoneventSearchActionStopacqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:SEARCH:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions when a search event is found. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:STOPACQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:SEARCH:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions when a search event is found feature. - - ``OFF`` disables the stop acquisitions when a search event is found feature. - - ```` is a number that enables or disables the stop acquisitions when a search event - is found feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventSearchActionStopacq(SCPICmdRead): - """The ``ACTONEVent:SEARCH:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:STOPACQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:SEARCH:ACTION:STOPACQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:SEARCH:ACTION:STOPACQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventSearchActionStopacqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventSearchActionStopacqState: - """Return the ``ACTONEVent:SEARCH:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions when a search event is found. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:SEARCH:ACTION:STOPACQ:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:SEARCH:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions when a search event is found feature. - - ``OFF`` disables the stop acquisitions when a search event is found feature. - - ```` is a number that enables or disables the stop acquisitions when a search - event is found feature. The number zero disables the feature, all other numbers enable - the feature. - """ - return self._state - - -class ActoneventSearchActionSrqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:SEARCH:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when any search event is found. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:SRQ:STATE?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:SEARCH:ACTION:SRQ:STATE?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:SEARCH:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when any search event is found feature. - - ``OFF`` disables the generate an SRQ event when any search event is found feature. - - ```` is a number that enables or disables the generate an SRQ event when any search - event is found feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventSearchActionSrq(SCPICmdRead): - """The ``ACTONEVent:SEARCH:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:SEARCH:ACTION:SRQ?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:SEARCH:ACTION:SRQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventSearchActionSrqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventSearchActionSrqState: - """Return the ``ACTONEVent:SEARCH:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when any search event is found. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:SRQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SRQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:SEARCH:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when any search event is found feature. - - ``OFF`` disables the generate an SRQ event when any search event is found feature. - - ```` is a number that enables or disables the generate an SRQ event when any - search event is found feature. The number zero disables the feature, all other numbers - enable the feature. - """ - return self._state - - -class ActoneventSearchActionSavewaveformState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) when a search event is found. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) when a search event is found feature. - - ``OFF`` disables the save source waveform(s) when a search event is found feature. - - ```` is a number that enables or disables the save source waveform(s) when a search - event is found feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventSearchActionSavewaveform(SCPICmdRead): - """The ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventSearchActionSavewaveformState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventSearchActionSavewaveformState: - """Return the ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) when a search event is found. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) when a search event is found feature. - - ``OFF`` disables the save source waveform(s) when a search event is found feature. - - ```` is a number that enables or disables the save source waveform(s) when a - search event is found feature. The number zero disables the feature, all other numbers - enable the feature. - """ - return self._state - - -class ActoneventSearchActionSaveimageState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture when a search event is found. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture when a search event is found feature. - - ``OFF`` disables the save screen capture when a search event is found feature. - - ```` is a number that enables or disables the save screen capture when a search event - is found feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventSearchActionSaveimage(SCPICmdRead): - """The ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventSearchActionSaveimageState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventSearchActionSaveimageState: - """Return the ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture when a search event is found. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture when a search event is found feature. - - ``OFF`` disables the save screen capture when a search event is found feature. - - ```` is a number that enables or disables the save screen capture when a search - event is found feature. The number zero disables the feature, all other numbers enable - the feature. - """ - return self._state - - -class ActoneventSearchAction(SCPICmdRead): - """The ``ACTONEVent:SEARCH:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:SEARCH:ACTION?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.saveimage``: The ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:SEARCH:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:SEARCH:ACTION:STOPACQ`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._saveimage = ActoneventSearchActionSaveimage(device, f"{self._cmd_syntax}:SAVEIMAGe") - self._savewaveform = ActoneventSearchActionSavewaveform( - device, f"{self._cmd_syntax}:SAVEWAVEform" - ) - self._srq = ActoneventSearchActionSrq(device, f"{self._cmd_syntax}:SRQ") - self._stopacq = ActoneventSearchActionStopacq(device, f"{self._cmd_syntax}:STOPACQ") - - @property - def saveimage(self) -> ActoneventSearchActionSaveimage: - """Return the ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe:STATE`` command. - """ - return self._saveimage - - @property - def savewaveform(self) -> ActoneventSearchActionSavewaveform: - """Return the ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform:STATE`` command. - """ - return self._savewaveform - - @property - def srq(self) -> ActoneventSearchActionSrq: - """Return the ``ACTONEVent:SEARCH:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:SEARCH:ACTION:SRQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:SEARCH:ACTION:SRQ:STATE`` command. - """ - return self._srq - - @property - def stopacq(self) -> ActoneventSearchActionStopacq: - """Return the ``ACTONEVent:SEARCH:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION:STOPACQ?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:SEARCH:ACTION:STOPACQ?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:SEARCH:ACTION:STOPACQ:STATE`` command. - """ - return self._stopacq - - -class ActoneventSearch(SCPICmdRead): - """The ``ACTONEVent:SEARCH`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:SEARCH?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.action``: The ``ACTONEVent:SEARCH:ACTION`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._action = ActoneventSearchAction(device, f"{self._cmd_syntax}:ACTION") - - @property - def action(self) -> ActoneventSearchAction: - """Return the ``ACTONEVent:SEARCH:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:SEARCH:ACTION?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.saveimage``: The ``ACTONEVent:SEARCH:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:SEARCH:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:SEARCH:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:SEARCH:ACTION:STOPACQ`` command tree. - """ - return self._action - - -class ActoneventMeasurementActionStopacqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions when the user-set measurement limit is exceeded. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions when the measurement limit is exceeded feature. - - ``OFF`` disables the stop acquisitions when the measurement limit is exceeded feature. - - ```` is a number that enables or disables the stop acquisitions when the measurement - limit is exceeded feature. The number zero disables the feature, all other numbers enable - the feature. - """ - - -class ActoneventMeasurementActionStopacq(SCPICmdRead): - """The ``ACTONEVent:MEASUrement:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MEASUrement:ACTION:STOPACQ?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:STOPACQ?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMeasurementActionStopacqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMeasurementActionStopacqState: - """Return the ``ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions when the user-set measurement limit is exceeded. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions when the measurement limit is exceeded feature. - - ``OFF`` disables the stop acquisitions when the measurement limit is exceeded feature. - - ```` is a number that enables or disables the stop acquisitions when the - measurement limit is exceeded feature. The number zero disables the feature, all other - numbers enable the feature. - """ - return self._state - - -class ActoneventMeasurementActionSrqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MEASUrement:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when any measurement triggers the user-defined - measurement limits. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MEASUrement:ACTION:SRQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SRQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MEASUrement:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when any measurement triggers the user-defined - measurement limits feature. - - ``OFF`` disables the generate an SRQ event when any measurement triggers the user-defined - measurement limits feature. - - ```` is a number that enables or disables the generate an SRQ event when any - measurement triggers the user-defined measurement limits feature. The number zero disables - the feature, all other numbers enable the feature. - """ - - -class ActoneventMeasurementActionSrq(SCPICmdRead): - """The ``ACTONEVent:MEASUrement:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MEASUrement:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MEASUrement:ACTION:SRQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MEASUrement:ACTION:SRQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMeasurementActionSrqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMeasurementActionSrqState: - """Return the ``ACTONEVent:MEASUrement:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when any measurement triggers the user-defined - measurement limits. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SRQ:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SRQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MEASUrement:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when any measurement triggers the - user-defined measurement limits feature. - - ``OFF`` disables the generate an SRQ event when any measurement triggers the - user-defined measurement limits feature. - - ```` is a number that enables or disables the generate an SRQ event when any - measurement triggers the user-defined measurement limits feature. The number zero - disables the feature, all other numbers enable the feature. - """ - return self._state - - -class ActoneventMeasurementActionSavewaveformState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) when the user-set measurement limit is - exceeded. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) when the measurement limit is exceeded feature. - - ``OFF`` disables the save source waveform(s) when the measurement limit is exceeded - feature. - - ```` is a number that enables or disables the save source waveform(s) when the - measurement limit is exceeded feature. The number zero disables the feature, all other - numbers enable the feature. - """ - - -class ActoneventMeasurementActionSavewaveform(SCPICmdRead): - """The ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMeasurementActionSavewaveformState( - device, f"{self._cmd_syntax}:STATE" - ) - - @property - def state(self) -> ActoneventMeasurementActionSavewaveformState: - """Return the ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) when the user-set measurement limit - is exceeded. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) when the measurement limit is exceeded - feature. - - ``OFF`` disables the save source waveform(s) when the measurement limit is exceeded - feature. - - ```` is a number that enables or disables the save source waveform(s) when the - measurement limit is exceeded feature. The number zero disables the feature, all other - numbers enable the feature. - """ - return self._state - - -class ActoneventMeasurementActionSaveimageState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture when the user-set measurement limit is exceeded. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture when the measurement limit is exceeded feature. - - ``OFF`` disables the save screen capture when the measurement limit is exceeded feature. - - ```` is a number that enables or disables the save screen capture when the - measurement limit is exceeded feature. The number zero disables the feature, all other - numbers enable the feature. - """ - - -class ActoneventMeasurementActionSaveimage(SCPICmdRead): - """The ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMeasurementActionSaveimageState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMeasurementActionSaveimageState: - """Return the ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture when the user-set measurement limit is exceeded. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture when the measurement limit is exceeded feature. - - ``OFF`` disables the save screen capture when the measurement limit is exceeded - feature. - - ```` is a number that enables or disables the save screen capture when the - measurement limit is exceeded feature. The number zero disables the feature, all other - numbers enable the feature. - """ - return self._state - - -class ActoneventMeasurementAction(SCPICmdRead): - """The ``ACTONEVent:MEASUrement:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MEASUrement:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MEASUrement:ACTION?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.saveimage``: The ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:MEASUrement:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:MEASUrement:ACTION:STOPACQ`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._saveimage = ActoneventMeasurementActionSaveimage( - device, f"{self._cmd_syntax}:SAVEIMAGe" - ) - self._savewaveform = ActoneventMeasurementActionSavewaveform( - device, f"{self._cmd_syntax}:SAVEWAVEform" - ) - self._srq = ActoneventMeasurementActionSrq(device, f"{self._cmd_syntax}:SRQ") - self._stopacq = ActoneventMeasurementActionStopacq(device, f"{self._cmd_syntax}:STOPACQ") - - @property - def saveimage(self) -> ActoneventMeasurementActionSaveimage: - """Return the ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe:STATE`` command. - """ - return self._saveimage - - @property - def savewaveform(self) -> ActoneventMeasurementActionSavewaveform: - """Return the ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform:STATE`` command. - """ - return self._savewaveform - - @property - def srq(self) -> ActoneventMeasurementActionSrq: - """Return the ``ACTONEVent:MEASUrement:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MEASUrement:ACTION:SRQ?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:SRQ?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MEASUrement:ACTION:SRQ:STATE`` command. - """ - return self._srq - - @property - def stopacq(self) -> ActoneventMeasurementActionStopacq: - """Return the ``ACTONEVent:MEASUrement:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MEASUrement:ACTION:STOPACQ?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MEASUrement:ACTION:STOPACQ?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MEASUrement:ACTION:STOPACQ:STATE`` command. - """ - return self._stopacq - - -class ActoneventMeasurement(SCPICmdRead): - """The ``ACTONEVent:MEASUrement`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MEASUrement?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MEASUrement?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.action``: The ``ACTONEVent:MEASUrement:ACTION`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._action = ActoneventMeasurementAction(device, f"{self._cmd_syntax}:ACTION") - - @property - def action(self) -> ActoneventMeasurementAction: - """Return the ``ACTONEVent:MEASUrement:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MEASUrement:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MEASUrement:ACTION?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.saveimage``: The ``ACTONEVent:MEASUrement:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:MEASUrement:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:MEASUrement:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:MEASUrement:ACTION:STOPACQ`` command tree. - """ - return self._action - - -class ActoneventMaskpassActionStopacqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKPass:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions when a mask test passes. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION:STOPACQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKPass:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions when a mask test passes feature. - - ``OFF`` disables the stop acquisitions when a mask test passes feature. - - ```` is a number that enables or disables the stop acquisitions when a mask test - passes feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventMaskpassActionStopacq(SCPICmdRead): - """The ``ACTONEVent:MASKPass:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION:STOPACQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKPass:ACTION:STOPACQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKPass:ACTION:STOPACQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskpassActionStopacqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskpassActionStopacqState: - """Return the ``ACTONEVent:MASKPass:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions when a mask test passes. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKPass:ACTION:STOPACQ:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKPass:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions when a mask test passes feature. - - ``OFF`` disables the stop acquisitions when a mask test passes feature. - - ```` is a number that enables or disables the stop acquisitions when a mask test - passes feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventMaskpassActionSrqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKPass:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when a mask passes. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION:SRQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SRQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKPass:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when a mask passes feature. - - ``OFF`` disables the generate an SRQ event when a mask passes feature. - - ```` is a number that enables or disables the generate an SRQ event when a mask - passes feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventMaskpassActionSrq(SCPICmdRead): - """The ``ACTONEVent:MASKPass:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKPass:ACTION:SRQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKPass:ACTION:SRQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskpassActionSrqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskpassActionSrqState: - """Return the ``ACTONEVent:MASKPass:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when a mask passes. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION:SRQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SRQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKPass:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when a mask passes feature. - - ``OFF`` disables the generate an SRQ event when a mask passes feature. - - ```` is a number that enables or disables the generate an SRQ event when a mask - passes feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventMaskpassActionSavewaveformState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) when a mask test passes. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) when a mask test passes feature. - - ``OFF`` disables the save source waveform(s) when a mask test passes feature. - - ```` is a number that enables or disables the save source waveform(s) when a mask - test passes feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventMaskpassActionSavewaveform(SCPICmdRead): - """The ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskpassActionSavewaveformState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskpassActionSavewaveformState: - """Return the ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) when a mask test passes. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) when a mask test passes feature. - - ``OFF`` disables the save source waveform(s) when a mask test passes feature. - - ```` is a number that enables or disables the save source waveform(s) when a mask - test passes feature. The number zero disables the feature, all other numbers enable - the feature. - """ - return self._state - - -class ActoneventMaskpassActionSaveimageState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture when a mask test passes. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture when a mask test passes feature. - - ``OFF`` disables the save screen capture when a mask test passes feature. - - ```` is a number that enables or disables the save screen capture when a mask test - passes feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventMaskpassActionSaveimage(SCPICmdRead): - """The ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskpassActionSaveimageState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskpassActionSaveimageState: - """Return the ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture when a mask test passes. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture when a mask test passes feature. - - ``OFF`` disables the save screen capture when a mask test passes feature. - - ```` is a number that enables or disables the save screen capture when a mask - test passes feature. The number zero disables the feature, all other numbers enable - the feature. - """ - return self._state - - -class ActoneventMaskpassAction(SCPICmdRead): - """The ``ACTONEVent:MASKPass:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKPass:ACTION?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.saveimage``: The ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:MASKPass:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:MASKPass:ACTION:STOPACQ`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._saveimage = ActoneventMaskpassActionSaveimage(device, f"{self._cmd_syntax}:SAVEIMAGe") - self._savewaveform = ActoneventMaskpassActionSavewaveform( - device, f"{self._cmd_syntax}:SAVEWAVEform" - ) - self._srq = ActoneventMaskpassActionSrq(device, f"{self._cmd_syntax}:SRQ") - self._stopacq = ActoneventMaskpassActionStopacq(device, f"{self._cmd_syntax}:STOPACQ") - - @property - def saveimage(self) -> ActoneventMaskpassActionSaveimage: - """Return the ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe:STATE`` command. - """ - return self._saveimage - - @property - def savewaveform(self) -> ActoneventMaskpassActionSavewaveform: - """Return the ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform:STATE`` command. - """ - return self._savewaveform - - @property - def srq(self) -> ActoneventMaskpassActionSrq: - """Return the ``ACTONEVent:MASKPass:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKPass:ACTION:SRQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKPass:ACTION:SRQ:STATE`` command. - """ - return self._srq - - @property - def stopacq(self) -> ActoneventMaskpassActionStopacq: - """Return the ``ACTONEVent:MASKPass:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION:STOPACQ?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKPass:ACTION:STOPACQ?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKPass:ACTION:STOPACQ:STATE`` command. - """ - return self._stopacq - - -class ActoneventMaskpass(SCPICmdRead): - """The ``ACTONEVent:MASKPass`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKPass?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.action``: The ``ACTONEVent:MASKPass:ACTION`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._action = ActoneventMaskpassAction(device, f"{self._cmd_syntax}:ACTION") - - @property - def action(self) -> ActoneventMaskpassAction: - """Return the ``ACTONEVent:MASKPass:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKPass:ACTION?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.saveimage``: The ``ACTONEVent:MASKPass:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:MASKPass:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:MASKPass:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:MASKPass:ACTION:STOPACQ`` command tree. - """ - return self._action - - -class ActoneventMaskhitActionStopacqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKHit:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions when a mask hit occurs. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:STOPACQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKHit:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions when a mask hit occurs feature. - - ``OFF`` disables the stop acquisitions when a mask hit occurs feature. - - ```` is a number that enables or disables the stop acquisitions when a mask hit - occurs feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventMaskhitActionStopacq(SCPICmdRead): - """The ``ACTONEVent:MASKHit:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:STOPACQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKHit:ACTION:STOPACQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKHit:ACTION:STOPACQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskhitActionStopacqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskhitActionStopacqState: - """Return the ``ACTONEVent:MASKHit:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions when a mask hit occurs. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKHit:ACTION:STOPACQ:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKHit:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions when a mask hit occurs feature. - - ``OFF`` disables the stop acquisitions when a mask hit occurs feature. - - ```` is a number that enables or disables the stop acquisitions when a mask hit - occurs feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventMaskhitActionSrqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKHit:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when a mask hit occurs. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:SRQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKHit:ACTION:SRQ:STATE?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKHit:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when a mask hit occurs feature. - - ``OFF`` disables the generate an SRQ event when a mask hit occurs feature. - - ```` is a number that enables or disables the generate an SRQ event when a mask hit - occurs feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventMaskhitActionSrq(SCPICmdRead): - """The ``ACTONEVent:MASKHit:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKHit:ACTION:SRQ?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKHit:ACTION:SRQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskhitActionSrqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskhitActionSrqState: - """Return the ``ACTONEVent:MASKHit:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when a mask hit occurs. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:SRQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SRQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKHit:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when a mask hit occurs feature. - - ``OFF`` disables the generate an SRQ event when a mask hit occurs feature. - - ```` is a number that enables or disables the generate an SRQ event when a mask - hit occurs feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventMaskhitActionSavewaveformState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) when a mask hit occurs. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) when a mask hit occurs feature. - - ``OFF`` disables the save source waveform(s) when a mask hit occurs feature. - - ```` is a number that enables or disables the save source waveform(s) when a mask hit - occurs feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventMaskhitActionSavewaveform(SCPICmdRead): - """The ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskhitActionSavewaveformState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskhitActionSavewaveformState: - """Return the ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) when a mask hit occurs. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) when a mask hit occurs feature. - - ``OFF`` disables the save source waveform(s) when a mask hit occurs feature. - - ```` is a number that enables or disables the save source waveform(s) when a mask - hit occurs feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventMaskhitActionSaveimageState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture when a mask hit occurs. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture when a mask hit occurs feature. - - ``OFF`` disables the save screen capture when a mask hit occurs feature. - - ```` is a number that enables or disables the save screen capture when a mask hit - occurs feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventMaskhitActionSaveimage(SCPICmdRead): - """The ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe?`` - query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskhitActionSaveimageState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskhitActionSaveimageState: - """Return the ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture when a mask hit occurs. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture when a mask hit occurs feature. - - ``OFF`` disables the save screen capture when a mask hit occurs feature. - - ```` is a number that enables or disables the save screen capture when a mask hit - occurs feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventMaskhitAction(SCPICmdRead): - """The ``ACTONEVent:MASKHit:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKHit:ACTION?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.saveimage``: The ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:MASKHit:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:MASKHit:ACTION:STOPACQ`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._saveimage = ActoneventMaskhitActionSaveimage(device, f"{self._cmd_syntax}:SAVEIMAGe") - self._savewaveform = ActoneventMaskhitActionSavewaveform( - device, f"{self._cmd_syntax}:SAVEWAVEform" - ) - self._srq = ActoneventMaskhitActionSrq(device, f"{self._cmd_syntax}:SRQ") - self._stopacq = ActoneventMaskhitActionStopacq(device, f"{self._cmd_syntax}:STOPACQ") - - @property - def saveimage(self) -> ActoneventMaskhitActionSaveimage: - """Return the ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe:STATE`` command. - """ - return self._saveimage - - @property - def savewaveform(self) -> ActoneventMaskhitActionSavewaveform: - """Return the ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform:STATE`` command. - """ - return self._savewaveform - - @property - def srq(self) -> ActoneventMaskhitActionSrq: - """Return the ``ACTONEVent:MASKHit:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKHit:ACTION:SRQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKHit:ACTION:SRQ:STATE`` command. - """ - return self._srq - - @property - def stopacq(self) -> ActoneventMaskhitActionStopacq: - """Return the ``ACTONEVent:MASKHit:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION:STOPACQ?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKHit:ACTION:STOPACQ?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKHit:ACTION:STOPACQ:STATE`` command. - """ - return self._stopacq - - -class ActoneventMaskhit(SCPICmdRead): - """The ``ACTONEVent:MASKHit`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKHit?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.action``: The ``ACTONEVent:MASKHit:ACTION`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._action = ActoneventMaskhitAction(device, f"{self._cmd_syntax}:ACTION") - - @property - def action(self) -> ActoneventMaskhitAction: - """Return the ``ACTONEVent:MASKHit:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKHit:ACTION?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.saveimage``: The ``ACTONEVent:MASKHit:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:MASKHit:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:MASKHit:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:MASKHit:ACTION:STOPACQ`` command tree. - """ - return self._action - - -class ActoneventMaskfailActionStopacqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKFail:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions when a mask test fails. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION:STOPACQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKFail:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions when a mask test fails feature. - - ``OFF`` disables the stop acquisitions when a mask test fails feature. - - ```` is a number that enables or disables the stop acquisitions when a mask test - fails feature. The number zero disables the feature, all other numbers enable the feature. - """ - - -class ActoneventMaskfailActionStopacq(SCPICmdRead): - """The ``ACTONEVent:MASKFail:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION:STOPACQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKFail:ACTION:STOPACQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKFail:ACTION:STOPACQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskfailActionStopacqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskfailActionStopacqState: - """Return the ``ACTONEVent:MASKFail:ACTION:STOPACQ:STATE`` command. - - **Description:** - - This command stops acquisitions when a mask test fails. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKFail:ACTION:STOPACQ:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:STOPACQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:STOPACQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKFail:ACTION:STOPACQ:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:STOPACQ:STATE? - - **Info:** - - ``ON`` enables the stop acquisitions when a mask test fails feature. - - ``OFF`` disables the stop acquisitions when a mask test fails feature. - - ```` is a number that enables or disables the stop acquisitions when a mask test - fails feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventMaskfailActionSrqState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKFail:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when a mask fails. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION:SRQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SRQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKFail:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when a mask fails feature. - - ``OFF`` disables the generate an SRQ event when a mask fails feature. - - ```` is a number that enables or disables the generate an SRQ event when a mask fails - feature. The number zero disables the feature, all other numbers enable the feature. - """ - - -class ActoneventMaskfailActionSrq(SCPICmdRead): - """The ``ACTONEVent:MASKFail:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKFail:ACTION:SRQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKFail:ACTION:SRQ:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskfailActionSrqState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskfailActionSrqState: - """Return the ``ACTONEVent:MASKFail:ACTION:SRQ:STATE`` command. - - **Description:** - - This command generates an SRQ event when a mask fails. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION:SRQ:STATE?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SRQ:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SRQ:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKFail:ACTION:SRQ:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:SRQ:STATE? - - **Info:** - - ``ON`` enables the generate an SRQ event when a mask fails feature. - - ``OFF`` disables the generate an SRQ event when a mask fails feature. - - ```` is a number that enables or disables the generate an SRQ event when a mask - fails feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventMaskfailActionSavewaveformState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) when a mask test fails. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) when a mask test fails feature. - - ``OFF`` disables the save source waveform(s) when a mask test fails feature. - - ```` is a number that enables or disables the save source waveform(s) when a mask - test fails feature. The number zero disables the feature, all other numbers enable the - feature. - """ - - -class ActoneventMaskfailActionSavewaveform(SCPICmdRead): - """The ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskfailActionSavewaveformState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskfailActionSavewaveformState: - """Return the ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE`` command. - - **Description:** - - This command saves the user set source waveform(s) when a mask test fails. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE? - - **Info:** - - ``ON`` enables the save source waveform(s) when a mask test fails feature. - - ``OFF`` disables the save source waveform(s) when a mask test fails feature. - - ```` is a number that enables or disables the save source waveform(s) when a mask - test fails feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventMaskfailActionSaveimageState(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture when a mask test fails. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture when a mask test fails feature. - - ``OFF`` disables the save screen capture when a mask test fails feature. - - ```` is a number that enables or disables the save screen capture when a mask test - fails feature. The number zero disables the feature, all other numbers enable the feature. - """ - - -class ActoneventMaskfailActionSaveimage(SCPICmdRead): - """The ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.state``: The ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._state = ActoneventMaskfailActionSaveimageState(device, f"{self._cmd_syntax}:STATE") - - @property - def state(self) -> ActoneventMaskfailActionSaveimageState: - """Return the ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE`` command. - - **Description:** - - This command saves a screen capture when a mask test fails. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE {ON|OFF|} - - ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE? - - **Info:** - - ``ON`` enables the save screen capture when a mask test fails feature. - - ``OFF`` disables the save screen capture when a mask test fails feature. - - ```` is a number that enables or disables the save screen capture when a mask - test fails feature. The number zero disables the feature, all other numbers enable the - feature. - """ - return self._state - - -class ActoneventMaskfailAction(SCPICmdRead): - """The ``ACTONEVent:MASKFail:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKFail:ACTION?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.saveimage``: The ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:MASKFail:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:MASKFail:ACTION:STOPACQ`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._saveimage = ActoneventMaskfailActionSaveimage(device, f"{self._cmd_syntax}:SAVEIMAGe") - self._savewaveform = ActoneventMaskfailActionSavewaveform( - device, f"{self._cmd_syntax}:SAVEWAVEform" - ) - self._srq = ActoneventMaskfailActionSrq(device, f"{self._cmd_syntax}:SRQ") - self._stopacq = ActoneventMaskfailActionStopacq(device, f"{self._cmd_syntax}:STOPACQ") - - @property - def saveimage(self) -> ActoneventMaskfailActionSaveimage: - """Return the ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe:STATE`` command. - """ - return self._saveimage - - @property - def savewaveform(self) -> ActoneventMaskfailActionSavewaveform: - """Return the ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform?`` query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform:STATE`` command. - """ - return self._savewaveform - - @property - def srq(self) -> ActoneventMaskfailActionSrq: - """Return the ``ACTONEVent:MASKFail:ACTION:SRQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION:SRQ?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKFail:ACTION:SRQ?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKFail:ACTION:SRQ:STATE`` command. - """ - return self._srq - - @property - def stopacq(self) -> ActoneventMaskfailActionStopacq: - """Return the ``ACTONEVent:MASKFail:ACTION:STOPACQ`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION:STOPACQ?`` - query. - - Using the ``.verify(value)`` method will send the - ``ACTONEVent:MASKFail:ACTION:STOPACQ?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.state``: The ``ACTONEVent:MASKFail:ACTION:STOPACQ:STATE`` command. - """ - return self._stopacq - - -class ActoneventMaskfail(SCPICmdRead): - """The ``ACTONEVent:MASKFail`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKFail?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.action``: The ``ACTONEVent:MASKFail:ACTION`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._action = ActoneventMaskfailAction(device, f"{self._cmd_syntax}:ACTION") - - @property - def action(self) -> ActoneventMaskfailAction: - """Return the ``ACTONEVent:MASKFail:ACTION`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail:ACTION?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKFail:ACTION?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.saveimage``: The ``ACTONEVent:MASKFail:ACTION:SAVEIMAGe`` command tree. - - ``.savewaveform``: The ``ACTONEVent:MASKFail:ACTION:SAVEWAVEform`` command tree. - - ``.srq``: The ``ACTONEVent:MASKFail:ACTION:SRQ`` command tree. - - ``.stopacq``: The ``ACTONEVent:MASKFail:ACTION:STOPACQ`` command tree. - """ - return self._action - - -class ActoneventLimit(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:LIMit`` command. - - **Description:** - - This command sets whether the act on event should limit the number of saves. This prevents - the saves from filling the hard drive. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:LIMit?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:LIMit?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``ACTONEVent:LIMit value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:LIMit - - ACTONEVent:LIMit? - - **Info:** - - ```` is a number that enables or disables whether the act on event should limit the - number of saves. The number zero disables the feature and the number one enables the - feature. - """ - - -class ActoneventLimitcount(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:LIMITCount`` command. - - **Description:** - - This command sets the limit of act on even saves. The ``ACTONEVent:LIMit`` command must be - enabled. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:LIMITCount?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:LIMITCount?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``ACTONEVent:LIMITCount value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:LIMITCount - - ACTONEVent:LIMITCount? - - **Info:** - - ```` sets the number of allowed saves for the act on event feature. The number must - be a positive integer. - """ - - -class ActoneventEnable(SCPICmdWrite, SCPICmdRead): - """The ``ACTONEVent:ENable`` command. - - **Description:** - - This command enables or disables actions on event (AOE). If AOE saves are limited and the - limit has been reached, this parameter will disable AOE. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:ENable?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:ENable?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``ACTONEVent:ENable value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:ENable - - ACTONEVent:ENable? - - **Info:** - - ```` is a number that enables or disables actions on event. The number zero disables - the feature and the number one enables the feature. - """ - - -# pylint: disable=too-many-instance-attributes -class Actonevent(SCPICmdRead): - """The ``ACTONEVent`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.enable``: The ``ACTONEVent:ENable`` command. - - ``.limitcount``: The ``ACTONEVent:LIMITCount`` command. - - ``.limit``: The ``ACTONEVent:LIMit`` command. - - ``.maskfail``: The ``ACTONEVent:MASKFail`` command tree. - - ``.maskhit``: The ``ACTONEVent:MASKHit`` command tree. - - ``.maskpass``: The ``ACTONEVent:MASKPass`` command tree. - - ``.measurement``: The ``ACTONEVent:MEASUrement`` command tree. - - ``.search``: The ``ACTONEVent:SEARCH`` command tree. - - ``.trigger``: The ``ACTONEVent:TRIGger`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "ACTONEVent") -> None: - super().__init__(device, cmd_syntax) - self._enable = ActoneventEnable(device, f"{self._cmd_syntax}:ENable") - self._limitcount = ActoneventLimitcount(device, f"{self._cmd_syntax}:LIMITCount") - self._limit = ActoneventLimit(device, f"{self._cmd_syntax}:LIMit") - self._maskfail = ActoneventMaskfail(device, f"{self._cmd_syntax}:MASKFail") - self._maskhit = ActoneventMaskhit(device, f"{self._cmd_syntax}:MASKHit") - self._maskpass = ActoneventMaskpass(device, f"{self._cmd_syntax}:MASKPass") - self._measurement = ActoneventMeasurement(device, f"{self._cmd_syntax}:MEASUrement") - self._search = ActoneventSearch(device, f"{self._cmd_syntax}:SEARCH") - self._trigger = ActoneventTrigger(device, f"{self._cmd_syntax}:TRIGger") - - @property - def enable(self) -> ActoneventEnable: - """Return the ``ACTONEVent:ENable`` command. - - **Description:** - - This command enables or disables actions on event (AOE). If AOE saves are limited and - the limit has been reached, this parameter will disable AOE. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:ENable?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:ENable?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``ACTONEVent:ENable value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:ENable - - ACTONEVent:ENable? - - **Info:** - - ```` is a number that enables or disables actions on event. The number zero - disables the feature and the number one enables the feature. - """ - return self._enable - - @property - def limitcount(self) -> ActoneventLimitcount: - """Return the ``ACTONEVent:LIMITCount`` command. - - **Description:** - - This command sets the limit of act on even saves. The ``ACTONEVent:LIMit`` command - must be enabled. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:LIMITCount?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:LIMITCount?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``ACTONEVent:LIMITCount value`` - command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:LIMITCount - - ACTONEVent:LIMITCount? - - **Info:** - - ```` sets the number of allowed saves for the act on event feature. The number - must be a positive integer. - """ - return self._limitcount - - @property - def limit(self) -> ActoneventLimit: - """Return the ``ACTONEVent:LIMit`` command. - - **Description:** - - This command sets whether the act on event should limit the number of saves. This - prevents the saves from filling the hard drive. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:LIMit?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:LIMit?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``ACTONEVent:LIMit value`` command. - - **SCPI Syntax:** - - :: - - - ACTONEVent:LIMit - - ACTONEVent:LIMit? - - **Info:** - - ```` is a number that enables or disables whether the act on event should limit - the number of saves. The number zero disables the feature and the number one enables - the feature. - """ - return self._limit - - @property - def maskfail(self) -> ActoneventMaskfail: - """Return the ``ACTONEVent:MASKFail`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKFail?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKFail?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.action``: The ``ACTONEVent:MASKFail:ACTION`` command tree. - """ - return self._maskfail - - @property - def maskhit(self) -> ActoneventMaskhit: - """Return the ``ACTONEVent:MASKHit`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKHit?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKHit?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.action``: The ``ACTONEVent:MASKHit:ACTION`` command tree. - """ - return self._maskhit - - @property - def maskpass(self) -> ActoneventMaskpass: - """Return the ``ACTONEVent:MASKPass`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MASKPass?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MASKPass?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.action``: The ``ACTONEVent:MASKPass:ACTION`` command tree. - """ - return self._maskpass - - @property - def measurement(self) -> ActoneventMeasurement: - """Return the ``ACTONEVent:MEASUrement`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:MEASUrement?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:MEASUrement?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.action``: The ``ACTONEVent:MEASUrement:ACTION`` command tree. - """ - return self._measurement - - @property - def search(self) -> ActoneventSearch: - """Return the ``ACTONEVent:SEARCH`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:SEARCH?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:SEARCH?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.action``: The ``ACTONEVent:SEARCH:ACTION`` command tree. - """ - return self._search - - @property - def trigger(self) -> ActoneventTrigger: - """Return the ``ACTONEVent:TRIGger`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``ACTONEVent:TRIGger?`` query. - - Using the ``.verify(value)`` method will send the ``ACTONEVent:TRIGger?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.action``: The ``ACTONEVent:TRIGger:ACTION`` command tree. - """ - return self._trigger diff --git a/src/tm_devices/commands/_c69b1_lpdmso/callouts.py b/src/tm_devices/commands/_c69b1_lpdmso/callouts.py deleted file mode 100644 index 2a85c8d3..00000000 --- a/src/tm_devices/commands/_c69b1_lpdmso/callouts.py +++ /dev/null @@ -1,905 +0,0 @@ -"""The callouts commands module. - -These commands are used in the following models: -LPD6, MSO2, MSO4, MSO5, MSO5B, MSO5LP, MSO6, MSO6B - -THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. - -Please report an issue if one is found. - -Commands and Queries: - -:: - - - CALLOUTS:CALLOUT - - CALLOUTS:CALLOUT:BOOKMark:SOURCE {CH} - - CALLOUTS:CALLOUT:BOOKMark:SOURCE? - - CALLOUTS:CALLOUT:BOOKMark:XPOS - - CALLOUTS:CALLOUT:BOOKMark:XPOS? - - CALLOUTS:CALLOUT:COLOR - - CALLOUTS:CALLOUT:COLOR? - - CALLOUTS:CALLOUT:DISPLAYPOSition:X - - CALLOUTS:CALLOUT:DISPLAYPOSition:X? - - CALLOUTS:CALLOUT:DISPLAYPOSition:Y - - CALLOUTS:CALLOUT:DISPLAYPOSition:Y? - - CALLOUTS:CALLOUT:FONT:BOLD {1|0} - - CALLOUTS:CALLOUT:FONT:BOLD? - - CALLOUTS:CALLOUT:FONT:ITALIC {1|0} - - CALLOUTS:CALLOUT:FONT:ITALIC? - - CALLOUTS:CALLOUT:FONT:SIZE - - CALLOUTS:CALLOUT:FONT:SIZE? - - CALLOUTS:CALLOUT:FONT:TYPE - - CALLOUTS:CALLOUT:FONT:TYPE? - - CALLOUTS:CALLOUT:FONT:UNDERLine {1|0} - - CALLOUTS:CALLOUT:FONT:UNDERLine? - - CALLOUTS:CALLOUT:TEXT - - CALLOUTS:CALLOUT:TEXT? - - CALLOUTS:CALLOUT:TYPE {NOTE|ARROW|RECTANGLE|BOOKMARK} - - CALLOUTS:CALLOUT:TYPE? -""" -from typing import Dict, Optional, TYPE_CHECKING - -from .._helpers import ( - DefaultDictPassKeyToFactory, - SCPICmdRead, - SCPICmdWrite, - SCPICmdWriteNoArguments, - ValidatedDynamicNumberCmd, -) - -if TYPE_CHECKING: - from tm_devices.drivers.pi.pi_device import PIDevice - - -class CalloutsCalloutItemType(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:TYPE`` command. - - **Description:** - - This command sets or queries type of the callout. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:TYPE?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:TYPE?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``CALLOUTS:CALLOUT:TYPE value`` - command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:TYPE {NOTE|ARROW|RECTANGLE|BOOKMARK} - - CALLOUTS:CALLOUT:TYPE? - - **Info:** - - ``NOTE`` specifies callout type as note. - - ``ARROW`` specifies callout type as arrow. - - ``RECTANGLE`` specifies callout type as rectangle. - - ``BOOKMARK`` specifies callout type as bookmark. - """ - - -class CalloutsCalloutItemText(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:TEXT`` command. - - **Description:** - - This command sets or queries the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:TEXT?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:TEXT?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``CALLOUTS:CALLOUT:TEXT value`` - command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:TEXT - - CALLOUTS:CALLOUT:TEXT? - - **Info:** - - ```` specifies the callout text. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class CalloutsCalloutItemFontUnderline(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:FONT:UNDERLine`` command. - - **Description:** - - This command sets or queries the underline state of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT:UNDERLine?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:UNDERLine?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:FONT:UNDERLine value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:FONT:UNDERLine {1|0} - - CALLOUTS:CALLOUT:FONT:UNDERLine? - - **Info:** - - ``1`` underlines the callout text. - - ``0`` does not underline the callout text. - """ - - -class CalloutsCalloutItemFontType(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:FONT:TYPE`` command. - - **Description:** - - This command sets or queries type of the callout. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT:TYPE?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:TYPE?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:TYPE value`` - command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:FONT:TYPE - - CALLOUTS:CALLOUT:FONT:TYPE? - - **Info:** - - ```` specifies the type of font for the callout text. The available font types - include: DejaVu Sans, DejaVu Sans Mono, DejaVu Serif, Frutiger LT Std, Monospace, Sans - Serif, Serif, Ubuntu, Ubuntu Condensed, and Ubuntu Mono. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class CalloutsCalloutItemFontSize(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:FONT:SIZE`` command. - - **Description:** - - This command sets or queries the font size of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT:SIZE?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:SIZE?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:SIZE value`` - command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:FONT:SIZE - - CALLOUTS:CALLOUT:FONT:SIZE? - - **Info:** - - ```` specifies the font size in points. - """ - - -class CalloutsCalloutItemFontItalic(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:FONT:ITALIC`` command. - - **Description:** - - This command sets or queries the italic state of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT:ITALIC?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:ITALIC?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:ITALIC value`` - command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:FONT:ITALIC {1|0} - - CALLOUTS:CALLOUT:FONT:ITALIC? - - **Info:** - - ``1`` specifies the callout font style as italic. - - ``0`` does not specify the font style as italic. - """ - - -class CalloutsCalloutItemFontBold(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:FONT:BOLD`` command. - - **Description:** - - This command sets or queries the bold state of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT:BOLD?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:BOLD?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:BOLD value`` - command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:FONT:BOLD {1|0} - - CALLOUTS:CALLOUT:FONT:BOLD? - - **Info:** - - ``1`` specifies the callout font weight as bold. - - ``0`` specifies the callout font weight as normal. - """ - - -class CalloutsCalloutItemFont(SCPICmdRead): - """The ``CALLOUTS:CALLOUT:FONT`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.bold``: The ``CALLOUTS:CALLOUT:FONT:BOLD`` command. - - ``.italic``: The ``CALLOUTS:CALLOUT:FONT:ITALIC`` command. - - ``.size``: The ``CALLOUTS:CALLOUT:FONT:SIZE`` command. - - ``.type``: The ``CALLOUTS:CALLOUT:FONT:TYPE`` command. - - ``.underline``: The ``CALLOUTS:CALLOUT:FONT:UNDERLine`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._bold = CalloutsCalloutItemFontBold(device, f"{self._cmd_syntax}:BOLD") - self._italic = CalloutsCalloutItemFontItalic(device, f"{self._cmd_syntax}:ITALIC") - self._size = CalloutsCalloutItemFontSize(device, f"{self._cmd_syntax}:SIZE") - self._type = CalloutsCalloutItemFontType(device, f"{self._cmd_syntax}:TYPE") - self._underline = CalloutsCalloutItemFontUnderline(device, f"{self._cmd_syntax}:UNDERLine") - - @property - def bold(self) -> CalloutsCalloutItemFontBold: - """Return the ``CALLOUTS:CALLOUT:FONT:BOLD`` command. - - **Description:** - - This command sets or queries the bold state of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT:BOLD?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:BOLD?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:FONT:BOLD value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:FONT:BOLD {1|0} - - CALLOUTS:CALLOUT:FONT:BOLD? - - **Info:** - - ``1`` specifies the callout font weight as bold. - - ``0`` specifies the callout font weight as normal. - """ - return self._bold - - @property - def italic(self) -> CalloutsCalloutItemFontItalic: - """Return the ``CALLOUTS:CALLOUT:FONT:ITALIC`` command. - - **Description:** - - This command sets or queries the italic state of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT:ITALIC?`` - query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:ITALIC?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:FONT:ITALIC value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:FONT:ITALIC {1|0} - - CALLOUTS:CALLOUT:FONT:ITALIC? - - **Info:** - - ``1`` specifies the callout font style as italic. - - ``0`` does not specify the font style as italic. - """ - return self._italic - - @property - def size(self) -> CalloutsCalloutItemFontSize: - """Return the ``CALLOUTS:CALLOUT:FONT:SIZE`` command. - - **Description:** - - This command sets or queries the font size of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT:SIZE?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:SIZE?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:FONT:SIZE value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:FONT:SIZE - - CALLOUTS:CALLOUT:FONT:SIZE? - - **Info:** - - ```` specifies the font size in points. - """ - return self._size - - @property - def type(self) -> CalloutsCalloutItemFontType: - """Return the ``CALLOUTS:CALLOUT:FONT:TYPE`` command. - - **Description:** - - This command sets or queries type of the callout. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT:TYPE?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT:TYPE?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:FONT:TYPE value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:FONT:TYPE - - CALLOUTS:CALLOUT:FONT:TYPE? - - **Info:** - - ```` specifies the type of font for the callout text. The available font - types include: DejaVu Sans, DejaVu Sans Mono, DejaVu Serif, Frutiger LT Std, - Monospace, Sans Serif, Serif, Ubuntu, Ubuntu Condensed, and Ubuntu Mono. - """ - return self._type - - @property - def underline(self) -> CalloutsCalloutItemFontUnderline: - """Return the ``CALLOUTS:CALLOUT:FONT:UNDERLine`` command. - - **Description:** - - This command sets or queries the underline state of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT:UNDERLine?`` - query. - - Using the ``.verify(value)`` method will send the - ``CALLOUTS:CALLOUT:FONT:UNDERLine?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:FONT:UNDERLine value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:FONT:UNDERLine {1|0} - - CALLOUTS:CALLOUT:FONT:UNDERLine? - - **Info:** - - ``1`` underlines the callout text. - - ``0`` does not underline the callout text. - """ - return self._underline - - -class CalloutsCalloutItemDisplaypositionY(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:DISPLAYPOSition:Y`` command. - - **Description:** - - This command sets or queries vertical display position of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:DISPLAYPOSition:Y?`` - query. - - Using the ``.verify(value)`` method will send the - ``CALLOUTS:CALLOUT:DISPLAYPOSition:Y?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:DISPLAYPOSition:Y value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:DISPLAYPOSition:Y - - CALLOUTS:CALLOUT:DISPLAYPOSition:Y? - - **Info:** - - ```` specifies the callout vertical display position. - """ - - -class CalloutsCalloutItemDisplaypositionX(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:DISPLAYPOSition:X`` command. - - **Description:** - - This command sets or queries horizontal display position of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:DISPLAYPOSition:X?`` - query. - - Using the ``.verify(value)`` method will send the - ``CALLOUTS:CALLOUT:DISPLAYPOSition:X?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:DISPLAYPOSition:X value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:DISPLAYPOSition:X - - CALLOUTS:CALLOUT:DISPLAYPOSition:X? - - **Info:** - - ```` specifies the callout horizontal display position. - """ - - -class CalloutsCalloutItemDisplayposition(SCPICmdRead): - """The ``CALLOUTS:CALLOUT:DISPLAYPOSition`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:DISPLAYPOSition?`` - query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:DISPLAYPOSition?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.x``: The ``CALLOUTS:CALLOUT:DISPLAYPOSition:X`` command. - - ``.y``: The ``CALLOUTS:CALLOUT:DISPLAYPOSition:Y`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._x = CalloutsCalloutItemDisplaypositionX(device, f"{self._cmd_syntax}:X") - self._y = CalloutsCalloutItemDisplaypositionY(device, f"{self._cmd_syntax}:Y") - - @property - def x(self) -> CalloutsCalloutItemDisplaypositionX: - """Return the ``CALLOUTS:CALLOUT:DISPLAYPOSition:X`` command. - - **Description:** - - This command sets or queries horizontal display position of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:DISPLAYPOSition:X?`` - query. - - Using the ``.verify(value)`` method will send the - ``CALLOUTS:CALLOUT:DISPLAYPOSition:X?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:DISPLAYPOSition:X value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:DISPLAYPOSition:X - - CALLOUTS:CALLOUT:DISPLAYPOSition:X? - - **Info:** - - ```` specifies the callout horizontal display position. - """ - return self._x - - @property - def y(self) -> CalloutsCalloutItemDisplaypositionY: - """Return the ``CALLOUTS:CALLOUT:DISPLAYPOSition:Y`` command. - - **Description:** - - This command sets or queries vertical display position of the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:DISPLAYPOSition:Y?`` - query. - - Using the ``.verify(value)`` method will send the - ``CALLOUTS:CALLOUT:DISPLAYPOSition:Y?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:DISPLAYPOSition:Y value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:DISPLAYPOSition:Y - - CALLOUTS:CALLOUT:DISPLAYPOSition:Y? - - **Info:** - - ```` specifies the callout vertical display position. - """ - return self._y - - -class CalloutsCalloutItemColor(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:COLOR`` command. - - **Description:** - - This command sets or queries the text color of the callout. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:COLOR?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:COLOR?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``CALLOUTS:CALLOUT:COLOR value`` - command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:COLOR - - CALLOUTS:CALLOUT:COLOR? - - **Info:** - - ```` specifies the callout text color using hexadecimal color values. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class CalloutsCalloutItemBookmarkXpos(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:BOOKMark:XPOS`` command. - - **Description:** - - This command sets or queries the X-Position of the Bookmark callout type. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:BOOKMark:XPOS?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:BOOKMark:XPOS?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:BOOKMark:XPOS value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:BOOKMark:XPOS - - CALLOUTS:CALLOUT:BOOKMark:XPOS? - - **Info:** - - ```` specifies the location of the bookmark linked to the source waveform in X-axis. - """ - - -class CalloutsCalloutItemBookmarkSource(SCPICmdWrite, SCPICmdRead): - """The ``CALLOUTS:CALLOUT:BOOKMark:SOURCE`` command. - - **Description:** - - This command sets or queries the source of the Bookmark callout type. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:BOOKMark:SOURCE?`` - query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:BOOKMark:SOURCE?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:BOOKMark:SOURCE value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:BOOKMark:SOURCE {CH} - - CALLOUTS:CALLOUT:BOOKMark:SOURCE? - - **Info:** - - ``CH1`` specifies the bookmark callout source as Ch1. - - ``CH2`` specifies the bookmark callout source as Ch2. - - ``CH3`` specifies the bookmark callout source as Ch3. - - ``CH4`` specifies the bookmark callout source as Ch4. - """ - - -class CalloutsCalloutItemBookmark(SCPICmdRead): - """The ``CALLOUTS:CALLOUT:BOOKMark`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:BOOKMark?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:BOOKMark?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.source``: The ``CALLOUTS:CALLOUT:BOOKMark:SOURCE`` command. - - ``.xpos``: The ``CALLOUTS:CALLOUT:BOOKMark:XPOS`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._source = CalloutsCalloutItemBookmarkSource(device, f"{self._cmd_syntax}:SOURCE") - self._xpos = CalloutsCalloutItemBookmarkXpos(device, f"{self._cmd_syntax}:XPOS") - - @property - def source(self) -> CalloutsCalloutItemBookmarkSource: - """Return the ``CALLOUTS:CALLOUT:BOOKMark:SOURCE`` command. - - **Description:** - - This command sets or queries the source of the Bookmark callout type. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:BOOKMark:SOURCE?`` - query. - - Using the ``.verify(value)`` method will send the - ``CALLOUTS:CALLOUT:BOOKMark:SOURCE?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:BOOKMark:SOURCE value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:BOOKMark:SOURCE {CH} - - CALLOUTS:CALLOUT:BOOKMark:SOURCE? - - **Info:** - - ``CH1`` specifies the bookmark callout source as Ch1. - - ``CH2`` specifies the bookmark callout source as Ch2. - - ``CH3`` specifies the bookmark callout source as Ch3. - - ``CH4`` specifies the bookmark callout source as Ch4. - """ - return self._source - - @property - def xpos(self) -> CalloutsCalloutItemBookmarkXpos: - """Return the ``CALLOUTS:CALLOUT:BOOKMark:XPOS`` command. - - **Description:** - - This command sets or queries the X-Position of the Bookmark callout type. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:BOOKMark:XPOS?`` - query. - - Using the ``.verify(value)`` method will send the - ``CALLOUTS:CALLOUT:BOOKMark:XPOS?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``CALLOUTS:CALLOUT:BOOKMark:XPOS value`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:BOOKMark:XPOS - - CALLOUTS:CALLOUT:BOOKMark:XPOS? - - **Info:** - - ```` specifies the location of the bookmark linked to the source waveform in - X-axis. - """ - return self._xpos - - -class CalloutsCalloutItem(ValidatedDynamicNumberCmd, SCPICmdWriteNoArguments, SCPICmdRead): - """The ``CALLOUTS:CALLOUT`` command. - - **Description:** - - This command creates a new note. A Note is the default callout value. The callout number - is specified by x. - - **Usage:** - - Using the ``.write()`` method will send the ``CALLOUTS:CALLOUT`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT - - Properties: - - ``.bookmark``: The ``CALLOUTS:CALLOUT:BOOKMark`` command tree. - - ``.color``: The ``CALLOUTS:CALLOUT:COLOR`` command. - - ``.displayposition``: The ``CALLOUTS:CALLOUT:DISPLAYPOSition`` command tree. - - ``.font``: The ``CALLOUTS:CALLOUT:FONT`` command tree. - - ``.text``: The ``CALLOUTS:CALLOUT:TEXT`` command. - - ``.type``: The ``CALLOUTS:CALLOUT:TYPE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._bookmark = CalloutsCalloutItemBookmark(device, f"{self._cmd_syntax}:BOOKMark") - self._color = CalloutsCalloutItemColor(device, f"{self._cmd_syntax}:COLOR") - self._displayposition = CalloutsCalloutItemDisplayposition( - device, f"{self._cmd_syntax}:DISPLAYPOSition" - ) - self._font = CalloutsCalloutItemFont(device, f"{self._cmd_syntax}:FONT") - self._text = CalloutsCalloutItemText(device, f"{self._cmd_syntax}:TEXT") - self._type = CalloutsCalloutItemType(device, f"{self._cmd_syntax}:TYPE") - - @property - def bookmark(self) -> CalloutsCalloutItemBookmark: - """Return the ``CALLOUTS:CALLOUT:BOOKMark`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:BOOKMark?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:BOOKMark?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.source``: The ``CALLOUTS:CALLOUT:BOOKMark:SOURCE`` command. - - ``.xpos``: The ``CALLOUTS:CALLOUT:BOOKMark:XPOS`` command. - """ - return self._bookmark - - @property - def color(self) -> CalloutsCalloutItemColor: - """Return the ``CALLOUTS:CALLOUT:COLOR`` command. - - **Description:** - - This command sets or queries the text color of the callout. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:COLOR?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:COLOR?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``CALLOUTS:CALLOUT:COLOR value`` - command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:COLOR - - CALLOUTS:CALLOUT:COLOR? - - **Info:** - - ```` specifies the callout text color using hexadecimal color values. - """ - return self._color - - @property - def displayposition(self) -> CalloutsCalloutItemDisplayposition: - """Return the ``CALLOUTS:CALLOUT:DISPLAYPOSition`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:DISPLAYPOSition?`` - query. - - Using the ``.verify(value)`` method will send the - ``CALLOUTS:CALLOUT:DISPLAYPOSition?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.x``: The ``CALLOUTS:CALLOUT:DISPLAYPOSition:X`` command. - - ``.y``: The ``CALLOUTS:CALLOUT:DISPLAYPOSition:Y`` command. - """ - return self._displayposition - - @property - def font(self) -> CalloutsCalloutItemFont: - """Return the ``CALLOUTS:CALLOUT:FONT`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:FONT?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:FONT?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.bold``: The ``CALLOUTS:CALLOUT:FONT:BOLD`` command. - - ``.italic``: The ``CALLOUTS:CALLOUT:FONT:ITALIC`` command. - - ``.size``: The ``CALLOUTS:CALLOUT:FONT:SIZE`` command. - - ``.type``: The ``CALLOUTS:CALLOUT:FONT:TYPE`` command. - - ``.underline``: The ``CALLOUTS:CALLOUT:FONT:UNDERLine`` command. - """ - return self._font - - @property - def text(self) -> CalloutsCalloutItemText: - """Return the ``CALLOUTS:CALLOUT:TEXT`` command. - - **Description:** - - This command sets or queries the callout text. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:TEXT?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:TEXT?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``CALLOUTS:CALLOUT:TEXT value`` - command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:TEXT - - CALLOUTS:CALLOUT:TEXT? - - **Info:** - - ```` specifies the callout text. - """ - return self._text - - @property - def type(self) -> CalloutsCalloutItemType: - """Return the ``CALLOUTS:CALLOUT:TYPE`` command. - - **Description:** - - This command sets or queries type of the callout. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT:TYPE?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT:TYPE?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``CALLOUTS:CALLOUT:TYPE value`` - command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT:TYPE {NOTE|ARROW|RECTANGLE|BOOKMARK} - - CALLOUTS:CALLOUT:TYPE? - - **Info:** - - ``NOTE`` specifies callout type as note. - - ``ARROW`` specifies callout type as arrow. - - ``RECTANGLE`` specifies callout type as rectangle. - - ``BOOKMARK`` specifies callout type as bookmark. - """ - return self._type - - -class Callouts(SCPICmdRead): - """The ``CALLOUTS`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``CALLOUTS?`` query. - - Using the ``.verify(value)`` method will send the ``CALLOUTS?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.callout``: The ``CALLOUTS:CALLOUT`` command. - """ - - def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "CALLOUTS") -> None: - super().__init__(device, cmd_syntax) - self._callout: Dict[int, CalloutsCalloutItem] = DefaultDictPassKeyToFactory( - lambda x: CalloutsCalloutItem(device, f"{self._cmd_syntax}:CALLOUT{x}") - ) - - @property - def callout(self) -> Dict[int, CalloutsCalloutItem]: - """Return the ``CALLOUTS:CALLOUT`` command. - - **Description:** - - This command creates a new note. A Note is the default callout value. The callout - number is specified by x. - - **Usage:** - - Using the ``.write()`` method will send the ``CALLOUTS:CALLOUT`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT - - Sub-properties: - - ``.bookmark``: The ``CALLOUTS:CALLOUT:BOOKMark`` command tree. - - ``.color``: The ``CALLOUTS:CALLOUT:COLOR`` command. - - ``.displayposition``: The ``CALLOUTS:CALLOUT:DISPLAYPOSition`` command tree. - - ``.font``: The ``CALLOUTS:CALLOUT:FONT`` command tree. - - ``.text``: The ``CALLOUTS:CALLOUT:TEXT`` command. - - ``.type``: The ``CALLOUTS:CALLOUT:TYPE`` command. - """ - return self._callout diff --git a/src/tm_devices/commands/_c69b1_lpdmso/diag.py b/src/tm_devices/commands/_c69b1_lpdmso/diag.py deleted file mode 100644 index c17b6493..00000000 --- a/src/tm_devices/commands/_c69b1_lpdmso/diag.py +++ /dev/null @@ -1,541 +0,0 @@ -"""The diag commands module. - -These commands are used in the following models: -LPD6, MSO2, MSO4, MSO5, MSO5B, MSO5LP, MSO6, MSO6B - -THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. - -Please report an issue if one is found. - -Commands and Queries: - -:: - - - DIAg:LOOP:OPTion {FAIL|ONCE|ALWAYS|ONFAIL|NTIMES} - - DIAg:LOOP:OPTion:NTIMes - - DIAg:LOOP:OPTion:NTIMes? - - DIAg:LOOP:OPTion? - - DIAg:LOOP:STOP - - DIAg:MODe {POST|EXTENDED|SERVICE} - - DIAg:MODe? - - DIAg:RESUlt:FLAg? - - DIAg:RESUlt:LOG? - - DIAg:RESUlt? - - DIAg:SELect {ALL|IO|ANALOG|SYSTEM|ASIC|ACQ|SIGNAL|MEMORY} - - DIAg:SELect? - - DIAg:STATE {EXECute|ABOrt} -""" -from typing import Optional, TYPE_CHECKING - -from .._helpers import SCPICmdRead, SCPICmdWrite, SCPICmdWriteNoArguments - -if TYPE_CHECKING: - from tm_devices.drivers.pi.pi_device import PIDevice - - -class DiagState(SCPICmdWrite): - """The ``DIAg:STATE`` command. - - **Description:** - - This command starts or aborts Self Test. Abort happens after group under test completes. - - **Usage:** - - Using the ``.write(value)`` method will send the ``DIAg:STATE value`` command. - - **SCPI Syntax:** - - :: - - - DIAg:STATE {EXECute|ABOrt} - - **Info:** - - ``EXECUTE`` starts execution of the diagnostics. - - ``ABOrt`` disables diagnostics capabilities and returns the instrument to a normal - operating state. - """ - - -class DiagSelect(SCPICmdWrite, SCPICmdRead): - """The ``DIAg:SELect`` command. - - **Description:** - - This command selects or queries an available diagnostic area. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:SELect?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:SELect?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``DIAg:SELect value`` command. - - **SCPI Syntax:** - - :: - - - DIAg:SELect {ALL|IO|ANALOG|SYSTEM|ASIC|ACQ|SIGNAL|MEMORY} - - DIAg:SELect? - - **Info:** - - ``ALL`` selects all diagnostic areas. - - ``IO`` selects the IO group. - - ``ANALOG`` selects the ANALOG diagnostic area. - - ``SYSTEM`` selects the SYSTEM diagnostic area. - - ``ASIC`` selects the ASIC diagnostic area. - - ``ACQ`` selects the ACQ diagnostic area. - - ``SIGNAL`` selects the SIGNAL diagnostic area. - - ``MEMORY`` selects the MEMORY diagnostic area. - """ - - -class DiagResultLog(SCPICmdRead): - """The ``DIAg:RESUlt:LOG`` command. - - **Description:** - - This query returns the test Pass/Fail status of each diagnostic area. It does not return - the overall status. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:RESUlt:LOG?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:RESUlt:LOG?`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - DIAg:RESUlt:LOG? - """ - - -class DiagResultFlag(SCPICmdRead): - """The ``DIAg:RESUlt:FLAg`` command. - - **Description:** - - This query returns the status of the diagnostic test area that has been selected. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:RESUlt:FLAg?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:RESUlt:FLAg?`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - DIAg:RESUlt:FLAg? - """ - - -class DiagResult(SCPICmdRead): - """The ``DIAg:RESUlt`` command. - - **Description:** - - This query returns both the overall diagnostics test results and the results of each - individual test area. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:RESUlt?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:RESUlt?`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - DIAg:RESUlt? - - Properties: - - ``.flag``: The ``DIAg:RESUlt:FLAg`` command. - - ``.log``: The ``DIAg:RESUlt:LOG`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._flag = DiagResultFlag(device, f"{self._cmd_syntax}:FLAg") - self._log = DiagResultLog(device, f"{self._cmd_syntax}:LOG") - - @property - def flag(self) -> DiagResultFlag: - """Return the ``DIAg:RESUlt:FLAg`` command. - - **Description:** - - This query returns the status of the diagnostic test area that has been selected. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:RESUlt:FLAg?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:RESUlt:FLAg?`` query and - raise an AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - DIAg:RESUlt:FLAg? - """ - return self._flag - - @property - def log(self) -> DiagResultLog: - """Return the ``DIAg:RESUlt:LOG`` command. - - **Description:** - - This query returns the test Pass/Fail status of each diagnostic area. It does not - return the overall status. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:RESUlt:LOG?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:RESUlt:LOG?`` query and raise - an AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - DIAg:RESUlt:LOG? - """ - return self._log - - -class DiagMode(SCPICmdWrite, SCPICmdRead): - """The ``DIAg:MODe`` command. - - **Description:** - - This command sets or queries the diagnostics mode. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:MODe?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:MODe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``DIAg:MODe value`` command. - - **SCPI Syntax:** - - :: - - - DIAg:MODe {POST|EXTENDED|SERVICE} - - DIAg:MODe? - - **Info:** - - ``POST`` specifies the power on self test diagnostics. - - ``EXTENDED`` specifies the extended diagnostics. - - ``SERVICE`` specifies the service diagnostics. - """ - - -class DiagLoopStop(SCPICmdWriteNoArguments): - """The ``DIAg:LOOP:STOP`` command. - - **Description:** - - Request that diagnostics stop looping. - - **Usage:** - - Using the ``.write()`` method will send the ``DIAg:LOOP:STOP`` command. - - **SCPI Syntax:** - - :: - - - DIAg:LOOP:STOP - """ - - -class DiagLoopOptionNtimes(SCPICmdWrite, SCPICmdRead): - """The ``DIAg:LOOP:OPTion:NTIMes`` command. - - **Description:** - - This command sets or queries how many loops to run, if N-times is being used. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:LOOP:OPTion:NTIMes?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:LOOP:OPTion:NTIMes?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``DIAg:LOOP:OPTion:NTIMes value`` - command. - - **SCPI Syntax:** - - :: - - - DIAg:LOOP:OPTion:NTIMes - - DIAg:LOOP:OPTion:NTIMes? - - **Info:** - - ```` is how many loops to run. - """ - - -class DiagLoopOption(SCPICmdWrite, SCPICmdRead): - """The ``DIAg:LOOP:OPTion`` command. - - **Description:** - - This command sets or queries the type of looping desired. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:LOOP:OPTion?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:LOOP:OPTion?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``DIAg:LOOP:OPTion value`` command. - - **SCPI Syntax:** - - :: - - - DIAg:LOOP:OPTion {FAIL|ONCE|ALWAYS|ONFAIL|NTIMES} - - DIAg:LOOP:OPTion? - - **Info:** - - ``Fail`` - run until a failure is found, then halt. - - ``Once`` - run through one loop. - - ``Always`` - run forever. - - ``Onfail`` - run until a failure is found, then loop on it. - - ``Ntimes`` - run n number of loops. - - Properties: - - ``.ntimes``: The ``DIAg:LOOP:OPTion:NTIMes`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._ntimes = DiagLoopOptionNtimes(device, f"{self._cmd_syntax}:NTIMes") - - @property - def ntimes(self) -> DiagLoopOptionNtimes: - """Return the ``DIAg:LOOP:OPTion:NTIMes`` command. - - **Description:** - - This command sets or queries how many loops to run, if N-times is being used. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:LOOP:OPTion:NTIMes?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:LOOP:OPTion:NTIMes?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``DIAg:LOOP:OPTion:NTIMes value`` - command. - - **SCPI Syntax:** - - :: - - - DIAg:LOOP:OPTion:NTIMes - - DIAg:LOOP:OPTion:NTIMes? - - **Info:** - - ```` is how many loops to run. - """ - return self._ntimes - - -class DiagLoop(SCPICmdRead): - """The ``DIAg:LOOP`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:LOOP?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:LOOP?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.option``: The ``DIAg:LOOP:OPTion`` command. - - ``.stop``: The ``DIAg:LOOP:STOP`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._option = DiagLoopOption(device, f"{self._cmd_syntax}:OPTion") - self._stop = DiagLoopStop(device, f"{self._cmd_syntax}:STOP") - - @property - def option(self) -> DiagLoopOption: - """Return the ``DIAg:LOOP:OPTion`` command. - - **Description:** - - This command sets or queries the type of looping desired. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:LOOP:OPTion?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:LOOP:OPTion?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``DIAg:LOOP:OPTion value`` command. - - **SCPI Syntax:** - - :: - - - DIAg:LOOP:OPTion {FAIL|ONCE|ALWAYS|ONFAIL|NTIMES} - - DIAg:LOOP:OPTion? - - **Info:** - - ``Fail`` - run until a failure is found, then halt. - - ``Once`` - run through one loop. - - ``Always`` - run forever. - - ``Onfail`` - run until a failure is found, then loop on it. - - ``Ntimes`` - run n number of loops. - - Sub-properties: - - ``.ntimes``: The ``DIAg:LOOP:OPTion:NTIMes`` command. - """ - return self._option - - @property - def stop(self) -> DiagLoopStop: - """Return the ``DIAg:LOOP:STOP`` command. - - **Description:** - - Request that diagnostics stop looping. - - **Usage:** - - Using the ``.write()`` method will send the ``DIAg:LOOP:STOP`` command. - - **SCPI Syntax:** - - :: - - - DIAg:LOOP:STOP - """ - return self._stop - - -class Diag(SCPICmdRead): - """The ``DIAg`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.loop``: The ``DIAg:LOOP`` command tree. - - ``.mode``: The ``DIAg:MODe`` command. - - ``.result``: The ``DIAg:RESUlt`` command. - - ``.select``: The ``DIAg:SELect`` command. - - ``.state``: The ``DIAg:STATE`` command. - """ - - def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "DIAg") -> None: - super().__init__(device, cmd_syntax) - self._loop = DiagLoop(device, f"{self._cmd_syntax}:LOOP") - self._mode = DiagMode(device, f"{self._cmd_syntax}:MODe") - self._result = DiagResult(device, f"{self._cmd_syntax}:RESUlt") - self._select = DiagSelect(device, f"{self._cmd_syntax}:SELect") - self._state = DiagState(device, f"{self._cmd_syntax}:STATE") - - @property - def loop(self) -> DiagLoop: - """Return the ``DIAg:LOOP`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:LOOP?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:LOOP?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.option``: The ``DIAg:LOOP:OPTion`` command. - - ``.stop``: The ``DIAg:LOOP:STOP`` command. - """ - return self._loop - - @property - def mode(self) -> DiagMode: - """Return the ``DIAg:MODe`` command. - - **Description:** - - This command sets or queries the diagnostics mode. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:MODe?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:MODe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``DIAg:MODe value`` command. - - **SCPI Syntax:** - - :: - - - DIAg:MODe {POST|EXTENDED|SERVICE} - - DIAg:MODe? - - **Info:** - - ``POST`` specifies the power on self test diagnostics. - - ``EXTENDED`` specifies the extended diagnostics. - - ``SERVICE`` specifies the service diagnostics. - """ - return self._mode - - @property - def result(self) -> DiagResult: - """Return the ``DIAg:RESUlt`` command. - - **Description:** - - This query returns both the overall diagnostics test results and the results of each - individual test area. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:RESUlt?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:RESUlt?`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - DIAg:RESUlt? - - Sub-properties: - - ``.flag``: The ``DIAg:RESUlt:FLAg`` command. - - ``.log``: The ``DIAg:RESUlt:LOG`` command. - """ - return self._result - - @property - def select(self) -> DiagSelect: - """Return the ``DIAg:SELect`` command. - - **Description:** - - This command selects or queries an available diagnostic area. - - **Usage:** - - Using the ``.query()`` method will send the ``DIAg:SELect?`` query. - - Using the ``.verify(value)`` method will send the ``DIAg:SELect?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``DIAg:SELect value`` command. - - **SCPI Syntax:** - - :: - - - DIAg:SELect {ALL|IO|ANALOG|SYSTEM|ASIC|ACQ|SIGNAL|MEMORY} - - DIAg:SELect? - - **Info:** - - ``ALL`` selects all diagnostic areas. - - ``IO`` selects the IO group. - - ``ANALOG`` selects the ANALOG diagnostic area. - - ``SYSTEM`` selects the SYSTEM diagnostic area. - - ``ASIC`` selects the ASIC diagnostic area. - - ``ACQ`` selects the ACQ diagnostic area. - - ``SIGNAL`` selects the SIGNAL diagnostic area. - - ``MEMORY`` selects the MEMORY diagnostic area. - """ - return self._select - - @property - def state(self) -> DiagState: - """Return the ``DIAg:STATE`` command. - - **Description:** - - This command starts or aborts Self Test. Abort happens after group under test - completes. - - **Usage:** - - Using the ``.write(value)`` method will send the ``DIAg:STATE value`` command. - - **SCPI Syntax:** - - :: - - - DIAg:STATE {EXECute|ABOrt} - - **Info:** - - ``EXECUTE`` starts execution of the diagnostics. - - ``ABOrt`` disables diagnostics capabilities and returns the instrument to a normal - operating state. - """ - return self._state diff --git a/src/tm_devices/commands/_c69b1_lpdmso/ref.py b/src/tm_devices/commands/_c69b1_lpdmso/ref.py deleted file mode 100644 index 17f196f4..00000000 --- a/src/tm_devices/commands/_c69b1_lpdmso/ref.py +++ /dev/null @@ -1,850 +0,0 @@ -"""The ref commands module. - -These commands are used in the following models: -LPD6, MSO2, MSO4, MSO5, MSO5B, MSO5LP, MSO6, MSO6B - -THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. - -Please report an issue if one is found. - -Commands and Queries: - -:: - - - REF:ADDNew - - REF:DELete - - REF:LIST? - - REF:REF:DESKew - - REF:REF:LABel:COLor - - REF:REF:LABel:FONT:BOLD {|OFF|ON} - - REF:REF:LABel:FONT:ITALic {|OFF|ON} - - REF:REF:LABel:FONT:SIZE - - REF:REF:LABel:FONT:TYPE - - REF:REF:LABel:FONT:UNDERline {|OFF|ON} - - REF:REF:LABel:NAMe - - REF:REF:LABel:NAMe? - - REF:REF:LABel:XPOS - - REF:REF:LABel:XPOS? - - REF:REF:LABel:YPOS - - REF:REF:LABel:YPOS? - - REF:REF:SOUrce -""" -from typing import Dict, Optional, TYPE_CHECKING - -from .._helpers import ( - DefaultDictPassKeyToFactory, - SCPICmdRead, - SCPICmdWrite, - ValidatedDynamicNumberCmd, -) - -if TYPE_CHECKING: - from tm_devices.drivers.pi.pi_device import PIDevice - - -class RefRefItemSource(SCPICmdWrite): - """The ``REF:REF:SOUrce`` command. - - **Description:** - - This command sets or queries the filename used by the given reference. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:SOUrce value`` command. - - **SCPI Syntax:** - - :: - - - REF:REF:SOUrce - - **Info:** - - ```` is the reference file name. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class RefRefItemLabelYpos(SCPICmdWrite, SCPICmdRead): - """The ``REF:REF:LABel:YPOS`` command. - - **Description:** - - This command sets or queries the Y-position of the label (attached to the displayed - waveform of the specified reference), relative to the baseline of the waveform. The - reference waveform is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF:LABel:YPOS?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:YPOS?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:YPOS value`` command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:YPOS - - REF:REF:LABel:YPOS? - - **Info:** - - ```` is the location where the waveform label for the selected reference is - displayed, relative to the baseline of the waveform. - """ - - -class RefRefItemLabelXpos(SCPICmdWrite, SCPICmdRead): - """The ``REF:REF:LABel:XPOS`` command. - - **Description:** - - This command sets or queries the X-position at which the label (attached to the displayed - waveform of the specified reference) is displayed, relative to the left edge of the - waveview. The reference waveform is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF:LABel:XPOS?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:XPOS?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:XPOS value`` command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:XPOS - - REF:REF:LABel:XPOS? - - **Info:** - - ```` is the location (control in divisions) where the waveform label for the selected - reference is displayed, relative to the left edge of the screen. - """ - - -class RefRefItemLabelName(SCPICmdWrite, SCPICmdRead): - """The ``REF:REF:LABel:NAMe`` command. - - **Description:** - - This command sets or queries the label of the specified reference. The reference waveform - is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF:LABel:NAMe?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:NAMe?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:NAMe value`` command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:NAMe - - REF:REF:LABel:NAMe? - - **Info:** - - ```` is the character string that will be used for the reference waveform label - name. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class RefRefItemLabelFontUnderline(SCPICmdWrite): - """The ``REF:REF:LABel:FONT:UNDERline`` command. - - **Description:** - - This command sets or queries the underline state of the specified reference label. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:UNDERline value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:FONT:UNDERline {|OFF|ON} - - **Info:** - - ```` = 0 disables underline font; any other value turns this feature on. - - ``OFF`` disables underline font. - - ``ON`` enables underline font. - """ - - -class RefRefItemLabelFontType(SCPICmdWrite): - """The ``REF:REF:LABel:FONT:TYPE`` command. - - **Description:** - - This command sets or queries the font type of the specified reference label, such as Arial - or Times New Roman. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:TYPE value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:FONT:TYPE - - **Info:** - - ```` is the font type. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class RefRefItemLabelFontSize(SCPICmdWrite): - """The ``REF:REF:LABel:FONT:SIZE`` command. - - **Description:** - - This command sets or queries the font size of the specified reference label. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:SIZE value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:FONT:SIZE - - **Info:** - - ```` is the font size of the label. - """ - - -class RefRefItemLabelFontItalic(SCPICmdWrite): - """The ``REF:REF:LABel:FONT:ITALic`` command. - - **Description:** - - This command sets or queries the italic state of the specified reference label. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:ITALic value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:FONT:ITALic {|OFF|ON} - - **Info:** - - ```` = 0 disables italic font; any other value turns this feature on. - - ``OFF`` disables italic font. - - ``ON`` enables italic font. - """ - - -class RefRefItemLabelFontBold(SCPICmdWrite): - """The ``REF:REF:LABel:FONT:BOLD`` command. - - **Description:** - - This command sets or queries the bold state of the specified reference label. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:BOLD value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:FONT:BOLD {|OFF|ON} - - **Info:** - - ```` = 0 disables bold font; any other value turns this feature on. - - ``OFF`` disables bold font. - - ``ON`` enables bold font. - """ - - -class RefRefItemLabelFont(SCPICmdRead): - """The ``REF:REF:LABel:FONT`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.bold``: The ``REF:REF:LABel:FONT:BOLD`` command. - - ``.italic``: The ``REF:REF:LABel:FONT:ITALic`` command. - - ``.size``: The ``REF:REF:LABel:FONT:SIZE`` command. - - ``.type``: The ``REF:REF:LABel:FONT:TYPE`` command. - - ``.underline``: The ``REF:REF:LABel:FONT:UNDERline`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._bold = RefRefItemLabelFontBold(device, f"{self._cmd_syntax}:BOLD") - self._italic = RefRefItemLabelFontItalic(device, f"{self._cmd_syntax}:ITALic") - self._size = RefRefItemLabelFontSize(device, f"{self._cmd_syntax}:SIZE") - self._type = RefRefItemLabelFontType(device, f"{self._cmd_syntax}:TYPE") - self._underline = RefRefItemLabelFontUnderline(device, f"{self._cmd_syntax}:UNDERline") - - @property - def bold(self) -> RefRefItemLabelFontBold: - """Return the ``REF:REF:LABel:FONT:BOLD`` command. - - **Description:** - - This command sets or queries the bold state of the specified reference label. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:BOLD value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:FONT:BOLD {|OFF|ON} - - **Info:** - - ```` = 0 disables bold font; any other value turns this feature on. - - ``OFF`` disables bold font. - - ``ON`` enables bold font. - """ - return self._bold - - @property - def italic(self) -> RefRefItemLabelFontItalic: - """Return the ``REF:REF:LABel:FONT:ITALic`` command. - - **Description:** - - This command sets or queries the italic state of the specified reference label. - - **Usage:** - - Using the ``.write(value)`` method will send the - ``REF:REF:LABel:FONT:ITALic value`` command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:FONT:ITALic {|OFF|ON} - - **Info:** - - ```` = 0 disables italic font; any other value turns this feature on. - - ``OFF`` disables italic font. - - ``ON`` enables italic font. - """ - return self._italic - - @property - def size(self) -> RefRefItemLabelFontSize: - """Return the ``REF:REF:LABel:FONT:SIZE`` command. - - **Description:** - - This command sets or queries the font size of the specified reference label. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:SIZE value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:FONT:SIZE - - **Info:** - - ```` is the font size of the label. - """ - return self._size - - @property - def type(self) -> RefRefItemLabelFontType: - """Return the ``REF:REF:LABel:FONT:TYPE`` command. - - **Description:** - - This command sets or queries the font type of the specified reference label, such as - Arial or Times New Roman. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:TYPE value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:FONT:TYPE - - **Info:** - - ```` is the font type. - """ - return self._type - - @property - def underline(self) -> RefRefItemLabelFontUnderline: - """Return the ``REF:REF:LABel:FONT:UNDERline`` command. - - **Description:** - - This command sets or queries the underline state of the specified reference label. - - **Usage:** - - Using the ``.write(value)`` method will send the - ``REF:REF:LABel:FONT:UNDERline value`` command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:FONT:UNDERline {|OFF|ON} - - **Info:** - - ```` = 0 disables underline font; any other value turns this feature on. - - ``OFF`` disables underline font. - - ``ON`` enables underline font. - """ - return self._underline - - -class RefRefItemLabelColor(SCPICmdWrite): - """The ``REF:REF:LABel:COLor`` command. - - **Description:** - - This command sets or queries the color of the specified ref label. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:COLor value`` command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:COLor - - **Info:** - - ```` is the label. To return the color to the default color, send an empty string - as in this example: ``:REF:REF1:LABEL:COLOR`` ''. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class RefRefItemLabel(SCPICmdRead): - """The ``REF:REF:LABel`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF:LABel?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF:LABel?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.color``: The ``REF:REF:LABel:COLor`` command. - - ``.font``: The ``REF:REF:LABel:FONT`` command tree. - - ``.name``: The ``REF:REF:LABel:NAMe`` command. - - ``.xpos``: The ``REF:REF:LABel:XPOS`` command. - - ``.ypos``: The ``REF:REF:LABel:YPOS`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._color = RefRefItemLabelColor(device, f"{self._cmd_syntax}:COLor") - self._font = RefRefItemLabelFont(device, f"{self._cmd_syntax}:FONT") - self._name = RefRefItemLabelName(device, f"{self._cmd_syntax}:NAMe") - self._xpos = RefRefItemLabelXpos(device, f"{self._cmd_syntax}:XPOS") - self._ypos = RefRefItemLabelYpos(device, f"{self._cmd_syntax}:YPOS") - - @property - def color(self) -> RefRefItemLabelColor: - """Return the ``REF:REF:LABel:COLor`` command. - - **Description:** - - This command sets or queries the color of the specified ref label. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:COLor value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:COLor - - **Info:** - - ```` is the label. To return the color to the default color, send an empty - string as in this example: ``:REF:REF1:LABEL:COLOR`` ''. - """ - return self._color - - @property - def font(self) -> RefRefItemLabelFont: - """Return the ``REF:REF:LABel:FONT`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.bold``: The ``REF:REF:LABel:FONT:BOLD`` command. - - ``.italic``: The ``REF:REF:LABel:FONT:ITALic`` command. - - ``.size``: The ``REF:REF:LABel:FONT:SIZE`` command. - - ``.type``: The ``REF:REF:LABel:FONT:TYPE`` command. - - ``.underline``: The ``REF:REF:LABel:FONT:UNDERline`` command. - """ - return self._font - - @property - def name(self) -> RefRefItemLabelName: - """Return the ``REF:REF:LABel:NAMe`` command. - - **Description:** - - This command sets or queries the label of the specified reference. The reference - waveform is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF:LABel:NAMe?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:NAMe?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:NAMe value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:NAMe - - REF:REF:LABel:NAMe? - - **Info:** - - ```` is the character string that will be used for the reference waveform - label name. - """ - return self._name - - @property - def xpos(self) -> RefRefItemLabelXpos: - """Return the ``REF:REF:LABel:XPOS`` command. - - **Description:** - - This command sets or queries the X-position at which the label (attached to the - displayed waveform of the specified reference) is displayed, relative to the left edge - of the waveview. The reference waveform is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF:LABel:XPOS?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:XPOS?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:XPOS value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:XPOS - - REF:REF:LABel:XPOS? - - **Info:** - - ```` is the location (control in divisions) where the waveform label for the - selected reference is displayed, relative to the left edge of the screen. - """ - return self._xpos - - @property - def ypos(self) -> RefRefItemLabelYpos: - """Return the ``REF:REF:LABel:YPOS`` command. - - **Description:** - - This command sets or queries the Y-position of the label (attached to the displayed - waveform of the specified reference), relative to the baseline of the waveform. The - reference waveform is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF:LABel:YPOS?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:YPOS?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``REF:REF:LABel:YPOS value`` - command. - - **SCPI Syntax:** - - :: - - - REF:REF:LABel:YPOS - - REF:REF:LABel:YPOS? - - **Info:** - - ```` is the location where the waveform label for the selected reference is - displayed, relative to the baseline of the waveform. - """ - return self._ypos - - -class RefRefItemDeskew(SCPICmdWrite): - """The ``REF:REF:DESKew`` command. - - **Description:** - - This command sets or queries the deskew value used for the specified reference. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:DESKew value`` command. - - **SCPI Syntax:** - - :: - - - REF:REF:DESKew - - **Info:** - - ```` is the deskew value used for the specified reference. - """ - - -class RefRefItem(ValidatedDynamicNumberCmd, SCPICmdRead): - """The ``REF:REF`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.deskew``: The ``REF:REF:DESKew`` command. - - ``.label``: The ``REF:REF:LABel`` command tree. - - ``.source``: The ``REF:REF:SOUrce`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._deskew = RefRefItemDeskew(device, f"{self._cmd_syntax}:DESKew") - self._label = RefRefItemLabel(device, f"{self._cmd_syntax}:LABel") - self._source = RefRefItemSource(device, f"{self._cmd_syntax}:SOUrce") - - @property - def deskew(self) -> RefRefItemDeskew: - """Return the ``REF:REF:DESKew`` command. - - **Description:** - - This command sets or queries the deskew value used for the specified reference. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:DESKew value`` command. - - **SCPI Syntax:** - - :: - - - REF:REF:DESKew - - **Info:** - - ```` is the deskew value used for the specified reference. - """ - return self._deskew - - @property - def label(self) -> RefRefItemLabel: - """Return the ``REF:REF:LABel`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF:LABel?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF:LABel?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.color``: The ``REF:REF:LABel:COLor`` command. - - ``.font``: The ``REF:REF:LABel:FONT`` command tree. - - ``.name``: The ``REF:REF:LABel:NAMe`` command. - - ``.xpos``: The ``REF:REF:LABel:XPOS`` command. - - ``.ypos``: The ``REF:REF:LABel:YPOS`` command. - """ - return self._label - - @property - def source(self) -> RefRefItemSource: - """Return the ``REF:REF:SOUrce`` command. - - **Description:** - - This command sets or queries the filename used by the given reference. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:REF:SOUrce value`` command. - - **SCPI Syntax:** - - :: - - - REF:REF:SOUrce - - **Info:** - - ```` is the reference file name. - """ - return self._source - - -class RefList(SCPICmdRead): - """The ``REF:LIST`` command. - - **Description:** - - This command returns a comma separated list of all currently defined references. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:LIST?`` query. - - Using the ``.verify(value)`` method will send the ``REF:LIST?`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - REF:LIST? - """ - - -class RefDelete(SCPICmdWrite): - """The ``REF:DELete`` command. - - **Description:** - - Deletes the specified reference. Argument is of the form 'REF', where NR1 ≥ 1. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:DELete value`` command. - - **SCPI Syntax:** - - :: - - - REF:DELete - - **Info:** - - ```` is the specified reference. Argument is of the form 'REF', where NR1 ≥ - 1. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class RefAddnew(SCPICmdWrite): - """The ``REF:ADDNew`` command. - - **Description:** - - This command adds the specified reference. Argument is of the form 'REF ', where NR1 - ≥ 1. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:ADDNew value`` command. - - **SCPI Syntax:** - - :: - - - REF:ADDNew - - **Info:** - - ```` is the specified reference. Argument is of the form 'REF ', where NR1 ≥ - 1. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class Ref(SCPICmdRead): - """The ``REF`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``REF?`` query. - - Using the ``.verify(value)`` method will send the ``REF?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.addnew``: The ``REF:ADDNew`` command. - - ``.delete``: The ``REF:DELete`` command. - - ``.list``: The ``REF:LIST`` command. - - ``.ref``: The ``REF:REF`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "REF") -> None: - super().__init__(device, cmd_syntax) - self._addnew = RefAddnew(device, f"{self._cmd_syntax}:ADDNew") - self._delete = RefDelete(device, f"{self._cmd_syntax}:DELete") - self._list = RefList(device, f"{self._cmd_syntax}:LIST") - self._ref: Dict[int, RefRefItem] = DefaultDictPassKeyToFactory( - lambda x: RefRefItem(device, f"{self._cmd_syntax}:REF{x}") - ) - - @property - def addnew(self) -> RefAddnew: - """Return the ``REF:ADDNew`` command. - - **Description:** - - This command adds the specified reference. Argument is of the form 'REF ', where - NR1 ≥ 1. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:ADDNew value`` command. - - **SCPI Syntax:** - - :: - - - REF:ADDNew - - **Info:** - - ```` is the specified reference. Argument is of the form 'REF ', where - NR1 ≥ 1. - """ - return self._addnew - - @property - def delete(self) -> RefDelete: - """Return the ``REF:DELete`` command. - - **Description:** - - Deletes the specified reference. Argument is of the form 'REF', where NR1 ≥ 1. - - **Usage:** - - Using the ``.write(value)`` method will send the ``REF:DELete value`` command. - - **SCPI Syntax:** - - :: - - - REF:DELete - - **Info:** - - ```` is the specified reference. Argument is of the form 'REF', where - NR1 ≥ 1. - """ - return self._delete - - @property - def list(self) -> RefList: - """Return the ``REF:LIST`` command. - - **Description:** - - This command returns a comma separated list of all currently defined references. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:LIST?`` query. - - Using the ``.verify(value)`` method will send the ``REF:LIST?`` query and raise an - AssertionError if the returned value does not match ``value``. - - **SCPI Syntax:** - - :: - - - REF:LIST? - """ - return self._list - - @property - def ref(self) -> Dict[int, RefRefItem]: - """Return the ``REF:REF`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``REF:REF?`` query. - - Using the ``.verify(value)`` method will send the ``REF:REF?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.deskew``: The ``REF:REF:DESKew`` command. - - ``.label``: The ``REF:REF:LABel`` command tree. - - ``.source``: The ``REF:REF:SOUrce`` command. - """ - return self._ref diff --git a/tests/test_docs.py b/tests/test_docs.py index 9e5a29a5..e3f8de70 100644 --- a/tests/test_docs.py +++ b/tests/test_docs.py @@ -41,7 +41,6 @@ def test_docs_html(self) -> None: """Test creating html documentation.""" subprocess.check_call(shlex.split("make html")) # noqa: S603 - @pytest.mark.xfail(reason="package is not yet on pypi.org") @pytest.mark.order(2) def test_docs_linkcheck(self) -> None: """Run the linkcheck test for the documentation."""