IviPwrMeter_IsMeasurementComplete
IviPwrMeterBase Capability Group
C Function Prototype
ViStatus IviPwrMeter_IsMeasurementComplete (ViSession vi, ViInt32* measurementStatus);
Purpose
This function queries the instrument to determine the status of the measurement initiated by the IviPwrMeter_Initiate function. This function returns the IVIPWRMETER_VAL_MEAS_COMPLETE (1) value in the Status parameter only when measurements are complete on all enabled channels.
If some measurements are still in progress on one or more channels, the driver returns the IVIPWRMETER_VAL_MEAS_IN_PROGRESS (0) value. If the driver cannot query the instrument to determine its state, the driver returns the IVIPWRMETER_VAL_MEAS_STATUS_UNKNOWN (-1) value.
Note:
This function does not check the instrument status. Typically, you call this function only in a sequence of calls to other low-level driver functions. The sequence performs one operation. You use the low-level functions to optimize one or more aspects of interaction with the instrument. If you want to check the instrument status, call the IviPwrMeter_error_query function at the conclusion of the sequence.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from the IviPwrMeter_init or IviPwrMeter_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| measurementStatus | ViInt32 | Returns the status of the measurement.
This driver defines the following measurement status: IVIPWRMETER_VAL_MEAS_COMPLETE (1) - The power meter has completed the measurement on all enabled channels. IVIPWRMETER_VAL_MEAS_IN_PROGRESS (0) - The power meter is still taking a measurement on one or more enabled channels. IVIPWRMETER_VAL_MEAS_STATUS_UNKNOWN (-1) - The power meter cannot determine the status of the measurement. |