Skip to content

Commit 5ca52d6

Browse files
Vaishnavigupta1312ni-jfitzger
Vaishnavigupta1312
and
ni-jfitzger
authored
Miscellaneous NI-RFSG metadata changes (#2104)
* Updated metadata with session lock calls and enum flags * updated method template for hightime apis * Corrected enum value * tox -e codegen --------- Co-authored-by: Jay Fitzgerald <[email protected]>
1 parent 67b6f7d commit 5ca52d6

File tree

10 files changed

+3469
-9675
lines changed

10 files changed

+3469
-9675
lines changed

‎docs/nirfsg/class.rst‎

Lines changed: 1075 additions & 831 deletions
Large diffs are not rendered by default.

‎docs/nirfsg/enums.rst‎

Lines changed: 480 additions & 3334 deletions
Large diffs are not rendered by default.

‎generated/nirfsg/nirfsg/_library.py‎

Lines changed: 43 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -60,21 +60,22 @@ def __init__(self, ctypes_library):
6060
self.niRFSG_DisableScriptTrigger_cfunc = None
6161
self.niRFSG_DisableStartTrigger_cfunc = None
6262
self.niRFSG_ExportSignal_cfunc = None
63+
self.niRFSG_GetAllNamedWaveformNames_cfunc = None
64+
self.niRFSG_GetAllScriptNames_cfunc = None
6365
self.niRFSG_GetAttributeViBoolean_cfunc = None
6466
self.niRFSG_GetAttributeViInt32_cfunc = None
6567
self.niRFSG_GetAttributeViInt64_cfunc = None
6668
self.niRFSG_GetAttributeViReal64_cfunc = None
6769
self.niRFSG_GetAttributeViSession_cfunc = None
6870
self.niRFSG_GetAttributeViString_cfunc = None
71+
self.niRFSG_GetChannelName_cfunc = None
6972
self.niRFSG_GetError_cfunc = None
7073
self.niRFSG_GetExternalCalibrationLastDateAndTime_cfunc = None
7174
self.niRFSG_GetMaxSettablePower_cfunc = None
7275
self.niRFSG_GetSelfCalibrationDateAndTime_cfunc = None
7376
self.niRFSG_GetSelfCalibrationTemperature_cfunc = None
7477
self.niRFSG_GetStreamEndpointHandle_cfunc = None
75-
self.niRFSG_GetWaveformBurstStartLocations_cfunc = None
76-
self.niRFSG_GetWaveformBurstStopLocations_cfunc = None
77-
self.niRFSG_GetWaveformMarkerEventLocations_cfunc = None
78+
self.niRFSG_GetTerminalName_cfunc = None
7879
self.niRFSG_InitWithOptions_cfunc = None
7980
self.niRFSG_Initiate_cfunc = None
8081
self.niRFSG_LoadConfigurationsFromFile_cfunc = None
@@ -87,6 +88,7 @@ def __init__(self, ctypes_library):
8788
self.niRFSG_ResetAttribute_cfunc = None
8889
self.niRFSG_ResetDevice_cfunc = None
8990
self.niRFSG_ResetWithDefaults_cfunc = None
91+
self.niRFSG_ResetWithOptions_cfunc = None
9092
self.niRFSG_SaveConfigurationsToFile_cfunc = None
9193
self.niRFSG_SelectArbWaveform_cfunc = None
9294
self.niRFSG_SelfCal_cfunc = None
@@ -100,9 +102,6 @@ def __init__(self, ctypes_library):
100102
self.niRFSG_SetAttributeViReal64_cfunc = None
101103
self.niRFSG_SetAttributeViSession_cfunc = None
102104
self.niRFSG_SetAttributeViString_cfunc = None
103-
self.niRFSG_SetWaveformBurstStartLocations_cfunc = None
104-
self.niRFSG_SetWaveformBurstStopLocations_cfunc = None
105-
self.niRFSG_SetWaveformMarkerEventLocations_cfunc = None
106105
self.niRFSG_UnlockSession_cfunc = None
107106
self.niRFSG_WaitUntilSettled_cfunc = None
108107
self.niRFSG_WriteP2PEndpointI16_cfunc = None
@@ -444,6 +443,22 @@ def niRFSG_ExportSignal(self, vi, signal, signal_identifier, output_terminal):
444443
self.niRFSG_ExportSignal_cfunc.restype = ViStatus # noqa: F405
445444
return self.niRFSG_ExportSignal_cfunc(vi, signal, signal_identifier, output_terminal)
446445

446+
def niRFSG_GetAllNamedWaveformNames(self, vi, waveform_names, buffer_size, actual_buffer_size): # noqa: N802
447+
with self._func_lock:
448+
if self.niRFSG_GetAllNamedWaveformNames_cfunc is None:
449+
self.niRFSG_GetAllNamedWaveformNames_cfunc = self._get_library_function('niRFSG_GetAllNamedWaveformNames')
450+
self.niRFSG_GetAllNamedWaveformNames_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViInt32)] # noqa: F405
451+
self.niRFSG_GetAllNamedWaveformNames_cfunc.restype = ViStatus # noqa: F405
452+
return self.niRFSG_GetAllNamedWaveformNames_cfunc(vi, waveform_names, buffer_size, actual_buffer_size)
453+
454+
def niRFSG_GetAllScriptNames(self, vi, script_names, buffer_size, actual_buffer_size): # noqa: N802
455+
with self._func_lock:
456+
if self.niRFSG_GetAllScriptNames_cfunc is None:
457+
self.niRFSG_GetAllScriptNames_cfunc = self._get_library_function('niRFSG_GetAllScriptNames')
458+
self.niRFSG_GetAllScriptNames_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViInt32)] # noqa: F405
459+
self.niRFSG_GetAllScriptNames_cfunc.restype = ViStatus # noqa: F405
460+
return self.niRFSG_GetAllScriptNames_cfunc(vi, script_names, buffer_size, actual_buffer_size)
461+
447462
def niRFSG_GetAttributeViBoolean(self, vi, channel_name, attribute, value): # noqa: N802
448463
with self._func_lock:
449464
if self.niRFSG_GetAttributeViBoolean_cfunc is None:
@@ -492,6 +507,14 @@ def niRFSG_GetAttributeViString(self, vi, channel_name, attribute, buf_size, val
492507
self.niRFSG_GetAttributeViString_cfunc.restype = ViStatus # noqa: F405
493508
return self.niRFSG_GetAttributeViString_cfunc(vi, channel_name, attribute, buf_size, value)
494509

510+
def niRFSG_GetChannelName(self, vi, index, buffer_size, name): # noqa: N802
511+
with self._func_lock:
512+
if self.niRFSG_GetChannelName_cfunc is None:
513+
self.niRFSG_GetChannelName_cfunc = self._get_library_function('niRFSG_GetChannelName')
514+
self.niRFSG_GetChannelName_cfunc.argtypes = [ViSession, ViInt32, ViInt32, ctypes.POINTER(ViChar)] # noqa: F405
515+
self.niRFSG_GetChannelName_cfunc.restype = ViStatus # noqa: F405
516+
return self.niRFSG_GetChannelName_cfunc(vi, index, buffer_size, name)
517+
495518
def niRFSG_GetError(self, vi, error_code, error_description_buffer_size, error_description): # noqa: N802
496519
with self._func_lock:
497520
if self.niRFSG_GetError_cfunc is None:
@@ -540,29 +563,13 @@ def niRFSG_GetStreamEndpointHandle(self, vi, stream_endpoint, reader_handle): #
540563
self.niRFSG_GetStreamEndpointHandle_cfunc.restype = ViStatus # noqa: F405
541564
return self.niRFSG_GetStreamEndpointHandle_cfunc(vi, stream_endpoint, reader_handle)
542565

543-
def niRFSG_GetWaveformBurstStartLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802
544-
with self._func_lock:
545-
if self.niRFSG_GetWaveformBurstStartLocations_cfunc is None:
546-
self.niRFSG_GetWaveformBurstStartLocations_cfunc = self._get_library_function('niRFSG_GetWaveformBurstStartLocations')
547-
self.niRFSG_GetWaveformBurstStartLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64), ctypes.POINTER(ViInt32)] # noqa: F405
548-
self.niRFSG_GetWaveformBurstStartLocations_cfunc.restype = ViStatus # noqa: F405
549-
return self.niRFSG_GetWaveformBurstStartLocations_cfunc(vi, channel_name, number_of_locations, locations, required_size)
550-
551-
def niRFSG_GetWaveformBurstStopLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802
552-
with self._func_lock:
553-
if self.niRFSG_GetWaveformBurstStopLocations_cfunc is None:
554-
self.niRFSG_GetWaveformBurstStopLocations_cfunc = self._get_library_function('niRFSG_GetWaveformBurstStopLocations')
555-
self.niRFSG_GetWaveformBurstStopLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64), ctypes.POINTER(ViInt32)] # noqa: F405
556-
self.niRFSG_GetWaveformBurstStopLocations_cfunc.restype = ViStatus # noqa: F405
557-
return self.niRFSG_GetWaveformBurstStopLocations_cfunc(vi, channel_name, number_of_locations, locations, required_size)
558-
559-
def niRFSG_GetWaveformMarkerEventLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802
566+
def niRFSG_GetTerminalName(self, vi, signal, signal_identifier, buffer_size, terminal_name): # noqa: N802
560567
with self._func_lock:
561-
if self.niRFSG_GetWaveformMarkerEventLocations_cfunc is None:
562-
self.niRFSG_GetWaveformMarkerEventLocations_cfunc = self._get_library_function('niRFSG_GetWaveformMarkerEventLocations')
563-
self.niRFSG_GetWaveformMarkerEventLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64), ctypes.POINTER(ViInt32)] # noqa: F405
564-
self.niRFSG_GetWaveformMarkerEventLocations_cfunc.restype = ViStatus # noqa: F405
565-
return self.niRFSG_GetWaveformMarkerEventLocations_cfunc(vi, channel_name, number_of_locations, locations, required_size)
568+
if self.niRFSG_GetTerminalName_cfunc is None:
569+
self.niRFSG_GetTerminalName_cfunc = self._get_library_function('niRFSG_GetTerminalName')
570+
self.niRFSG_GetTerminalName_cfunc.argtypes = [ViSession, ViInt32, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViChar)] # noqa: F405
571+
self.niRFSG_GetTerminalName_cfunc.restype = ViStatus # noqa: F405
572+
return self.niRFSG_GetTerminalName_cfunc(vi, signal, signal_identifier, buffer_size, terminal_name)
566573

