You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: generated/nirfsg/nirfsg/session.py
+5-4Lines changed: 5 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -4341,7 +4341,7 @@ class _SessionBase(object):
4341
4341
4342
4342
PXIe-5840/5841: RF blanking does not occur for frequencies below 120MHz.
4343
4343
4344
-
For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_reset.html>`_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call reset_with_options or `niRFSA_ResetWithOptions <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_resetwithoptions.html>`_. Select **Routes** in the **steps to omit** parameter.
4344
+
For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_reset.html>`_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call ResetWithOptions or `niRFSA_ResetWithOptions <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_resetwithoptions.html>`_. Select **Routes** in the **steps to omit** parameter.
4345
4345
4346
4346
**Default Value:** "" (empty string)
4347
4347
@@ -5194,7 +5194,7 @@ class _SessionBase(object):
5194
5194
| NIRFSG_VAL_MARKER0, NIRFSG_VAL_MARKER1, NIRFSG_VAL_MARKER2, or NIRFSG_VAL_MARKER3 | RFBlanking.ENABLE | Error is shown. |
Note: For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_reset.html>`_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call reset_with_options or `niRFSA_ResetWithOptions <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_resetwithoptions.html>`_. Select **Routes** in the **steps to omit** parameter.
5197
+
Note: For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_reset.html>`_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call ResetWithOptions or `niRFSA_ResetWithOptions <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_resetwithoptions.html>`_. Select **Routes** in the **steps to omit** parameter.
5198
5198
5199
5199
Note:
5200
5200
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
@@ -5285,7 +5285,7 @@ class _SessionBase(object):
5285
5285
5286
5286
Note: - When you download a waveform using ReadAndDownloadWaveformFromFileTdms method and if waveform_rf_blanking property is enabled, you must set the write_waveform_burst_detection property to WriteWaveformBurstDetection.DISABLE.
5287
5287
5288
-
- For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_reset.html>`_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call reset_with_options or `niRFSA_ResetWithOptions <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_resetwithoptions.html>`_. Select **Routes** in the **steps to omit** parameter.
5288
+
- For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_reset.html>`_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call ResetWithOptions or `niRFSA_ResetWithOptions <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/cvinirfsa_resetwithoptions.html>`_. Select **Routes** in the **steps to omit** parameter.
5289
5289
5290
5290
Note:
5291
5291
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
@@ -7975,7 +7975,7 @@ def reset(self):
7975
7975
7976
7976
Generally, calling this method instead of the reset_device method is acceptable. The reset method executes faster than the reset_device method.
7977
7977
7978
-
To avoid resetting routes on the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using the reset_with_options method, with **stepsToOmit** set to ResetWithOptionsStepsToOmit.ROUTES .
7978
+
To avoid resetting routes on the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using the ResetWithOptions method, with **stepsToOmit** set to ResetWithOptionsStepsToOmit.ROUTES .
Copy file name to clipboardExpand all lines: src/nirfsg/metadata/functions.py
-72Lines changed: 0 additions & 72 deletions
Original file line number
Diff line number
Diff line change
@@ -4134,78 +4134,6 @@
4134
4134
],
4135
4135
'returns': 'ViStatus'
4136
4136
},
4137
-
'ResetWithOptions': {
4138
-
'codegen_method': 'public',
4139
-
'documentation': {
4140
-
'description': ' \n Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes.\n\n By default, this function exhibits the same behavior as nirfsg_Reset. You can specify steps to omit using the steps to omit parameter. For example, if you specify NIRFSG_VAL_RESET_WITH_OPTIONS_ROUTES for the NIRFSG_ATTR_STEPS_TO_OMIT parameter, this function does not release signal routes during the reset process.\n\n When routes of signals between two devices are released, they are released regardless of which device created the route.\n\n To avoid resetting routes on PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using this function instead of nirfsg_Reset, with NIRFSG_ATTR_STEPS_TO_OMIT set to NIRFSG_VAL_RESET_WITH_OPTIONS_ROUTES.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Triggers <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/triggers.html>`_\n\n `Events <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/events.html>`_\n '
4141
-
},
4142
-
'included_in_proto': True,
4143
-
'method_templates': [
4144
-
{
4145
-
'documentation_filename': 'default_method',
4146
-
'library_interpreter_filename': 'default_method',
4147
-
'method_python_name_suffix': '',
4148
-
'session_filename': 'default_method'
4149
-
}
4150
-
],
4151
-
'parameters': [
4152
-
{
4153
-
'direction': 'in',
4154
-
'documentation': {
4155
-
'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_InitWithOptions function and identifies a particular instrument session.'
4156
-
},
4157
-
'name': 'vi',
4158
-
'type': 'ViSession',
4159
-
'use_array': False,
4160
-
'use_in_python_api': True
4161
-
},
4162
-
{
4163
-
'direction': 'in',
4164
-
'documentation': {
4165
-
'description': 'Specifies a list of steps to skip during the reset process. The default value is NIRFSG_VAL_RESET_WITH_OPTIONS_NONE, which specifies that no step is omitted during reset. **Defined Values** :',
4166
-
'note': 'NIRFSG_VAL_RESET_WITH_OPTIONS_ROUTES is not supported in external calibration or alignment sessions.',
4167
-
'table_body': [
4168
-
[
4169
-
'NIRFSG_VAL_RESET_WITH_OPTIONS_NONE',
4170
-
'0 (0x0)',
4171
-
'No step is omitted during reset.'
4172
-
],
4173
-
[
4174
-
'NIRFSG_VAL_RESET_WITH_OPTIONS_WAVEFORMS',
4175
-
'1 (0x1)',
4176
-
'Omits clearing waveforms.'
4177
-
],
4178
-
[
4179
-
'NIRFSG_VAL_RESET_WITH_OPTIONS_SCRIPTS',
4180
-
'2 (0x2)',
4181
-
'Omits clearing scripts.'
4182
-
],
4183
-
[
4184
-
'NIRFSG_VAL_RESET_WITH_OPTIONS_ROUTES',
4185
-
'4 (0x4)',
4186
-
'Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset.'
0 commit comments