Merge branch 'users/vagupta/rfsg-documentation-update' of https://github.com/Vaishnavigupta1312/nimi-python into users/vagupta/rfsg-documentation-update

Author: Vaishnavigupta1312

CHANGELOG.md

@@ -66,6 +66,7 @@
         - `output_shorted`
       - Enum values:
         - `CONSTANT_RESISTANCE` and `CONSTANT_POWER` added to enum `OutputFunction`
+  - `nidcpower_constant_resistance_and_constant_power.py` and `nidcpower_sink_dc_current_into_electronic_load.py` examples
 - Changed
 - Removed
 

docs/nidcpower/examples.rst

@@ -12,6 +12,15 @@ nidcpower_advanced_sequence.py
    :encoding: utf8
    :caption: `(nidcpower_advanced_sequence.py) <https://github.com/ni/nimi-python/blob/master/src/nidcpower/examples/nidcpower_advanced_sequence.py>`_
 
+nidcpower_constant_resistance_and_constant_power.py
+---------------------------------------------------
+
+.. literalinclude:: ../../src/nidcpower/examples/nidcpower_constant_resistance_and_constant_power.py
+   :language: python
+   :linenos:
+   :encoding: utf8
+   :caption: `(nidcpower_constant_resistance_and_constant_power.py) <https://github.com/ni/nimi-python/blob/master/src/nidcpower/examples/nidcpower_constant_resistance_and_constant_power.py>`_
+
 nidcpower_lcr_source_ac_voltage.py
 ----------------------------------
 
@@ -30,6 +39,15 @@ nidcpower_measure_record.py
    :encoding: utf8
    :caption: `(nidcpower_measure_record.py) <https://github.com/ni/nimi-python/blob/master/src/nidcpower/examples/nidcpower_measure_record.py>`_
 
+nidcpower_sink_dc_current_into_electronic_load.py
+-------------------------------------------------
+
+.. literalinclude:: ../../src/nidcpower/examples/nidcpower_sink_dc_current_into_electronic_load.py
+   :language: python
+   :linenos:
+   :encoding: utf8
+   :caption: `(nidcpower_sink_dc_current_into_electronic_load.py) <https://github.com/ni/nimi-python/blob/master/src/nidcpower/examples/nidcpower_sink_dc_current_into_electronic_load.py>`_
+
 nidcpower_source_delay_measure.py
 ---------------------------------
 

docs/nirfsg/class.rst

@@ -947,7 +947,7 @@ LoopBandwidth
 
 
 
-        Uses the widest loop bandwidth setting for the PLL. Setting this property to :py:data:`~nirfsg.NIRFSG_VAL_WIDE` on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference.
+        Uses the widest loop bandwidth setting for the PLL.
 
 
 

docs/nirfsg/enums.rst

@@ -88,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
@@ -666,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:

generated/nirfsg/nirfsg/_library.py

@@ -652,6 +652,13 @@ def reset_with_defaults(self):  # noqa: N802
         errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False)
         return
 
+    def reset_with_options(self, steps_to_omit):  # noqa: N802
+        vi_ctype = _visatype.ViSession(self._vi)  # case S110
+        steps_to_omit_ctype = _visatype.ViUInt64(steps_to_omit.value)  # case S130
+        error_code = self._library.niRFSG_ResetWithOptions(vi_ctype, steps_to_omit_ctype)
+        errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False)
+        return
+
     def save_configurations_to_file(self, channel_name, file_path):  # noqa: N802
         vi_ctype = _visatype.ViSession(self._vi)  # case S110
         channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding))  # case C010

generated/nirfsg/nirfsg/_library_interpreter.py

@@ -405,7 +405,7 @@ class LoopBandwidth(Enum):
     '''
     WIDE = 2
     r'''
-    Uses the widest loop bandwidth setting for the PLL. Setting this property to NIRFSG_VAL_WIDE on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference.
+    Uses the widest loop bandwidth setting for the PLL.
     '''