567574
def niRFSG_InitWithOptions(self, resource_name, id_query, reset_device, option_string, new_vi): # noqa: N802
568575
with self._func_lock:
@@ -660,6 +667,14 @@ def niRFSG_ResetWithDefaults(self, vi): # noqa: N802
660667
self.niRFSG_ResetWithDefaults_cfunc.restype = ViStatus # noqa: F405
661668
return self.niRFSG_ResetWithDefaults_cfunc(vi)
662669

670+
def niRFSG_ResetWithOptions(self, vi, steps_to_omit): # noqa: N802
671+
with self._func_lock:
672+
if self.niRFSG_ResetWithOptions_cfunc is None:
673+
self.niRFSG_ResetWithOptions_cfunc = self._get_library_function('niRFSG_ResetWithOptions')
674+
self.niRFSG_ResetWithOptions_cfunc.argtypes = [ViSession, ViUInt64] # noqa: F405
675+
self.niRFSG_ResetWithOptions_cfunc.restype = ViStatus # noqa: F405
676+
return self.niRFSG_ResetWithOptions_cfunc(vi, steps_to_omit)
677+
663678
def niRFSG_SaveConfigurationsToFile(self, vi, channel_name, file_path): # noqa: N802
664679
with self._func_lock:
665680
if self.niRFSG_SaveConfigurationsToFile_cfunc is None:
@@ -764,30 +779,6 @@ def niRFSG_SetAttributeViString(self, vi, channel_name, attribute, value): # no
764779
self.niRFSG_SetAttributeViString_cfunc.restype = ViStatus # noqa: F405
765780
return self.niRFSG_SetAttributeViString_cfunc(vi, channel_name, attribute, value)
766781

