Skip to content

Miscellaneous NI-RFSG metadata changes #2104

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
ni-jfitzger merged 4 commits into from
Jun 9, 2025
Merged

Miscellaneous NI-RFSG metadata changes #2104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7122f17
Updated metadata with session lock calls and enum flags
Vaishnavigupta1312 Jun 3, 2025
48bdec3
updated method template for hightime apis
Vaishnavigupta1312 Jun 6, 2025
c605ee2
Corrected enum value
Vaishnavigupta1312 Jun 9, 2025
b39aa24
tox -e codegen
ni-jfitzger Jun 9, 2025
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
1,906 changes: 1,075 additions & 831 deletions docs/nirfsg/class.rst
View file
Open in desktop

Large diffs are not rendered by default.

3,814 changes: 480 additions & 3,334 deletions docs/nirfsg/enums.rst
View file
Open in desktop

Large diffs are not rendered by default.

95 changes: 43 additions & 52 deletions generated/nirfsg/nirfsg/_library.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,21 +60,22 @@ def __init__(self, ctypes_library):
self.niRFSG_DisableScriptTrigger_cfunc = None
self.niRFSG_DisableStartTrigger_cfunc = None
self.niRFSG_ExportSignal_cfunc = None
self.niRFSG_GetAllNamedWaveformNames_cfunc = None
self.niRFSG_GetAllScriptNames_cfunc = None
self.niRFSG_GetAttributeViBoolean_cfunc = None
self.niRFSG_GetAttributeViInt32_cfunc = None
self.niRFSG_GetAttributeViInt64_cfunc = None
self.niRFSG_GetAttributeViReal64_cfunc = None
self.niRFSG_GetAttributeViSession_cfunc = None
self.niRFSG_GetAttributeViString_cfunc = None
self.niRFSG_GetChannelName_cfunc = None
self.niRFSG_GetError_cfunc = None
self.niRFSG_GetExternalCalibrationLastDateAndTime_cfunc = None
self.niRFSG_GetMaxSettablePower_cfunc = None
self.niRFSG_GetSelfCalibrationDateAndTime_cfunc = None
self.niRFSG_GetSelfCalibrationTemperature_cfunc = None
self.niRFSG_GetStreamEndpointHandle_cfunc = None
self.niRFSG_GetWaveformBurstStartLocations_cfunc = None
self.niRFSG_GetWaveformBurstStopLocations_cfunc = None
self.niRFSG_GetWaveformMarkerEventLocations_cfunc = None
self.niRFSG_GetTerminalName_cfunc = None
self.niRFSG_InitWithOptions_cfunc = None
self.niRFSG_Initiate_cfunc = None
self.niRFSG_LoadConfigurationsFromFile_cfunc = None
Expand All @@ -87,6 +88,7 @@ def __init__(self, ctypes_library):
self.niRFSG_ResetAttribute_cfunc = None
self.niRFSG_ResetDevice_cfunc = None
self.niRFSG_ResetWithDefaults_cfunc = None
self.niRFSG_ResetWithOptions_cfunc = None
self.niRFSG_SaveConfigurationsToFile_cfunc = None
self.niRFSG_SelectArbWaveform_cfunc = None
self.niRFSG_SelfCal_cfunc = None
Expand All @@ -100,9 +102,6 @@ def __init__(self, ctypes_library):
self.niRFSG_SetAttributeViReal64_cfunc = None
self.niRFSG_SetAttributeViSession_cfunc = None
self.niRFSG_SetAttributeViString_cfunc = None
self.niRFSG_SetWaveformBurstStartLocations_cfunc = None
self.niRFSG_SetWaveformBurstStopLocations_cfunc = None
self.niRFSG_SetWaveformMarkerEventLocations_cfunc = None
self.niRFSG_UnlockSession_cfunc = None
self.niRFSG_WaitUntilSettled_cfunc = None
self.niRFSG_WriteP2PEndpointI16_cfunc = None
Expand Down Expand Up @@ -444,6 +443,22 @@ def niRFSG_ExportSignal(self, vi, signal, signal_identifier, output_terminal):
self.niRFSG_ExportSignal_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_ExportSignal_cfunc(vi, signal, signal_identifier, output_terminal)

