IviACPwr_FetchMeasurement
- Updated2023-02-24
- 2 minute(s) read
ViStatus IviACPwr_FetchMeasurement (ViSession instrumentHandle, ViChar phaseName[], ViInt32 measurementType, ViReal64 *measurement);
Purpose
This function
Parameters
| Input | ||
| Name | Type | Description |
|---|---|---|
| instrumentHandle | ViSession | The ViSession handle that you obtain from the IviACPwr_init or IviACPwr_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| phaseName | ViChar[] | Specifies the name of the output phase for which to return the measurement. Pass the virtual output phase name that you assign to the instrument in the IVI Configuration utility. Virtual output phase names are aliases for instrument-specific output phase strings, which can differ from one instrument to another. With virtual output phase names, you can use and swap instruments without having to change the output phase names in your source code. Assign a virtual output phase name to an instrument-specific output phase through the IVI Configuration utility. This parameter accepts virtual output phase names you have assigned to the specific instrument you are using and also accepts the instrument-specific output phase names. Default Value: "" Note: You can specify the output phase name as a string variable or as a literal enclosed in double quotes. |
| measurementType | ViInt32 | Specifies the type of measurement to return. Valid Values: Base Group: Voltage RMS L-N - IVIACPWR_VAL_MEASURE_VOLTAGE_RMS_LN Voltage RMS line to neutral is measured. Current RMS - IVIACPWR_VAL_MEASURE_CURRENT_RMS Current RMS is measured. Frequency - IVIACPWR_VAL_MEASURE_FREQUENCY Frequency is measured. Voltage DC - IVIACPWR_VAL_MEASURE_VOLTAGE_DC Voltage level is measured when in DC Only Mode. Current DC - IVIACPWR_VAL_MEASURE_CURRENT_DC Current level is measured when in DC Only Mode. Power Factor - IVIACPWR_VAL_MEASURE_POWER_FACTOR Power Factor is measured. Crest Factor - IVIACPWR_VAL_MEASURE_CREST_FACTOR Crest Factor is measured. Current Peak - IVIACPWR_VAL_MEASURE_CURRENT_PEAK Peak Current is measured. Power VA - IVIACPWR_VAL_MEASURE_POWER_VA Power is measured in Volts-Amps. Real Power - IVIACPWR_VAL_MEASURE_POWER_REAL Real Power is measured in Watts. Power DC - IVIACPWR_VAL_MEASURE_POWER_DC Power is measured in Watts when in DC Only Mode. Phase Angle - IVIACPWR_VAL_MEASURE_PHASE_ANGLE Phase Angle is measured in Degrees. Voltage RMS L-L - IVIACPWR_VAL_MEASURE_VOLTAGE_RMS_LL Voltage RMS (line-to-line) is measured. Distortion Group: Current OHD - IVIACPWR_VAL_MEASURE_CURRENT_OHD Current Odd Harmonics Distortion is measured. Current EHD - IVIACPWR_VAL_MEASURE_CURRENT_EHD Current Even Harmonics Distortion is measured. Current THD - IVIACPWR_VAL_MEASURE_CURRENT_THD Current Total (Odd+Even) Harmonic Distortion is measured. Voltage OHD - IVIACPWR_VAL_MEASURE_VOLTAGE_OHD Voltage Odd Harmonics Distortion is measured. Voltage EHD - IVIACPWR_VAL_MEASURE_VOLTAGE_EHD Voltage Even Harmonics Distortion is measured. Voltage THD - IVIACPWR_VAL_MEASURE_VOLTAGE_THD Voltage Total (Odd+Even) Harmonic Distortion is measured. Default Value: Frequency - IVIACPWR_VAL_MEASURE_FREQUENCY |
| Output | ||
| Name | Type | Description |
| measurement | ViReal64 | Returns the measured value. |