767-
def niRFSG_SetWaveformBurstStartLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802
768-
with self._func_lock:
769-
if self.niRFSG_SetWaveformBurstStartLocations_cfunc is None:
770-
self.niRFSG_SetWaveformBurstStartLocations_cfunc = self._get_library_function('niRFSG_SetWaveformBurstStartLocations')
771-
self.niRFSG_SetWaveformBurstStartLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64)] # noqa: F405
772-
self.niRFSG_SetWaveformBurstStartLocations_cfunc.restype = ViStatus # noqa: F405
773-
return self.niRFSG_SetWaveformBurstStartLocations_cfunc(vi, channel_name, number_of_locations, locations)
774-
775-
def niRFSG_SetWaveformBurstStopLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802
776-
with self._func_lock:
777-
if self.niRFSG_SetWaveformBurstStopLocations_cfunc is None:
778-
self.niRFSG_SetWaveformBurstStopLocations_cfunc = self._get_library_function('niRFSG_SetWaveformBurstStopLocations')
779-
self.niRFSG_SetWaveformBurstStopLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64)] # noqa: F405
780-
self.niRFSG_SetWaveformBurstStopLocations_cfunc.restype = ViStatus # noqa: F405
781-
return self.niRFSG_SetWaveformBurstStopLocations_cfunc(vi, channel_name, number_of_locations, locations)
782-
783-
def niRFSG_SetWaveformMarkerEventLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802
784-
with self._func_lock:
785-
if self.niRFSG_SetWaveformMarkerEventLocations_cfunc is None:
786-
self.niRFSG_SetWaveformMarkerEventLocations_cfunc = self._get_library_function('niRFSG_SetWaveformMarkerEventLocations')
787-
self.niRFSG_SetWaveformMarkerEventLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64)] # noqa: F405
788-
self.niRFSG_SetWaveformMarkerEventLocations_cfunc.restype = ViStatus # noqa: F405
789-
return self.niRFSG_SetWaveformMarkerEventLocations_cfunc(vi, channel_name, number_of_locations, locations)
790-
791782
def niRFSG_UnlockSession(self, vi, caller_has_lock): # noqa: N802
792783
with self._func_lock:
793784
if self.niRFSG_UnlockSession_cfunc is None:

0 commit comments

Comments
 (0)