Skip to content

Commit 08d1e0a

Browse files
vnktshr21vnktshr21
committed
addressed few review comments
1 parent 030e1c6 commit 08d1e0a

File tree

10 files changed

+404
-446
lines changed

10 files changed

+404
-446
lines changed

‎docs/nirfsg/class.rst‎

Lines changed: 199 additions & 205 deletions
Large diffs are not rendered by default.

‎docs/nirfsg/enums.rst‎

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -321,12 +321,12 @@ AutomaticThermalCorrection
321321

322322

323323

324-
DeembeddingTypeAttrVals
325-
-----------------------
324+
DeembeddingType
325+
---------------
326326

327-
.. py:class:: DeembeddingTypeAttrVals
327+
.. py:class:: DeembeddingType
328328
329-
.. py:attribute:: DeembeddingTypeAttrVals.NONE
329+
.. py:attribute:: DeembeddingType.NONE
330330
331331
332332
@@ -336,7 +336,7 @@ DeembeddingTypeAttrVals
336336

337337

338338

339-
.. py:attribute:: DeembeddingTypeAttrVals.SCALAR
339+
.. py:attribute:: DeembeddingType.SCALAR
340340
341341
342342
@@ -346,7 +346,7 @@ DeembeddingTypeAttrVals
346346

347347

348348

349-
.. py:attribute:: DeembeddingTypeAttrVals.VECTOR
349+
.. py:attribute:: DeembeddingType.VECTOR
350350
351351
352352
@@ -1851,16 +1851,6 @@ StartTriggerType
18511851

18521852

18531853

1854-
.. py:attribute:: StartTriggerType.P2P_ENDPOINT_FULLNESS
1855-
1856-
1857-
1858-
The data operation does not start until the endpoint reaches the threshold specified in the :py:attr:`nirfsg.Session.P2P_ENDPOINT_FULLNESS_START_TRIGGER_LEVEL` property.
1859-
1860-
1861-
1862-
1863-
18641854
UpconverterFrequencyOffsetMode
18651855
------------------------------
18661856

‎docs/nirfsg/rep_caps.rst‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,17 @@ script_triggers
7575
passes a string of :python:`'scripttrigger0, scripttrigger1, scripttrigger2'` to the set attribute function.
7676

7777

78-
waveform
79-
--------
78+
waveforms
79+
---------
8080

81-
.. py:attribute:: nirfsg.Session.waveform[]
81+
.. py:attribute:: nirfsg.Session.waveforms[]
8282
8383
If no prefix is added to the items in the parameter, the correct prefix will be added when
8484
the driver function call is made.
8585

8686
.. code:: python
8787
88-
session.waveform['0-2'].channel_enabled = True
88+
session.waveforms['0-2'].channel_enabled = True
8989
9090
passes a string of :python:`'waveform::0, waveform::1, waveform::2'` to the set attribute function.
9191

@@ -96,34 +96,34 @@ waveform
9696

9797
.. code:: python
9898
99-
session.waveform['waveform::0-waveform::2'].channel_enabled = True
99+
session.waveforms['waveform::0-waveform::2'].channel_enabled = True
100100
101101
passes a string of :python:`'waveform::0, waveform::1, waveform::2'` to the set attribute function.
102102

103103

104-
port
105-
----
104+
ports
105+
-----
106106

107-
.. py:attribute:: nirfsg.Session.port[]
107+
.. py:attribute:: nirfsg.Session.ports[]
108108
109109
.. code:: python
110110
111-
session.port['0-2'].channel_enabled = True
111+
session.ports['0-2'].channel_enabled = True
112112
113113
passes a string of :python:`'0, 1, 2'` to the set attribute function.
114114

115115

116-
lo
117-
--
116+
lo_channels
117+
-----------
118118

119-
.. py:attribute:: nirfsg.Session.lo[]
119+
.. py:attribute:: nirfsg.Session.lo_channels[]
120120
121121
If no prefix is added to the items in the parameter, the correct prefix will be added when
122122
the driver function call is made.
123123

124124
.. code:: python
125125
126-
session.lo['0-2'].channel_enabled = True
126+
session.lo_channels['0-2'].channel_enabled = True
127127
128128
passes a string of :python:`'LO0, LO1, LO2'` to the set attribute function.
129129

@@ -134,7 +134,7 @@ lo
134134

135135
.. code:: python
136136
137-
session.lo['LO0-LO2'].channel_enabled = True
137+
session.lo_channels['LO0-LO2'].channel_enabled = True
138138
139139
passes a string of :python:`'LO0, LO1, LO2'` to the set attribute function.
140140

