Skip to content

nirfsa enum and template fixes #2236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vnktshr21 merged 2 commits into from
Oct 23, 2026
Merged

nirfsa enum and template fixes #2236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f34566
template whitespace chaange
mohit-emerson Oct 23, 2026
890529f
metadata change
mohit-emerson Oct 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 10 additions & 14 deletions docs/nirfsa/class.rst
View file
Open in desktop

Large diffs are not rendered by default.

52 changes: 21 additions & 31 deletions docs/nirfsa/enums.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ DigitizerSampleClockExportedTerminal

.. py:class:: DigitizerSampleClockExportedTerminal

.. py:attribute:: DigitizerSampleClockExportedTerminal.NONE
.. py:attribute:: DigitizerSampleClockExportedTerminal.NONE_STR



Expand Down Expand Up @@ -631,61 +631,61 @@ DownconverterLoopBandwidth



DownconverterPreselectorEnabled
-------------------------------
EnableAttrVals
--------------

.. py:class:: DownconverterPreselectorEnabled
.. py:class:: EnableAttrVals

.. py:attribute:: DownconverterPreselectorEnabled.DISABLED
.. py:attribute:: EnableAttrVals.DISABLED



Disables the preselector.
The property is disabled.





.. py:attribute:: DownconverterPreselectorEnabled.ENABLED_WHEN_IN_SIGNAL_PATH
.. py:attribute:: EnableAttrVals.ENABLED



The preselector is automatically enabled when it is in the signal path and is automatically disabled when it is not in the signal path. Use the :py:attr:`nirfsa.Session.preselector_present` property to determine if the downconverter has an preselector.
The property is enabled.





.. py:attribute:: DownconverterPreselectorEnabled.ENABLED
DownconverterPreselectorEnabled
-------------------------------

.. py:class:: DownconverterPreselectorEnabled

.. py:attribute:: DownconverterPreselectorEnabled.DISABLED

Enables the preselector. If the preselector is not in the signal path or if the preselector is not supported on the device, NI-RFSA returns an error. Select the :py:data:`~nirfsa.DownconverterPreselectorEnabled.ENABLED_WHEN_IN_SIGNAL_PATH` whenever possible avoid an error.



Disables the preselector.



EnableAttrVals
--------------

.. py:class:: EnableAttrVals

.. py:attribute:: EnableAttrVals.DISABLED
.. py:attribute:: DownconverterPreselectorEnabled.ENABLED_WHEN_IN_SIGNAL_PATH



The property is disabled.
The preselector is automatically enabled when it is in the signal path and is automatically disabled when it is not in the signal path. Use the :py:attr:`nirfsa.Session.preselector_present` property to determine if the downconverter has an preselector.





.. py:attribute:: EnableAttrVals.ENABLED
.. py:attribute:: DownconverterPreselectorEnabled.ENABLED



The property is enabled.
Enables the preselector. If the preselector is not in the signal path or if the preselector is not supported on the device, NI-RFSA returns an error. Select the :py:data:`~nirfsa.DownconverterPreselectorEnabled.ENABLED_WHEN_IN_SIGNAL_PATH` whenever possible avoid an error.



Expand Down Expand Up @@ -1576,16 +1576,6 @@ LoSource

.. py:class:: LoSource

.. py:attribute:: LoSource.NONE



Specifies that no LO source is required to downconvert the RF input signal.





.. py:attribute:: LoSource.ONBOARD


Expand Down Expand Up @@ -2086,7 +2076,7 @@ PxiChassisClk10Source

.. py:class:: PxiChassisClk10Source

.. py:attribute:: PxiChassisClk10Source.NONE
.. py:attribute:: PxiChassisClk10Source.NONE_STR



Expand Down Expand Up @@ -2156,7 +2146,7 @@ ReferenceClockExportedTerminal

.. py:class:: ReferenceClockExportedTerminal

.. py:attribute:: ReferenceClockExportedTerminal.NONE
.. py:attribute:: ReferenceClockExportedTerminal.NONE_STR



Expand Down Expand Up @@ -2211,7 +2201,7 @@ ReferenceClockSource

.. py:class:: ReferenceClockSource

