Skip to content
3,678 changes: 1,824 additions & 1,854 deletions docs/nirfsg/class.rst

Large diffs are not rendered by default.

141 changes: 76 additions & 65 deletions docs/nirfsg/enums.rst
Original file line number Diff line number Diff line change
Expand Up @@ -848,6 +848,51 @@ LoPlLfractionalModeEnabled



LoadConfigurationResetOptions
-----------------------------

.. py:class:: LoadConfigurationResetOptions

.. py:attribute:: LoadConfigurationResetOptions.WAVEFORMS



NI-RFSG skips resetting the waveform configurations.





.. py:attribute:: LoadConfigurationResetOptions.DEEMBEDDING_TABLES



NI-RFSG skips resetting the de-embedding tables.





.. py:attribute:: LoadConfigurationResetOptions.SCRIPTS



NI-RFSG skips resetting the scripts.





.. py:attribute:: LoadConfigurationResetOptions.NONE



NI-RFSG resets all configurations.





LoadOptions
-----------

Expand Down Expand Up @@ -1363,10 +1408,6 @@ RFInLoExportEnabled



.. py:attribute:: RFInLoExportEnabled.MANUAL



.. py:attribute:: RFInLoExportEnabled.ENABLE


Expand All @@ -1377,61 +1418,47 @@ RFInLoExportEnabled



.. py:attribute:: RFInLoExportEnabled.SCRIPT_TRIGGER


RefPllBandwidth
---------------

ReferenceClockExportedRate
--------------------------
.. py:class:: RefPllBandwidth

.. py:class:: ReferenceClockExportedRate

.. py:attribute:: ReferenceClockExportedRate._10mhz
.. py:attribute:: RefPllBandwidth.NARROW



Uses a 10MHz Reference Clock rate.
Uses the narrowest loop bandwidth setting for the PLL. Setting this property to :py:data:`~nirfsg.NIRFSG_VAL_NARROW` allows the PXIe-5653 to lock to a reference with worse phase noise than the PXIe-5653 and utilize the better phase noise of the PXIe-5653.





.. py:attribute:: ReferenceClockExportedRate._100mhz
.. py:attribute:: RefPllBandwidth.MEDIUM



Uses a 100MHz Reference Clock rate.
Uses the medium loop bandwidth setting for the PLL.





.. py:attribute:: ReferenceClockExportedRate._1ghz
.. py:attribute:: RefPllBandwidth.WIDE



Uses a 1GHz Reference Clock rate.
Uses the widest loop bandwidth setting for the PLL. Setting this property to :py:data:`~nirfsg.NIRFSG_VAL_WIDE` on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference.





ReferenceClockRate
------------------

.. py:class:: ReferenceClockRate

.. py:attribute:: ReferenceClockRate.AUTO



Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it.



ReferenceClockExportedRate
--------------------------

.. py:class:: ReferenceClockExportedRate

.. py:attribute:: ReferenceClockRate._10mhz
.. py:attribute:: ReferenceClockExportedRate._10mhz



Expand All @@ -1441,92 +1468,76 @@ ReferenceClockRate



RelativeTo
----------

.. py:class:: RelativeTo

.. py:attribute:: RelativeTo.CURRENT_POSITION
.. py:attribute:: ReferenceClockExportedRate._100mhz



The reference position is relative to the current position.
Uses a 100MHz Reference Clock rate.





.. py:attribute:: RelativeTo.START_OF_WAVEFORM
.. py:attribute:: ReferenceClockExportedRate._1ghz



The reference position is relative to the start of the waveform.
Uses a 1GHz Reference Clock rate.





ResetOptions
------------
ReferenceClockRate
------------------

.. py:class:: ResetOptions
.. py:class:: ReferenceClockRate

.. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS
.. py:attribute:: ReferenceClockRate.AUTO



NI-RFSG skips resetting the waveform configurations.
Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it.





.. py:attribute:: ResetOptions.MANUAL



.. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES
.. py:attribute:: ReferenceClockRate._10mhz



NI-RFSG skips resetting the de-embedding tables.
Uses a 10MHz Reference Clock rate.





.. py:attribute:: ResetOptions.SCRIPT_TRIGGER

RelativeTo
----------

.. py:class:: RelativeTo

.. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS
.. py:attribute:: RelativeTo.CURRENT_POSITION



NI-RFSG skips resetting the scripts.
The reference position is relative to the current position.





.. py:attribute:: ResetOptions.MARKER_EVENT



.. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE
.. py:attribute:: RelativeTo.START_OF_WAVEFORM



NI-RFSG resets all configurations.
The reference position is relative to the start of the waveform.





.. py:attribute:: ResetOptions.SELF_CAL_IMAGE_SUPPRESSION



ResetWithOptionsStepsToOmit
---------------------------

Expand Down
59 changes: 34 additions & 25 deletions generated/nirfsg/nirfsg/enums.py
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,25 @@ class LoPlLfractionalModeEnabled(Enum):
SCRIPT_TRIGGER = 1


class LoadConfigurationResetOptions(Enum):
WAVEFORMS = 1
r'''
NI-RFSG skips resetting the waveform configurations.
'''
DEEMBEDDING_TABLES = 8
r'''
NI-RFSG skips resetting the de-embedding tables.
'''
SCRIPTS = 2
r'''
NI-RFSG skips resetting the scripts.
'''
NONE = 0
r'''
NI-RFSG resets all configurations.
'''


class LoadOptions(Enum):
NONE = 0
r'''
Expand Down Expand Up @@ -585,12 +604,25 @@ class RFInLoExportEnabled(Enum):
r'''
The RF In local oscillator signal is not present at the front panel LO OUT connector.
'''
MANUAL = 0
ENABLE = 1
r'''
The RF In local oscillator signal is present at the front panel LO OUT connector.
'''
SCRIPT_TRIGGER = 1


class RefPllBandwidth(Enum):
NARROW = 0
r'''
Uses the narrowest loop bandwidth setting for the PLL. Setting this property to NIRFSG_VAL_NARROW allows the PXIe-5653 to lock to a reference with worse phase noise than the PXIe-5653 and utilize the better phase noise of the PXIe-5653.
'''
MEDIUM = 1
r'''
Uses the medium loop bandwidth setting for the PLL.
'''
WIDE = 2
r'''
Uses the widest loop bandwidth setting for the PLL. Setting this property to NIRFSG_VAL_WIDE on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference.
'''


class ReferenceClockExportedRate(Enum):
Expand Down Expand Up @@ -630,29 +662,6 @@ class RelativeTo(Enum):
'''


class ResetOptions(Enum):
RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS = 1
r'''
NI-RFSG skips resetting the waveform configurations.
'''
MANUAL = 0
RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES = 8
r'''
NI-RFSG skips resetting the de-embedding tables.
'''
SCRIPT_TRIGGER = 1
RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS = 2
r'''
NI-RFSG skips resetting the scripts.
'''
MARKER_EVENT = 2
RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE = 0
r'''
NI-RFSG resets all configurations.
'''
SELF_CAL_IMAGE_SUPPRESSION = 8


class ResetWithOptionsStepsToOmit(Enum):
DEEMBEDDING_TABLES = 8
r'''
Expand Down
Loading