‎generated/nirfsg/nirfsg/enums.py‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ class AutomaticThermalCorrection(Enum):
142142
'''
143143

144144

145-
class DeembeddingTypeAttrVals(Enum):
145+
class DeembeddingType(Enum):
146146
NONE = 25000
147147
r'''
148148
De-embedding is not applied to the measurement.
@@ -798,10 +798,6 @@ class StartTriggerType(Enum):
798798
r'''
799799
The data operation does not start until a software event occurs. You may create a software trigger by calling the send_software_edge_trigger method.
800800
'''
801-
P2P_ENDPOINT_FULLNESS = 3
802-
r'''
803-
The data operation does not start until the endpoint reaches the threshold specified in the P2P_ENDPOINT_FULLNESS_START_TRIGGER_LEVEL property.
804-
'''
805801

806802

807803
class UpconverterFrequencyOffsetMode(Enum):

‎generated/nirfsg/nirfsg/session.py‎

Lines changed: 134 additions & 141 deletions
Large diffs are not rendered by default.

‎src/nirfsg/metadata/attributes.py‎

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -740,7 +740,7 @@
740740
'lv_property': 'RF:LO Out Enabled',
741741
'name': 'LO_OUT_ENABLED',
742742
'supported_rep_caps': [
743-
'lo'
743+
'lo_channels'
744744
],
745745
'type': 'ViBoolean'
746746
},
@@ -864,7 +864,7 @@
864864
'lv_property': 'Device Characteristics:Device Temperature (Degrees C)',
865865
'name': 'DEVICE_TEMPERATURE',
866866
'supported_rep_caps': [
867-
'port'
867+
'ports'
868868
],
869869
'type': 'ViReal64'
870870
},
@@ -1259,7 +1259,7 @@
12591259
'lv_property': 'RF:Loop Bandwidth',
12601260
'name': 'LOOP_BANDWIDTH',
12611261
'supported_rep_caps': [
1262-
'lo'
1262+
'lo_channels'
12631263
],
12641264
'type': 'ViInt32'
12651265
},
@@ -2233,7 +2233,7 @@
22332233
'lv_property': 'RF:LO Out Power (dBm)',
22342234
'name': 'LO_OUT_POWER',
22352235
'supported_rep_caps': [
2236-
'lo'
2236+
'lo_channels'
22372237
],
22382238
'type': 'ViReal64'
22392239
},
@@ -2247,7 +2247,7 @@
22472247
'lv_property': 'RF:LO In Power (dBm)',
22482248
'name': 'LO_IN_POWER',
22492249
'supported_rep_caps': [
2250-
'lo'
2250+
'lo_channels'
22512251
],
22522252
'type': 'ViReal64'
22532253
},
@@ -2855,7 +2855,7 @@
28552855
'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Terminal Configuration',
28562856
'name': 'IQ_OUT_PORT_TERMINAL_CONFIGURATION',
28572857
'supported_rep_caps': [
2858-
'port'
2858+
'ports'
28592859
],
28602860
'type': 'ViInt32'
28612861
},
@@ -2869,7 +2869,7 @@
28692869
'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Level',
28702870
'name': 'IQ_OUT_PORT_LEVEL',
28712871
'supported_rep_caps': [
2872-
'port'
2872+
'ports'
28732873
],
28742874
'type': 'ViReal64'
28752875
},
@@ -2883,7 +2883,7 @@
28832883
'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Common Mode Offset',
28842884
'name': 'IQ_OUT_PORT_COMMON_MODE_OFFSET',
28852885
'supported_rep_caps': [
2886-
'port'
2886+
'ports'
28872887
],
28882888
'type': 'ViReal64'
28892889
},
@@ -2897,7 +2897,7 @@
28972897
'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Offset',
28982898
'name': 'IQ_OUT_PORT_OFFSET',
28992899
'supported_rep_caps': [
2900-
'port'
2900+
'ports'
29012901
],
29022902
'type': 'ViReal64'
29032903
},
@@ -2937,7 +2937,7 @@
29372937
'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:LO Source',
29382938
'name': 'LO_SOURCE',
29392939
'supported_rep_caps': [
2940-
'lo'
2940+
'lo_channels'
29412941
],
29422942
'type': 'ViString'
29432943
},
@@ -3017,7 +3017,7 @@
30173017
'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:LO PLL Fractional Mode Enabled',
30183018
'name': 'LO_PLL_FRACTIONAL_MODE_ENABLED',
30193019
'supported_rep_caps': [
3020-
'lo'
3020+
'lo_channels'
30213021
],
30223022
'type': 'ViInt32'
30233023
},
@@ -3181,7 +3181,7 @@
31813181
'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Load Impedance',
31823182
'name': 'IQ_OUT_PORT_LOAD_IMPEDANCE',
31833183
'supported_rep_caps': [
3184-
'port'
3184+
'ports'
31853185
],
31863186
'type': 'ViReal64'
31873187
},
@@ -3531,7 +3531,7 @@
35313531
'lv_property': 'RF:LO Frequency (Hz)',
35323532
'name': 'LO_FREQUENCY',
35333533
'supported_rep_caps': [
3534-
'lo'
3534+
'lo_channels'
35353535
],
35363536
'type': 'ViReal64'
35373537
},
@@ -3912,11 +3912,11 @@
39123912
'Description'
39133913
]
39143914
},
3915-
'enum': 'DeembeddingTypeAttrVals',
3915+
'enum': 'DeembeddingType',
39163916
'lv_property': 'De-embedding:Type',
39173917
'name': 'DEEMBEDDING_TYPE',
39183918
'supported_rep_caps': [
3919-
'port'
3919+
'ports'
39203920
],
39213921
'type': 'ViInt32'
39223922
},
@@ -3929,7 +3929,7 @@
39293929
'lv_property': 'De-embedding:Selected Table',
39303930
'name': 'DEEMBEDDING_SELECTED_TABLE',
39313931
'supported_rep_caps': [
3932-
'port'
3932+
'ports'
39333933
],
39343934
'type': 'ViString'
39353935
},
@@ -3962,7 +3962,7 @@
39623962
'lv_property': 'Arb:Waveform Attributes:Waveform IQ Rate (S/s)',
39633963
'name': 'WAVEFORM_IQ_RATE',
39643964
'supported_rep_caps': [
3965-
'waveform'
3965+
'waveforms'
39663966
],
39673967
'type': 'ViReal64'
39683968
},
@@ -3975,7 +3975,7 @@
39753975
'lv_property': 'Arb:Waveform Attributes:Waveform Signal Bandwidth (Hz)',
39763976
'name': 'WAVEFORM_SIGNAL_BANDWIDTH',
39773977
'supported_rep_caps': [
3978-
'waveform'
3978+
'waveforms'
39793979
],
39803980
'type': 'ViReal64'
39813981
},
@@ -3988,7 +3988,7 @@
39883988
'lv_property': 'Arb:Waveform Attributes:Waveform Runtime Scaling',
39893989
'name': 'WAVEFORM_RUNTIME_SCALING',
39903990
'supported_rep_caps': [
3991-
'waveform'
3991+
'waveforms'
39923992
],
39933993
'type': 'ViReal64'
39943994
},
@@ -4001,7 +4001,7 @@
40014001
'lv_property': 'Arb:Waveform Attributes:Waveform PAPR (dB)',
40024002
'name': 'WAVEFORM_PAPR',
40034003
'supported_rep_caps': [
4004-
'waveform'
4004+
'waveforms'
40054005
],
40064006
'type': 'ViReal64'
40074007
},
@@ -4114,7 +4114,7 @@
41144114
'lv_property': 'Arb:Waveform Attributes:Waveform RF Blanking',
41154115
'name': 'WAVEFORM_RF_BLANKING',
41164116
'supported_rep_caps': [
4117-
'waveform'
4117+
'waveforms'
41184118
],
41194119
'type': 'ViInt32'
41204120
},
@@ -4127,7 +4127,7 @@
41274127
'lv_property': 'De-embedding:Compensation Gain',
41284128
'name': 'DEEMBEDDING_COMPENSATION_GAIN',
41294129
'supported_rep_caps': [
4130-
'port'
4130+
'ports'
41314131
],
41324132
'type': 'ViReal64'
41334133
},
@@ -4257,7 +4257,7 @@
42574257
'lv_property': 'Arb:Waveform Attributes:Waveform Size',
42584258
'name': 'WAVEFORM_WAVEFORM_SIZE',
42594259
'supported_rep_caps': [
4260-
'waveform'
4260+
'waveforms'
42614261
],
42624262
'type': 'ViInt32'
42634263
},
@@ -4696,10 +4696,6 @@
46964696
[
46974697
'NIRFSG_VAL_SOFTWARE',
46984698
'The data operation does not start until a software event occurs. You may create a software trigger by calling the niRFSG_SendSoftwareEdgeTrigger function.'
4699-
],
4700-
[
4701-
'NIRFSG_VAL_P2P_ENDPOINT_FULLNESS',
4702-
'The data operation does not start until the endpoint reaches the threshold specified in the NIRFSG_ATTR_P2P_ENDPOINT_FULLNESS_START_TRIGGER_LEVEL attribute.'
47034699
]
47044700
],
47054701
'table_header': [

‎src/nirfsg/metadata/config.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,15 @@
5050
},
5151
{
5252
'prefix': 'waveform::',
53-
'python_name': 'waveform'
53+
'python_name': 'waveforms'
5454
},
5555
{
5656
'prefix': '',
57-
'python_name': 'port'
57+
'python_name': 'ports'
5858
},
5959
{
6060
'prefix': 'LO',
61-
'python_name': 'lo'
61+
'python_name': 'lo_channels'
6262
}
6363
],
6464
'session_class_description': 'An NI-RFSG session to the NI-RFSG driver',

0 commit comments

Comments
 (0)