RFmxNRMXList Class
- Updated2025-04-08
- 2 minute(s) read
Defines a root class which is used to identify and control NR list.
Derives from
- IList
- IDisposable
Syntax
Namespace: NationalInstruments.RFmx.NRMX
public class RFmxNRMXList : IList, IDisposable
Properties
| Name | Description |
|---|---|
| IsDisposed | Gets a value that indicates whether the list has been disposed. |
| ListName | Gets the list name. |
| ListType | Gets the Type object for RFmxNRMXList. |
Methods
| Name | Description |
|---|---|
| AbortMeasurements(string) | Stops acquisition and measurements associated with list instance that you specify in the selectorString parameter, which were previously initiated by the Initiate(string, string) method or measurement read methods. Calling this method is optional, unless you want to stop a measurement before it is complete. This method executes even if there is an incoming error. |
| CheckMeasurementStatus(string, out bool) | Checks the status of the measurement. Use this method to check for any errors that may occur during measurement or to check whether the measurement is complete and results are available. |
| ClearAllNamedResults(string) | Clears all results for the current list instance. |
| ClearNamedResult(string) | Clears a result instance specified by the result name in the selectorString parameter. |
| Commit(string) | Commits settings to the hardware. Calling this method is optional. RFmxNR commits settings to the hardware when you call the Initiate(string, string) method. |
| CreateListStep() | Creates a new list step instance in a list. |
| DeleteList() | Deletes an instance of a list. |
| Dispose() | Deletes the list and clears any trace of the current list, if any. |
| GetListStep(int) | Returns a list step instance in a list. |
| GetListStepAll() | Returns all list step instances in a list. |
| GetListStepRange(int, int) | Returns a range of list step instances in a list. |
| GetNumberOfSteps(string, out int) | Returns number of list step instances in a list. |
| Initiate(string, string) | Initiates all enabled measurements. Call this method after configuring the list and measurement. This method asynchronously launches measurements in the background and immediately returns to the caller program. You can fetch measurement results using the Fetch methods or result methods in the method node. To get the status of measurements, use the WaitForMeasurementComplete(string, double) method or CheckMeasurementStatus(string, out bool) method. |
| ResetToDefault(string) | Resets a list to the default values. |
| SetNumberOfSteps(string, int) | Sets number of list step instances in a list. |
| WaitForMeasurementComplete(string, double) | Waits for the specified number for seconds for all the measurements to complete. |