fixed the self test method name to match the driver method

Author: vnktshr21

generated/nirfsg/nirfsg/_library.py

@@ -81,7 +81,6 @@ def __init__(self, ctypes_library):
         self.niRFSG_SelectArbWaveform_cfunc = None
         self.niRFSG_SelfCal_cfunc = None
         self.niRFSG_SelfCalibrateRange_cfunc = None
-        self.niRFSG_SelfTest_cfunc = None
         self.niRFSG_SendSoftwareEdgeTrigger_cfunc = None
         self.niRFSG_SetArbWaveformNextWritePosition_cfunc = None
         self.niRFSG_SetAttributeViBoolean_cfunc = None
@@ -101,6 +100,7 @@ def __init__(self, ctypes_library):
         self.niRFSG_WriteScript_cfunc = None
         self.niRFSG_close_cfunc = None
         self.niRFSG_reset_cfunc = None
+        self.niRFSG_self_test_cfunc = None
 
     def _get_library_function(self, name):
         try:
@@ -597,14 +597,6 @@ def niRFSG_SelfCalibrateRange(self, vi, steps_to_omit, min_frequency, max_freque
                 self.niRFSG_SelfCalibrateRange_cfunc.restype = ViStatus  # noqa: F405
         return self.niRFSG_SelfCalibrateRange_cfunc(vi, steps_to_omit, min_frequency, max_frequency, min_power_level, max_power_level)
 
-    def niRFSG_SelfTest(self, vi, self_test_result, self_test_message):  # noqa: N802
-        with self._func_lock:
-            if self.niRFSG_SelfTest_cfunc is None:
-                self.niRFSG_SelfTest_cfunc = self._get_library_function('niRFSG_SelfTest')
-                self.niRFSG_SelfTest_cfunc.argtypes = [ViSession, ctypes.POINTER(ViInt16), ctypes.POINTER(ViChar)]  # noqa: F405
-                self.niRFSG_SelfTest_cfunc.restype = ViStatus  # noqa: F405
-        return self.niRFSG_SelfTest_cfunc(vi, self_test_result, self_test_message)
-
     def niRFSG_SendSoftwareEdgeTrigger(self, vi, trigger, trigger_identifier):  # noqa: N802
         with self._func_lock:
             if self.niRFSG_SendSoftwareEdgeTrigger_cfunc is None:
@@ -756,3 +748,11 @@ def niRFSG_reset(self, vi):  # noqa: N802
                 self.niRFSG_reset_cfunc.argtypes = [ViSession]  # noqa: F405
                 self.niRFSG_reset_cfunc.restype = ViStatus  # noqa: F405
         return self.niRFSG_reset_cfunc(vi)
+
+    def niRFSG_self_test(self, vi, self_test_result, self_test_message):  # noqa: N802
+        with self._func_lock:
+            if self.niRFSG_self_test_cfunc is None:
+                self.niRFSG_self_test_cfunc = self._get_library_function('niRFSG_self_test')
+                self.niRFSG_self_test_cfunc.argtypes = [ViSession, ctypes.POINTER(ViInt16), ctypes.POINTER(ViChar)]  # noqa: F405
+                self.niRFSG_self_test_cfunc.restype = ViStatus  # noqa: F405
+        return self.niRFSG_self_test_cfunc(vi, self_test_result, self_test_message)

generated/nirfsg/nirfsg/_library_interpreter.py

@@ -625,14 +625,6 @@ def self_calibrate_range(self, steps_to_omit, min_frequency, max_frequency, min_
         errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False)
         return
 
-    def self_test(self):  # noqa: N802
-        vi_ctype = _visatype.ViSession(self._vi)  # case S110
-        self_test_result_ctype = _visatype.ViInt16()  # case S220
-        self_test_message_ctype = (_visatype.ViChar * 256)()  # case C070
-        error_code = self._library.niRFSG_SelfTest(vi_ctype, None if self_test_result_ctype is None else (ctypes.pointer(self_test_result_ctype)), self_test_message_ctype)
-        errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False)
-        return int(self_test_result_ctype.value), self_test_message_ctype.value.decode(self._encoding)
-
     def send_software_edge_trigger(self, trigger, trigger_identifier):  # noqa: N802
         vi_ctype = _visatype.ViSession(self._vi)  # case S110
         trigger_ctype = _visatype.ViInt32(trigger.value)  # case S130
@@ -791,3 +783,11 @@ def reset(self):  # noqa: N802
         error_code = self._library.niRFSG_reset(vi_ctype)
         errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False)
         return
+
+    def self_test(self):  # noqa: N802
+        vi_ctype = _visatype.ViSession(self._vi)  # case S110
+        self_test_result_ctype = _visatype.ViInt16()  # case S220
+        self_test_message_ctype = (_visatype.ViChar * 256)()  # case C070
+        error_code = self._library.niRFSG_self_test(vi_ctype, None if self_test_result_ctype is None else (ctypes.pointer(self_test_result_ctype)), self_test_message_ctype)
+        errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False)
+        return int(self_test_result_ctype.value), self_test_message_ctype.value.decode(self._encoding)