def niRFSG_GetAllNamedWaveformNames(self, vi, waveform_names, buffer_size, actual_buffer_size): # noqa: N802
with self._func_lock:
if self.niRFSG_GetAllNamedWaveformNames_cfunc is None:
self.niRFSG_GetAllNamedWaveformNames_cfunc = self._get_library_function('niRFSG_GetAllNamedWaveformNames')
self.niRFSG_GetAllNamedWaveformNames_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViInt32)] # noqa: F405
self.niRFSG_GetAllNamedWaveformNames_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_GetAllNamedWaveformNames_cfunc(vi, waveform_names, buffer_size, actual_buffer_size)

def niRFSG_GetAllScriptNames(self, vi, script_names, buffer_size, actual_buffer_size): # noqa: N802
with self._func_lock:
if self.niRFSG_GetAllScriptNames_cfunc is None:
self.niRFSG_GetAllScriptNames_cfunc = self._get_library_function('niRFSG_GetAllScriptNames')
self.niRFSG_GetAllScriptNames_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViInt32)] # noqa: F405
self.niRFSG_GetAllScriptNames_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_GetAllScriptNames_cfunc(vi, script_names, buffer_size, actual_buffer_size)

def niRFSG_GetAttributeViBoolean(self, vi, channel_name, attribute, value): # noqa: N802
with self._func_lock:
if self.niRFSG_GetAttributeViBoolean_cfunc is None:
Expand Down Expand Up @@ -492,6 +507,14 @@ def niRFSG_GetAttributeViString(self, vi, channel_name, attribute, buf_size, val
self.niRFSG_GetAttributeViString_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_GetAttributeViString_cfunc(vi, channel_name, attribute, buf_size, value)

def niRFSG_GetChannelName(self, vi, index, buffer_size, name): # noqa: N802
with self._func_lock:
if self.niRFSG_GetChannelName_cfunc is None:
self.niRFSG_GetChannelName_cfunc = self._get_library_function('niRFSG_GetChannelName')
self.niRFSG_GetChannelName_cfunc.argtypes = [ViSession, ViInt32, ViInt32, ctypes.POINTER(ViChar)] # noqa: F405
self.niRFSG_GetChannelName_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_GetChannelName_cfunc(vi, index, buffer_size, name)

def niRFSG_GetError(self, vi, error_code, error_description_buffer_size, error_description): # noqa: N802
with self._func_lock:
if self.niRFSG_GetError_cfunc is None:
Expand Down Expand Up @@ -540,29 +563,13 @@ def niRFSG_GetStreamEndpointHandle(self, vi, stream_endpoint, reader_handle): #
self.niRFSG_GetStreamEndpointHandle_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_GetStreamEndpointHandle_cfunc(vi, stream_endpoint, reader_handle)

def niRFSG_GetWaveformBurstStartLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802
with self._func_lock:
if self.niRFSG_GetWaveformBurstStartLocations_cfunc is None:
self.niRFSG_GetWaveformBurstStartLocations_cfunc = self._get_library_function('niRFSG_GetWaveformBurstStartLocations')
self.niRFSG_GetWaveformBurstStartLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64), ctypes.POINTER(ViInt32)] # noqa: F405
self.niRFSG_GetWaveformBurstStartLocations_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_GetWaveformBurstStartLocations_cfunc(vi, channel_name, number_of_locations, locations, required_size)

def niRFSG_GetWaveformBurstStopLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802
with self._func_lock:
if self.niRFSG_GetWaveformBurstStopLocations_cfunc is None:
self.niRFSG_GetWaveformBurstStopLocations_cfunc = self._get_library_function('niRFSG_GetWaveformBurstStopLocations')
self.niRFSG_GetWaveformBurstStopLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64), ctypes.POINTER(ViInt32)] # noqa: F405
self.niRFSG_GetWaveformBurstStopLocations_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_GetWaveformBurstStopLocations_cfunc(vi, channel_name, number_of_locations, locations, required_size)

def niRFSG_GetWaveformMarkerEventLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802
def niRFSG_GetTerminalName(self, vi, signal, signal_identifier, buffer_size, terminal_name): # noqa: N802
with self._func_lock:
if self.niRFSG_GetWaveformMarkerEventLocations_cfunc is None:
self.niRFSG_GetWaveformMarkerEventLocations_cfunc = self._get_library_function('niRFSG_GetWaveformMarkerEventLocations')
self.niRFSG_GetWaveformMarkerEventLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64), ctypes.POINTER(ViInt32)] # noqa: F405
self.niRFSG_GetWaveformMarkerEventLocations_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_GetWaveformMarkerEventLocations_cfunc(vi, channel_name, number_of_locations, locations, required_size)
if self.niRFSG_GetTerminalName_cfunc is None:
self.niRFSG_GetTerminalName_cfunc = self._get_library_function('niRFSG_GetTerminalName')
self.niRFSG_GetTerminalName_cfunc.argtypes = [ViSession, ViInt32, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViChar)] # noqa: F405
self.niRFSG_GetTerminalName_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_GetTerminalName_cfunc(vi, signal, signal_identifier, buffer_size, terminal_name)

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

def niRFSG_ResetWithOptions(self, vi, steps_to_omit): # noqa: N802
with self._func_lock:
if self.niRFSG_ResetWithOptions_cfunc is None:
self.niRFSG_ResetWithOptions_cfunc = self._get_library_function('niRFSG_ResetWithOptions')
self.niRFSG_ResetWithOptions_cfunc.argtypes = [ViSession, ViUInt64] # noqa: F405
self.niRFSG_ResetWithOptions_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_ResetWithOptions_cfunc(vi, steps_to_omit)

def niRFSG_SaveConfigurationsToFile(self, vi, channel_name, file_path): # noqa: N802
with self._func_lock:
if self.niRFSG_SaveConfigurationsToFile_cfunc is None:
Expand Down Expand Up @@ -764,30 +779,6 @@ def niRFSG_SetAttributeViString(self, vi, channel_name, attribute, value): # no
self.niRFSG_SetAttributeViString_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_SetAttributeViString_cfunc(vi, channel_name, attribute, value)

def niRFSG_SetWaveformBurstStartLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802
with self._func_lock:
if self.niRFSG_SetWaveformBurstStartLocations_cfunc is None:
self.niRFSG_SetWaveformBurstStartLocations_cfunc = self._get_library_function('niRFSG_SetWaveformBurstStartLocations')
self.niRFSG_SetWaveformBurstStartLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64)] # noqa: F405
self.niRFSG_SetWaveformBurstStartLocations_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_SetWaveformBurstStartLocations_cfunc(vi, channel_name, number_of_locations, locations)

def niRFSG_SetWaveformBurstStopLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802
with self._func_lock:
if self.niRFSG_SetWaveformBurstStopLocations_cfunc is None:
self.niRFSG_SetWaveformBurstStopLocations_cfunc = self._get_library_function('niRFSG_SetWaveformBurstStopLocations')
self.niRFSG_SetWaveformBurstStopLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64)] # noqa: F405
self.niRFSG_SetWaveformBurstStopLocations_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_SetWaveformBurstStopLocations_cfunc(vi, channel_name, number_of_locations, locations)

def niRFSG_SetWaveformMarkerEventLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802
with self._func_lock:
if self.niRFSG_SetWaveformMarkerEventLocations_cfunc is None:
self.niRFSG_SetWaveformMarkerEventLocations_cfunc = self._get_library_function('niRFSG_SetWaveformMarkerEventLocations')
self.niRFSG_SetWaveformMarkerEventLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64)] # noqa: F405
self.niRFSG_SetWaveformMarkerEventLocations_cfunc.restype = ViStatus # noqa: F405
return self.niRFSG_SetWaveformMarkerEventLocations_cfunc(vi, channel_name, number_of_locations, locations)

def niRFSG_UnlockSession(self, vi, caller_has_lock): # noqa: N802
with self._func_lock:
if self.niRFSG_UnlockSession_cfunc is None:
Expand Down
Loading
Loading