Skip to content

Commit 7b2177d

Browse files
vnktshr21vnktshr21
committed
disabled few enums and corrected units in few
1 parent 08d1e0a commit 7b2177d

File tree

6 files changed

+44
-345
lines changed

6 files changed

+44
-345
lines changed

‎docs/nirfsg/class.rst‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3572,7 +3572,7 @@ analog_modulation_fm_narrowband_integrator
35723572

35733573
This property is valid only when you set the :py:attr:`nirfsg.Session.analog_modulation_type` property to :py:data:`~nirfsg.AnalogModulationType.FM` and the :py:attr:`nirfsg.Session.analog_modulation_fm_band` property to :py:data:`~nirfsg.AnalogModulationFmBand.NARROWBAND`.
35743574

3575-
**Default Value:** :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._100hzto1khz`
3575+
**Default Value:** :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._100Hzto1kHz`
35763576

35773577
**Supported Devices:** PXIe-5654/5654 with PXIe-5696
35783578

@@ -3585,11 +3585,11 @@ analog_modulation_fm_narrowband_integrator
35853585
+--------------------------------------------------------------------------+----------------+---------------------------------------------+
35863586
| Name | Value | Description |
35873587
+==========================================================================+================+=============================================+
3588-
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._100hzto1khz` | 18000 (0x4650) | Specifies a range from 100Â Hz to 1Â kHz. |
3588+
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._100Hzto1kHz` | 18000 (0x4650) | Specifies a range from 100Â Hz to 1Â kHz. |
35893589
+--------------------------------------------------------------------------+----------------+---------------------------------------------+
3590-
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._10khzto100khz` | 18002 (0x4652) | Specifies a range from 10Â kHz to 100Â kHz. |
3590+
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._10kHzto100kHz` | 18002 (0x4652) | Specifies a range from 10Â kHz to 100Â kHz. |
35913591
+--------------------------------------------------------------------------+----------------+---------------------------------------------+
3592-
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._1khzto10khz` | 18001 (0x4651) | Specifies a range from 1Â kHz to 10Â kHz. |
3592+
| :py:data:`~nirfsg.AnalogModulationFmNarrowbandIntegrator._1kHzto10kHz` | 18001 (0x4651) | Specifies a range from 1Â kHz to 10Â kHz. |
35933593
+--------------------------------------------------------------------------+----------------+---------------------------------------------+
35943594

35953595
The following table lists the characteristics of this property.
@@ -6768,7 +6768,7 @@ exported_ref_clock_rate
67686768

67696769
Specifies the Reference Clock Rate, in Hz, of the signal sent to the Reference Clock Export Output Terminal. To set this property, the NI-RFSG device must be in the Configuration state.
67706770

6771-
**Default Value:** :py:data:`~nirfsg.ReferenceClockExportedRate._10mhz`
6771+
**Default Value:** :py:data:`~nirfsg.ReferenceClockExportedRate._10MHz`
67726772

67736773
**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860
67746774

@@ -6777,11 +6777,11 @@ exported_ref_clock_rate
67776777
+-------------------------------------------------------+--------------+-------------------------------------+
67786778
| Name | Value | Description |
67796779
+=======================================================+==============+=====================================+
6780-
| :py:data:`~nirfsg.ReferenceClockExportedRate._10mhz` | 10000000.0 | Uses a 10MHz Reference Clock rate. |
6780+
| :py:data:`~nirfsg.ReferenceClockExportedRate._10MHz` | 10000000.0 | Uses a 10MHz Reference Clock rate. |
67816781
+-------------------------------------------------------+--------------+-------------------------------------+
6782-
| :py:data:`~nirfsg.ReferenceClockExportedRate._100mhz` | 100000000.0 | Uses a 100MHz Reference Clock rate. |
6782+
| :py:data:`~nirfsg.ReferenceClockExportedRate._100MHz` | 100000000.0 | Uses a 100MHz Reference Clock rate. |
67836783
+-------------------------------------------------------+--------------+-------------------------------------+
6784-
| :py:data:`~nirfsg.ReferenceClockExportedRate._1ghz` | 1000000000.0 | Uses a 1GHz Reference Clock rate. |
6784+
| :py:data:`~nirfsg.ReferenceClockExportedRate._1GHz` | 1000000000.0 | Uses a 1GHz Reference Clock rate. |
67856785
+-------------------------------------------------------+--------------+-------------------------------------+
67866786

67876787
.. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
@@ -10434,7 +10434,7 @@ ref_clock_rate
1043410434

1043510435
**Valid Values:**
1043610436

10437-
PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the :py:data:`~nirfsg.ReferenceClockRate.AUTO` and :py:data:`~nirfsg.ReferenceClockRate._10mhz` values.
10437+
PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the :py:data:`~nirfsg.ReferenceClockRate.AUTO` and :py:data:`~nirfsg.ReferenceClockRate._10MHz` values.
1043810438

1043910439
PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz
1044010440

@@ -10465,7 +10465,7 @@ ref_clock_rate
1046510465
+==============================================+===================================================================================================================================+
1046610466
| :py:data:`~nirfsg.ReferenceClockRate.AUTO` | Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. |
1046710467
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
10468-
| :py:data:`~nirfsg.ReferenceClockRate._10mhz` | Uses a 10 MHz Reference Clock rate. |
10468+
| :py:data:`~nirfsg.ReferenceClockRate._10MHz` | Uses a 10 MHz Reference Clock rate. |
1046910469
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
1047010470

1047110471
.. note:: Automatic detection of the Reference Clock rate is supported on only the PXIe-5654/5654 with PXIe-5696. For all other supported devices, NI-RFSG uses the default Reference Clock rate of 10MHz.

‎docs/nirfsg/enums.rst‎

Lines changed: 7 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ AnalogModulationFmNarrowbandIntegrator
8686

8787
.. py:class:: AnalogModulationFmNarrowbandIntegrator
8888
89-
.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._100hzto1khz
89+
.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._100Hzto1kHz
9090
9191
9292
@@ -96,7 +96,7 @@ AnalogModulationFmNarrowbandIntegrator
9696

9797

9898

99-
.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._1khzto10khz
99+
.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._1kHzto10kHz
100100
101101
102102
@@ -106,7 +106,7 @@ AnalogModulationFmNarrowbandIntegrator
106106

107107

108108

109-
.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._10khzto100khz
109+
.. py:attribute:: AnalogModulationFmNarrowbandIntegrator._10kHzto100kHz
110110
111111
112112
@@ -651,56 +651,6 @@ IQOutPortTermCfg
651651

652652

653653

654-
Lo1OutputFilter
655-
---------------
656-
657-
.. py:class:: Lo1OutputFilter
658-
659-
.. py:attribute:: Lo1OutputFilter.HIGH
660-
661-
662-
663-
yet to be defined
664-
665-
666-
667-
668-
669-
.. py:attribute:: Lo1OutputFilter.LOW
670-
671-
672-
673-
yet to be defined
674-
675-
676-
677-
678-
679-
LoOutEnabled
680-
------------
681-
682-
.. py:class:: LoOutEnabled
683-
684-
.. py:attribute:: LoOutEnabled.DISABLE
685-
686-
687-
688-
The local oscillator signal is present at the LO OUT front panel connector.
689-
690-
691-
692-
693-
694-
.. py:attribute:: LoOutEnabled.ENABLE
695-
696-
697-
698-
The local oscillator signal is not present at the LO OUT front panel connector..
699-
700-
701-
702-
703-
704654
LoOutExportConfigureFromRFSaEnable
705655
----------------------------------
706656

@@ -1096,31 +1046,6 @@ PhaseContinuityEnabled
10961046

10971047

10981048

1099-
PortTypes
1100-
---------
1101-
1102-
.. py:class:: PortTypes
1103-
1104-
.. py:attribute:: PortTypes.OUT
1105-
1106-
1107-
1108-
Specifies the PXIe-5840 RF OUT port.
1109-
1110-
1111-
1112-
1113-
1114-
.. py:attribute:: PortTypes.IN
1115-
1116-
1117-
1118-
Specifies the PXIe-5840 RF IN port. This value is not supported as the first element of an array.
1119-
1120-
1121-
1122-
1123-
11241049
PowerLevelType
11251050
--------------
11261051

@@ -1251,41 +1176,6 @@ RFBlanking
12511176

12521177

12531178

1254-
RFFilter
1255-
--------
1256-
1257-
.. py:class:: RFFilter
1258-
1259-
.. py:attribute:: RFFilter.HI_FREQ_MOD
1260-
1261-
1262-
1263-
yet to be defined
1264-
1265-
1266-
1267-
1268-
1269-
.. py:attribute:: RFFilter.LO_FREQ_MOD_4000
1270-
1271-
1272-
1273-
yet to be defined
1274-
1275-
1276-
1277-
1278-
1279-
.. py:attribute:: RFFilter.LO_FREQ_MOD_2500
1280-
1281-
1282-
1283-
yet to be defined
1284-
1285-
1286-
1287-
1288-
12891179
RFInLoExportEnabled
12901180
-------------------
12911181

@@ -1326,7 +1216,7 @@ ReferenceClockExportedRate
13261216

13271217
.. py:class:: ReferenceClockExportedRate
13281218
1329-
.. py:attribute:: ReferenceClockExportedRate._10mhz
1219+
.. py:attribute:: ReferenceClockExportedRate._10MHz
13301220
13311221
13321222
@@ -1336,7 +1226,7 @@ ReferenceClockExportedRate
13361226

13371227

13381228

1339-
.. py:attribute:: ReferenceClockExportedRate._100mhz
1229+
.. py:attribute:: ReferenceClockExportedRate._100MHz
13401230
13411231
13421232
@@ -1346,7 +1236,7 @@ ReferenceClockExportedRate
13461236

13471237

13481238

1349-
.. py:attribute:: ReferenceClockExportedRate._1ghz
1239+
.. py:attribute:: ReferenceClockExportedRate._1GHz
13501240
13511241
13521242
@@ -1371,7 +1261,7 @@ ReferenceClockRate
13711261

13721262

13731263

1374-
.. py:attribute:: ReferenceClockRate._10mhz
1264+
.. py:attribute:: ReferenceClockRate._10MHz
13751265
13761266
13771267

‎generated/nirfsg/nirfsg/enums.py‎

Lines changed: 7 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,15 @@ class AnalogModulationFmBand(Enum):
3939

4040

4141
class AnalogModulationFmNarrowbandIntegrator(Enum):
42-
_100hzto1khz = 18000
42+
_100Hzto1kHz = 18000
4343
r'''
4444
Specifies a range from 100Hz to 1kHz.
4545
'''
46-
_1khzto10khz = 18001
46+
_1kHzto10kHz = 18001
4747
r'''
4848
Specifies a range from 1kHz to 10kHz.
4949
'''
50-
_10khzto100khz = 18002
50+
_10kHzto100kHz = 18002
5151
r'''
5252
Specifies a range from 10kHz to 100kHz.
5353
'''
@@ -284,28 +284,6 @@ class IQOutPortTermCfg(Enum):
284284
'''
285285

286286

287-
class Lo1OutputFilter(Enum):
288-
HIGH = 0
289-
r'''
290-
yet to be defined
291-
'''
292-
LOW = 1
293-
r'''
294-
yet to be defined
295-
'''
296-
297-
298-
class LoOutEnabled(Enum):
299-
DISABLE = 0
300-
r'''
301-
The local oscillator signal is present at the LO OUT front panel connector.
302-
'''
303-
ENABLE = 1
304-
r'''
305-
The local oscillator signal is not present at the LO OUT front panel connector..
306-
'''
307-
308-
309287
class LoOutExportConfigureFromRFSaEnable(Enum):
310288
DISABLE = 0
311289
r'''
@@ -477,17 +455,6 @@ class PhaseContinuityEnabled(Enum):
477455
'''
478456

479457

480-
class PortTypes(Enum):
481-
OUT = 14501
482-
r'''
483-
Specifies the PXIe-5840 RF OUT port.
484-
'''
485-
IN = 14500
486-
r'''
487-
Specifies the PXIe-5840 RF IN port. This value is not supported as the first element of an array.
488-
'''
489-
490-
491458
class PowerLevelType(Enum):
492459
AVERAGE = 7000
493460
r'''
@@ -544,21 +511,6 @@ class RFBlanking(Enum):
544511
'''
545512

546513

547-
class RFFilter(Enum):
548-
HI_FREQ_MOD = '0'
549-
r'''
550-
yet to be defined
551-
'''
552-
LO_FREQ_MOD_4000 = '1'
553-
r'''
554-
yet to be defined
555-
'''
556-
LO_FREQ_MOD_2500 = '2'
557-
r'''
558-
yet to be defined
559-
'''
560-
561-
562514
class RFInLoExportEnabled(Enum):
563515
UNSPECIFIED = -2
564516
r'''
@@ -575,15 +527,15 @@ class RFInLoExportEnabled(Enum):
575527

576528

577529
class ReferenceClockExportedRate(Enum):
578-
_10mhz = 10000000
530+
_10MHz = 10000000
579531
r'''
580532
Uses a 10MHz Reference Clock rate.
581533
'''
582-
_100mhz = 100000000.0
534+
_100MHz = 100000000.0
583535
r'''
584536
Uses a 100MHz Reference Clock rate.
585537
'''
586-
_1ghz = 1000000000.0
538+
_1GHz = 1000000000.0
587539
r'''
588540
Uses a 1GHz Reference Clock rate.
589541
'''
@@ -594,7 +546,7 @@ class ReferenceClockRate(Enum):
594546
r'''
595547
Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it.
596548
'''
597-
_10mhz = 10000000
549+
_10MHz = 10000000
598550
r'''
599551
Uses a 10MHz Reference Clock rate.
600552
'''

0 commit comments

Comments
 (0)