.. py:attribute:: ReferenceClockSource.NONE
.. py:attribute:: ReferenceClockSource.NONE_STR



Expand Down
58 changes: 27 additions & 31 deletions generated/nirfsa/nirfsa/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ class DigitizerDitherEnabled(Enum):


class DigitizerSampleClockExportedTerminal(Enum):
NONE = 'None'
NONE_STR = 'None'
r'''
The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646.
'''
Expand Down Expand Up @@ -272,6 +272,17 @@ class DownconverterLoopBandwidth(Enum):
'''


class EnableAttrVals(Enum):
DISABLED = 1900
r'''
The property is disabled.
'''
ENABLED = 1901
r'''
The property is enabled.
'''


class DownconverterPreselectorEnabled(Enum):
DISABLED = 2600
r'''
Expand All @@ -287,17 +298,6 @@ class DownconverterPreselectorEnabled(Enum):
'''


class EnableAttrVals(Enum):
DISABLED = 1900
r'''
The property is disabled.
'''
ENABLED = 1901
r'''
The property is enabled.
'''


class EnableRfPreamp(Enum):
DISABLED = 2500
r'''
Expand Down Expand Up @@ -669,10 +669,6 @@ class LoPllFractionalModeEnabled(Enum):


class LoSource(Enum):
NONE = 'None'
r'''
Specifies that no LO source is required to downconvert the RF input signal.
'''
ONBOARD = 'Onboard'
r'''
Specifies that the onboard synthesizer is used to generate the LO signal that downconverts the RF input signal.**PXIe-5831/5832** This configuration uses the onboard LO of the PXIe-3622, using the LO2 stage.**PXIe-5831/5832 with PXIe-5653** This configuration uses the onboard LO of the PXIe-5653 when associated with the PXIe-3622.**PXIe-5841 with PXIe-5655** This configuration uses the onboard LO of the PXIe-5655.
Expand Down Expand Up @@ -881,7 +877,7 @@ class PowerSpectrumUnits(Enum):


class PxiChassisClk10Source(Enum):
NONE = 'None'
NONE_STR = 'None'
r'''
The device does not drive the PXI 10 MHz backplane Reference Clock.
'''
Expand Down Expand Up @@ -911,7 +907,7 @@ class ReferenceClockExportedRate(Enum):


class ReferenceClockExportedTerminal(Enum):
NONE = 'None'
NONE_STR = 'None'
r'''
The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646.
'''
Expand All @@ -934,7 +930,7 @@ class ReferenceClockExportedTerminal(Enum):


class ReferenceClockSource(Enum):
NONE = 'None'
NONE_STR = 'None'
r'''
No Reference Clock is required for the current device configuration. This value is valid only for the PXIe-5694 or the PXIe-5668.
'''
Expand Down Expand Up @@ -1112,27 +1108,27 @@ class SelfCalSteps(IntFlag):
r'''
Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.
'''
LO_SELF_CAL = 10
LO_SELF_CAL = 16
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
AMPLITUDE_ACCURACY = 20
AMPLITUDE_ACCURACY = 32
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
RESIDUAL_LO_POWER = 40
RESIDUAL_LO_POWER = 64
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
IMAGE_SUPPRESSION = 80
IMAGE_SUPPRESSION = 128
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
SYNTHESIZER_ALIGNMENT = 100
SYNTHESIZER_ALIGNMENT = 256
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
DC_OFFSET = 200
DC_OFFSET = 512
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
Expand All @@ -1159,27 +1155,27 @@ class SelfCalibrateRangeStepsToOmit(IntFlag):
r'''
Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.
'''
LO_SELF_CAL = 10
LO_SELF_CAL = 16
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
AMPLITUDE_ACCURACY = 20
AMPLITUDE_ACCURACY = 32
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
RESIDUAL_LO_POWER = 40
RESIDUAL_LO_POWER = 64
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
IMAGE_SUPPRESSION = 80
IMAGE_SUPPRESSION = 128
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
SYNTHESIZER_ALIGNMENT = 100
SYNTHESIZER_ALIGNMENT = 256
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
DC_OFFSET = 200
DC_OFFSET = 512
r'''
Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.
'''
Expand Down
Loading
Loading