generated/nirfsg/nirfsg/session.py

@@ -7087,41 +7087,6 @@ def self_calibrate_range(self, steps_to_omit, min_frequency, max_frequency, min_
             raise TypeError('Parameter steps_to_omit must be of type ' + str(enums.SelfCalibrateRangeStepsToOmit))
         self._interpreter.self_calibrate_range(steps_to_omit, min_frequency, max_frequency, min_power_level, max_power_level)
 
-    @ivi_synchronized
-    def _self_test(self):
-        r'''_self_test
-
-        Performs a self-test on the NI-RFSG device and returns the test results.
-
-        This method performs a simple series of tests to ensure that the NI-RFSG device is powered up and responding.
-
-        This method does not affect external I/O connections or connections between devices. Complete functional testing and calibration are not performed by this method. The NI-RFSG device must be in the Configuration state before you call this method.
-
-        **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860
-
-        **Related Topics**
-
-        `Device Warm-Up <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/warmup.html>`_
-
-        Returns:
-            self_test_result (int): This parameter contains the value returned from the NI-RFSG device self test.
-
-                +----------------+------------------+
-                | Self-Test Code | Description      |
-                +================+==================+
-                | 0              | Self test passed |
-                +----------------+------------------+
-                | 1              | Self test failed |
-                +----------------+------------------+
-
-            self_test_message (str): Returns the self-test response string from the NI-RFSG device. For an explanation of the string contents, refer to the **status** parameter of this method.
-
-                You must pass a ViChar array with at least 256 bytes.
-
-        '''
-        self_test_result, self_test_message = self._interpreter.self_test()
-        return self_test_result, self_test_message
-
     @ivi_synchronized
     def set_arb_waveform_next_write_position(self, waveform_name, relative_to, offset):
         r'''set_arb_waveform_next_write_position
@@ -7418,3 +7383,38 @@ def reset(self):
         Note: This method resets all configured routes for the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 in NI-RFSA and NI-RFSG.
         '''
         self._interpreter.reset()
+
+    @ivi_synchronized
+    def _self_test(self):
+        r'''_self_test
+
+        Performs a self-test on the NI-RFSG device and returns the test results.
+
+        This method performs a simple series of tests to ensure that the NI-RFSG device is powered up and responding.
+
+        This method does not affect external I/O connections or connections between devices. Complete functional testing and calibration are not performed by this method. The NI-RFSG device must be in the Configuration state before you call this method.
+
+        **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860
+
+        **Related Topics**
+
+        `Device Warm-Up <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/warmup.html>`_
+
+        Returns:
+            self_test_result (int): This parameter contains the value returned from the NI-RFSG device self test.
+
+                +----------------+------------------+
+                | Self-Test Code | Description      |
+                +================+==================+
+                | 0              | Self test passed |
+                +----------------+------------------+
+                | 1              | Self test failed |
+                +----------------+------------------+
+
+            self_test_message (str): Returns the self-test response string from the NI-RFSG device. For an explanation of the string contents, refer to the **status** parameter of this method.
+
+                You must pass a ViChar array with at least 256 bytes.
+
+        '''
+        self_test_result, self_test_message = self._interpreter.self_test()
+        return self_test_result, self_test_message

generated/nirfsg/nirfsg/unit_tests/_mock_helper.py

@@ -184,10 +184,6 @@ def __init__(self):
         self._defaults['SelfCal']['return'] = 0
         self._defaults['SelfCalibrateRange'] = {}
         self._defaults['SelfCalibrateRange']['return'] = 0
-        self._defaults['SelfTest'] = {}
-        self._defaults['SelfTest']['return'] = 0
-        self._defaults['SelfTest']['selfTestResult'] = None
-        self._defaults['SelfTest']['selfTestMessage'] = None
         self._defaults['SendSoftwareEdgeTrigger'] = {}
         self._defaults['SendSoftwareEdgeTrigger']['return'] = 0
         self._defaults['SetArbWaveformNextWritePosition'] = {}
@@ -227,6 +223,10 @@ def __init__(self):
         self._defaults['close']['return'] = 0
         self._defaults['reset'] = {}
         self._defaults['reset']['return'] = 0
+        self._defaults['self_test'] = {}
+        self._defaults['self_test']['return'] = 0
+        self._defaults['self_test']['selfTestResult'] = None
+        self._defaults['self_test']['selfTestMessage'] = None
 
     def __getitem__(self, func):
         return self._defaults[func]
@@ -798,25 +798,6 @@ def niRFSG_SelfCalibrateRange(self, vi, steps_to_omit, min_frequency, max_freque
             return self._defaults['SelfCalibrateRange']['return']
         return self._defaults['SelfCalibrateRange']['return']
 
-    def niRFSG_SelfTest(self, vi, self_test_result, self_test_message):  # noqa: N802
-        if self._defaults['SelfTest']['return'] != 0:
-            return self._defaults['SelfTest']['return']
-        # self_test_result
-        if self._defaults['SelfTest']['selfTestResult'] is None:
-            raise MockFunctionCallError("niRFSG_SelfTest", param='selfTestResult')
-        if self_test_result is not None:
-            self_test_result.contents.value = self._defaults['SelfTest']['selfTestResult']
-        # self_test_message
-        if self._defaults['SelfTest']['selfTestMessage'] is None:
-            raise MockFunctionCallError("niRFSG_SelfTest", param='selfTestMessage')
-        test_value = self._defaults['SelfTest']['selfTestMessage']
-        if type(test_value) is str:
-            test_value = test_value.encode('ascii')
-        assert len(self_test_message) >= len(test_value)
-        for i in range(len(test_value)):
-            self_test_message[i] = test_value[i]
-        return self._defaults['SelfTest']['return']
-
     def niRFSG_SendSoftwareEdgeTrigger(self, vi, trigger, trigger_identifier):  # noqa: N802
         if self._defaults['SendSoftwareEdgeTrigger']['return'] != 0:
             return self._defaults['SendSoftwareEdgeTrigger']['return']
@@ -917,6 +898,25 @@ def niRFSG_reset(self, vi):  # noqa: N802
             return self._defaults['reset']['return']
         return self._defaults['reset']['return']
 
+    def niRFSG_self_test(self, vi, self_test_result, self_test_message):  # noqa: N802
+        if self._defaults['self_test']['return'] != 0:
+            return self._defaults['self_test']['return']
+        # self_test_result
+        if self._defaults['self_test']['selfTestResult'] is None:
+            raise MockFunctionCallError("niRFSG_self_test", param='selfTestResult')
+        if self_test_result is not None:
+            self_test_result.contents.value = self._defaults['self_test']['selfTestResult']
+        # self_test_message
+        if self._defaults['self_test']['selfTestMessage'] is None:
+            raise MockFunctionCallError("niRFSG_self_test", param='selfTestMessage')
+        test_value = self._defaults['self_test']['selfTestMessage']
+        if type(test_value) is str:
+            test_value = test_value.encode('ascii')
+        assert len(self_test_message) >= len(test_value)
+        for i in range(len(test_value)):
+            self_test_message[i] = test_value[i]
+        return self._defaults['self_test']['return']
+
     # Helper function to setup Mock object with default side effects and return values
     def set_side_effects_and_return_values(self, mock_library):
         mock_library.niRFSG_Abort.side_effect = MockFunctionCallError("niRFSG_Abort")
@@ -1041,8 +1041,6 @@ def set_side_effects_and_return_values(self, mock_library):
         mock_library.niRFSG_SelfCal.return_value = 0
         mock_library.niRFSG_SelfCalibrateRange.side_effect = MockFunctionCallError("niRFSG_SelfCalibrateRange")
         mock_library.niRFSG_SelfCalibrateRange.return_value = 0
-        mock_library.niRFSG_SelfTest.side_effect = MockFunctionCallError("niRFSG_SelfTest")
-        mock_library.niRFSG_SelfTest.return_value = 0
         mock_library.niRFSG_SendSoftwareEdgeTrigger.side_effect = MockFunctionCallError("niRFSG_SendSoftwareEdgeTrigger")
         mock_library.niRFSG_SendSoftwareEdgeTrigger.return_value = 0
         mock_library.niRFSG_SetArbWaveformNextWritePosition.side_effect = MockFunctionCallError("niRFSG_SetArbWaveformNextWritePosition")
@@ -1081,3 +1079,5 @@ def set_side_effects_and_return_values(self, mock_library):
         mock_library.niRFSG_close.return_value = 0
         mock_library.niRFSG_reset.side_effect = MockFunctionCallError("niRFSG_reset")
         mock_library.niRFSG_reset.return_value = 0
+        mock_library.niRFSG_self_test.side_effect = MockFunctionCallError("niRFSG_self_test")
+        mock_library.niRFSG_self_test.return_value = 0

src/nirfsg/metadata/functions.py

@@ -3702,7 +3702,7 @@
         ],
         'returns': 'ViStatus'
     },
-    'SelfTest': {
+    'self_test': {
         'codegen_method': 'private',
         'documentation': {
             'description': '\nPerforms a self-test on the NI-RFSG device and returns the test results.\n\nThis function performs a simple series of tests to ensure that the NI-RFSG device is powered up and responding.\n\nThis function does not affect external I/O connections or connections between devices. Complete functional testing and calibration are not performed by this function. The NI-RFSG device must be in the Configuration state before you call this function.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Device Warm-Up <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/warmup.html>`_'