Skip to content

Commit a085081

Browse files
author
Utkarsh Tyagi
committed
function metadata changes
1 parent 7712396 commit a085081

File tree

1 file changed

+33
-10
lines changed

1 file changed

+33
-10
lines changed

‎src/nirfsg/metadata/functions.py‎

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@
166166
'description': 'Pass the ID of an attribute.'
167167
},
168168
'name': 'attribute',
169+
'grpc_name': 'attribute_id',
169170
'type': 'ViAttr',
170171
'use_array': False,
171172
'use_in_python_api': True
@@ -225,6 +226,7 @@
225226
'description': 'Pass the ID of an attribute.'
226227
},
227228
'name': 'attribute',
229+
'grpc_name': 'attribute_id',
228230
'type': 'ViAttr',
229231
'use_array': False,
230232
'use_in_python_api': True
@@ -235,7 +237,6 @@
235237
'description': 'Pass the value that you want to verify as a valid value for the attribute.',
236238
'note': 'Some of the values might not be valid depending on the current settings of the instrument session.'
237239
},
238-
'grpc_enum': 'NiRFSGInt32AttributeValues',
239240
'name': 'value',
240241
'type': 'ViInt32',
241242
'use_array': False,
@@ -285,6 +286,7 @@
285286
'description': 'Pass the ID of an attribute.'
286287
},
287288
'name': 'attribute',
289+
'grpc_name': 'attribute_id',
288290
'type': 'ViAttr',
289291
'use_array': False,
290292
'use_in_python_api': True
@@ -295,7 +297,6 @@
295297
'description': 'Pass the value that you want to verify as a valid value for the attribute.',
296298
'note': 'Some of the values might not be valid depending on the current settings of the instrument session.'
297299
},
298-
'grpc_enum': 'NiRFSGInt64AttributeValues',
299300
'name': 'value',
300301
'type': 'ViInt64',
301302
'use_array': False,
@@ -345,6 +346,7 @@
345346
'description': 'Pass the ID of an attribute.'
346347
},
347348
'name': 'attribute',
349+
'grpc_name': 'attribute_id',
348350
'type': 'ViAttr',
349351
'use_array': False,
350352
'use_in_python_api': True
@@ -355,7 +357,6 @@
355357
'description': 'Pass the value that you want to verify as a valid value for the attribute.',
356358
'note': 'Some of the values might not be valid depending on the current settings of the instrument session.'
357359
},
358-
'grpc_enum': 'NiRFSGReal64AttributeValues',
359360
'name': 'value',
360361
'type': 'ViReal64',
361362
'use_array': False,
@@ -405,6 +406,7 @@
405406
'description': 'Pass the ID of an attribute.'
406407
},
407408
'name': 'attribute',
409+
'grpc_name': 'attribute_id',
408410
'type': 'ViAttr',
409411
'use_array': False,
410412
'use_in_python_api': True
@@ -464,6 +466,7 @@
464466
'description': 'Pass the ID of an attribute.'
465467
},
466468
'name': 'attribute',
469+
'grpc_name': 'attribute_id',
467470
'type': 'ViAttr',
468471
'use_array': False,
469472
'use_in_python_api': True
@@ -474,7 +477,6 @@
474477
'description': 'Pass the value that you want to verify as a valid value for the attribute. The value must be a NULL-terminated string.',
475478
'note': 'Some of the values might not be valid depending on the current settings of the instrument session.'
476479
},
477-
'grpc_mapped_enum': 'NiRFSGStringAttributeValuesMapped',
478480
'name': 'value',
479481
'type': 'ViConstString',
480482
'use_array': False,
@@ -1020,6 +1022,7 @@
10201022
},
10211023
'is_repeated_capability': True,
10221024
'name': 'triggerId',
1025+
# 'grpc_enum': 'DigitalEdgeScriptTriggerIdentifier',
10231026
'repeated_capability_type': 'script_triggers',
10241027
'type': 'ViConstString',
10251028
'use_array': False,
@@ -1031,6 +1034,7 @@
10311034
'description': 'Specifies the source terminal for the digital edge Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_SOURCE attribute to this value.'
10321035
},
10331036
'name': 'source',
1037+
# 'grpc_enum': 'TriggerSource',
10341038
'type': 'ViConstString',
10351039
'use_array': False,
10361040
'use_in_python_api': True
@@ -1041,7 +1045,7 @@
10411045
'description': 'Specifies the active edge for the digital edge Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_EDGE attribute to this value.'
10421046
},
10431047
'enum': 'ScriptTriggerDigitalEdgeEdge',
1044-
'grpc_enum': None,
1048+
'grpc_enum': 'DigitalEdgeEdge',
10451049
'name': 'edge',
10461050
'type': 'ViInt32',
10471051
'use_array': False,
@@ -1083,6 +1087,7 @@
10831087
'description': 'Specifies the source terminal for the digital edge trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute to this value.'
10841088
},
10851089
'name': 'source',
1090+
# 'grpc_enum': 'TriggerSource',
10861091
'type': 'ViConstString',
10871092
'use_array': False,
10881093
'use_in_python_api': True
@@ -1093,7 +1098,7 @@
10931098
'description': 'Specifies the active edge for the Start Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_EDGE attribute to this value.'
10941099
},
10951100
'enum': 'StartTriggerDigitalEdgeEdge',
1096-
'grpc_enum': None,
1101+
'grpc_enum': 'DigitalEdgeEdge',
10971102
'name': 'edge',
10981103
'type': 'ViInt32',
10991104
'use_array': False,
@@ -1135,6 +1140,7 @@
11351140
},
11361141
'is_repeated_capability': True,
11371142
'name': 'triggerId',
1143+
# 'grpc_enum': 'DigitalEdgeScriptTriggerIdentifier',
11381144
'repeated_capability_type': 'script_triggers',
11391145
'type': 'ViConstString',
11401146
'use_array': False,
@@ -1413,6 +1419,7 @@
14131419
},
14141420
'is_repeated_capability': True,
14151421
'name': 'triggerId',
1422+
# 'grpc_enum': 'DigitalEdgeScriptTriggerIdentifier',
14161423
'repeated_capability_type': 'script_triggers',
14171424
'type': 'ViConstString',
14181425
'use_array': False,
@@ -1804,6 +1811,7 @@
18041811
},
18051812
'is_repeated_capability': True,
18061813
'name': 'triggerId',
1814+
# 'grpc_enum': 'DigitalEdgeScriptTriggerIdentifier',
18071815
'repeated_capability_type': 'script_triggers',
18081816
'type': 'ViConstString',
18091817
'use_array': False,
@@ -2268,6 +2276,7 @@
22682276
'description': 'Pass the ID of an attribute.'
22692277
},
22702278
'name': 'attribute',
2279+
'grpc_name': 'attribute_id',
22712280
'type': 'ViAttr',
22722281
'use_array': False,
22732282
'use_in_python_api': True
@@ -2326,6 +2335,7 @@
23262335
'description': 'Pass the ID of an attribute.'
23272336
},
23282337
'name': 'attribute',
2338+
'grpc_name': 'attribute_id',
23292339
'type': 'ViAttr',
23302340
'use_array': False,
23312341
'use_in_python_api': True
@@ -2384,6 +2394,7 @@
23842394
'description': 'Pass the ID of an attribute.'
23852395
},
23862396
'name': 'attribute',
2397+
'grpc_name': 'attribute_id',
23872398
'type': 'ViAttr',
23882399
'use_array': False,
23892400
'use_in_python_api': True
@@ -2442,6 +2453,7 @@
24422453
'description': 'Pass the ID of an attribute.'
24432454
},
24442455
'name': 'attribute',
2456+
'grpc_name': 'attribute_id',
24452457
'type': 'ViAttr',
24462458
'use_array': False,
24472459
'use_in_python_api': True
@@ -2500,6 +2512,7 @@
25002512
'description': 'Pass the ID of an attribute.'
25012513
},
25022514
'name': 'attribute',
2515+
'grpc_name': 'attribute_id',
25032516
'type': 'ViAttr',
25042517
'use_array': False,
25052518
'use_in_python_api': True
@@ -2558,6 +2571,7 @@
25582571
'description': 'Pass the ID of an attribute.'
25592572
},
25602573
'name': 'attribute',
2574+
'grpc_name': 'attribute_id',
25612575
'type': 'ViAttr',
25622576
'use_array': False,
25632577
'use_in_python_api': True
@@ -2687,6 +2701,7 @@
26872701
'name': 'sparameters',
26882702
'numpy': True,
26892703
'type': 'NIComplexNumber[]',
2704+
'type_in_documentation': 'numpy.array(dtype=numpy.complex128)',
26902705
'use_array': False,
26912706
'use_in_python_api': True
26922707
},
@@ -3294,6 +3309,7 @@
32943309
]
32953310
},
32963311
'name': 'signalIdentifier',
3312+
# 'grpc_enum': 'SignalIdentifier',
32973313
'type': 'ViConstString',
32983314
'use_array': False,
32993315
'use_in_python_api': True
@@ -3674,6 +3690,7 @@
36743690
'description': 'Returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG function calls.'
36753691
},
36763692
'name': 'newVi',
3693+
'grpc_name': 'vi',
36773694
'type': 'ViSession',
36783695
'use_array': False,
36793696
'use_in_python_api': True
@@ -4579,6 +4596,7 @@
45794596
]
45804597
},
45814598
'name': 'triggerIdentifier',
4599+
# 'grpc_enum': 'SignalIdentifier',
45824600
'type': 'ViConstString',
45834601
'use_array': False,
45844602
'use_in_python_api': True
@@ -4705,6 +4723,7 @@
47054723
'description': 'Pass the ID of an attribute.'
47064724
},
47074725
'name': 'attribute',
4726+
'grpc_name': 'attribute_id',
47084727
'type': 'ViAttr',
47094728
'use_array': False,
47104729
'use_in_python_api': True
@@ -4764,6 +4783,7 @@
47644783
'description': 'Pass the ID of an attribute.'
47654784
},
47664785
'name': 'attribute',
4786+
'grpc_name': 'attribute_id',
47674787
'type': 'ViAttr',
47684788
'use_array': False,
47694789
'use_in_python_api': True
@@ -4774,7 +4794,6 @@
47744794
'description': 'Specifies the value to which you want to set the attribute.',
47754795
'note': 'Some values may not be valid. The allowed values depend on the current settings of the instrument session.'
47764796
},
4777-
'grpc_enum': 'NiRFSGInt32AttributeValues',
47784797
'name': 'value',
47794798
'type': 'ViInt32',
47804799
'use_array': False,
@@ -4824,6 +4843,7 @@
48244843
'description': 'Pass the ID of an attribute.'
48254844
},
48264845
'name': 'attribute',
4846+
'grpc_name': 'attribute_id',
48274847
'type': 'ViAttr',
48284848
'use_array': False,
48294849
'use_in_python_api': True
@@ -4833,7 +4853,6 @@
48334853
'documentation': {
48344854
'description': 'Pass the value to which you want to set the attribute.\n\n<blockquote>\nSome values may not be valid. The allowed values depend on the current settings of the instrument session.\n</blockquote>'
48354855
},
4836-
'grpc_enum': 'NiRFSGInt64AttributeValues',
48374856
'name': 'value',
48384857
'type': 'ViInt64',
48394858
'use_array': False,
@@ -4883,6 +4902,7 @@
48834902
'description': 'Pass the ID of an attribute.'
48844903
},
48854904
'name': 'attribute',
4905+
'grpc_name': 'attribute_id',
48864906
'type': 'ViAttr',
48874907
'use_array': False,
48884908
'use_in_python_api': True
@@ -4893,7 +4913,6 @@
48934913
'description': 'Pass the value to which you want to set the attribute.',
48944914
'note': 'Some values may not be valid. The allowed values depend on the current settings of the instrument session.'
48954915
},
4896-
'grpc_enum': 'NiRFSGReal64AttributeValues',
48974916
'name': 'value',
48984917
'type': 'ViReal64',
48994918
'use_array': False,
@@ -4943,6 +4962,7 @@
49434962
'description': 'Pass the ID of an attribute.'
49444963
},
49454964
'name': 'attribute',
4965+
'grpc_name': 'attribute_id',
49464966
'type': 'ViAttr',
49474967
'use_array': False,
49484968
'use_in_python_api': True
@@ -5002,6 +5022,7 @@
50025022
'description': 'Pass the ID of an attribute.'
50035023
},
50045024
'name': 'attribute',
5025+
'grpc_name': 'attribute_id',
50055026
'type': 'ViAttr',
50065027
'use_array': False,
50075028
'use_in_python_api': True
@@ -5012,7 +5033,6 @@
50125033
'description': 'Pass the value to which you want to set the attribute.',
50135034
'note': 'Some values may not be valid. The allowed values depend on the current settings of the instrument session.'
50145035
},
5015-
'grpc_mapped_enum': 'NiRFSGStringAttributeValuesMapped',
50165036
'name': 'value',
50175037
'type': 'ViConstString',
50185038
'use_array': False,
@@ -5346,6 +5366,7 @@
53465366
'description': 'Specifies the array of data to load into the waveform. The array must have at least as many elements as the value in the **size_in_samples** parameter in the nirfsg_AllocateArbWaveform function.'
53475367
},
53485368
'name': 'waveformDataArray',
5369+
'grpc_name': 'wfm_data',
53495370
'numpy': True,
53505371
'size': {
53515372
'mechanism': 'len',
@@ -5421,6 +5442,7 @@
54215442
'description': 'Specifies the array of data to load into the waveform. The array must have at least as many elements as the value in the **size_in_samples** parameter in the nirfsg_AllocateArbWaveform function.'
54225443
},
54235444
'name': 'waveformDataArray',
5445+
'grpc_name': 'wfm_data',
54245446
'numpy': True,
54255447
'size': {
54265448
'mechanism': 'len',
@@ -5496,6 +5518,7 @@
54965518
'description': 'Specifies the array of data to load into the waveform. The array must have at least as many elements as the value in the **size_in_samples** parameter in the nirfsg_AllocateArbWaveform function.'
54975519
},
54985520
'name': 'waveformDataArray',
5521+
'grpc_name': 'wfm_data',
54995522
'numpy': True,
55005523
'size': {
55015524
'mechanism': 'len',

0 commit comments

Comments
 (0)