Btn55xxx_FetchMeasurementArray Function


Boonton55xxx IVI Driver Reference

Btn55xxx_FetchMeasurementArray Function
StatisticalMode See Also

Returns an array of the current automatic statistical measurements performed on a sample population. Measurements performed are: long term average, peak and minimum amplitude, peak-to-average ratio, amplitude at the CCDF percent cursor, statistical percent at the CCDF power cursor, and the sample population size in samples. Note the peak-to-average ratio is returned in dB for logarithmic channel units, and percent for all other channel units.

Function Tree Node: \Boonton55xxx\Instrument Specific\Channel\StatisticalMode\Fetch Measurement Array

Visual C++

ViStatus Btn55xxx_FetchMeasurementArray(
ViSession Vi,
ViConstString Channel,
ViReal64* Pavg,
ViInt32* PavgCond,
ViReal64* Ppeak,
ViInt32* PpeakCond,
ViReal64* Pmin,
ViInt32* PminCond,
ViReal64* PkToAvgRatio,
ViInt32* PkToAvgRatioCond,
ViReal64* CursorPwr,
ViInt32* CursorPwrCond,
ViReal64* CursorPct,
ViInt32* CursorPctCond,
ViReal64* SampleCount,
ViInt32* SampleCountCond,
ViReal64* SecondsRun,
ViInt32* SecondsRunCond
);

Parameters

The ViSession handle that you obtain from the IviDriver_init or IviDriver_InitWithOptions function. The handle identifies a particular instrument session.

The physical or virtual repeated capability identifier. Pass VI_NULL or empty string if operation does not apply to a repeated capability.For valid values, see the Channel repeated capability.

Return Value

Instrument Command

Requirements

Supported Models

Defined Values For Parameter PavgCond

Name	Description
BTN55XXX_VAL_COND_CODE_MEASUREMENT_STOPPED	-1 Measurement is STOPPED. Value returned is not updated.
BTN55XXX_VAL_COND_CODE_ERROR	Error return. Measurement is not valid.
BTN55XXX_VAL_COND_CODE_UNDERRANGE	An Under-range condition exists.
BTN55XXX_VAL_COND_CODE_OVERRANGE	An Over-range condition exists.
BTN55XXX_VAL_COND_CODE_NORMAL	1 Normal return. No error.

Defined Values For Parameter PpeakCond

Name	Description
BTN55XXX_VAL_COND_CODE_MEASUREMENT_STOPPED	-1 Measurement is STOPPED. Value returned is not updated.
BTN55XXX_VAL_COND_CODE_ERROR	Error return. Measurement is not valid.
BTN55XXX_VAL_COND_CODE_UNDERRANGE	An Under-range condition exists.
BTN55XXX_VAL_COND_CODE_OVERRANGE	An Over-range condition exists.
BTN55XXX_VAL_COND_CODE_NORMAL	1 Normal return. No error.

Defined Values For Parameter PminCond

Name	Description
BTN55XXX_VAL_COND_CODE_MEASUREMENT_STOPPED	-1 Measurement is STOPPED. Value returned is not updated.
BTN55XXX_VAL_COND_CODE_ERROR	Error return. Measurement is not valid.
BTN55XXX_VAL_COND_CODE_UNDERRANGE	An Under-range condition exists.
BTN55XXX_VAL_COND_CODE_OVERRANGE	An Over-range condition exists.
BTN55XXX_VAL_COND_CODE_NORMAL	1 Normal return. No error.

Defined Values For Parameter PkToAvgRatioCond

Name	Description
BTN55XXX_VAL_COND_CODE_MEASUREMENT_STOPPED	-1 Measurement is STOPPED. Value returned is not updated.
BTN55XXX_VAL_COND_CODE_ERROR	Error return. Measurement is not valid.
BTN55XXX_VAL_COND_CODE_UNDERRANGE	An Under-range condition exists.
BTN55XXX_VAL_COND_CODE_OVERRANGE	An Over-range condition exists.
BTN55XXX_VAL_COND_CODE_NORMAL	1 Normal return. No error.

Defined Values For Parameter CursorPwrCond

Name	Description
BTN55XXX_VAL_COND_CODE_MEASUREMENT_STOPPED	-1 Measurement is STOPPED. Value returned is not updated.
BTN55XXX_VAL_COND_CODE_ERROR	Error return. Measurement is not valid.
BTN55XXX_VAL_COND_CODE_UNDERRANGE	An Under-range condition exists.
BTN55XXX_VAL_COND_CODE_OVERRANGE	An Over-range condition exists.
BTN55XXX_VAL_COND_CODE_NORMAL	1 Normal return. No error.

Defined Values For Parameter CursorPctCond

Name	Description
BTN55XXX_VAL_COND_CODE_MEASUREMENT_STOPPED	-1 Measurement is STOPPED. Value returned is not updated.
BTN55XXX_VAL_COND_CODE_ERROR	Error return. Measurement is not valid.
BTN55XXX_VAL_COND_CODE_UNDERRANGE	An Under-range condition exists.
BTN55XXX_VAL_COND_CODE_OVERRANGE	An Over-range condition exists.
BTN55XXX_VAL_COND_CODE_NORMAL	1 Normal return. No error.

Defined Values For Parameter SampleCountCond

Name	Description
BTN55XXX_VAL_COND_CODE_MEASUREMENT_STOPPED	-1 Measurement is STOPPED. Value returned is not updated.
BTN55XXX_VAL_COND_CODE_ERROR	Error return. Measurement is not valid.
BTN55XXX_VAL_COND_CODE_UNDERRANGE	An Under-range condition exists.
BTN55XXX_VAL_COND_CODE_OVERRANGE	An Over-range condition exists.
BTN55XXX_VAL_COND_CODE_NORMAL	1 Normal return. No error.

Defined Values For Parameter SecondsRunCond

Name	Description
BTN55XXX_VAL_COND_CODE_MEASUREMENT_STOPPED	-1 Measurement is STOPPED. Value returned is not updated.
BTN55XXX_VAL_COND_CODE_ERROR	Error return. Measurement is not valid.
BTN55XXX_VAL_COND_CODE_UNDERRANGE	An Under-range condition exists.
BTN55XXX_VAL_COND_CODE_OVERRANGE	An Over-range condition exists.
BTN55XXX_VAL_COND_CODE_NORMAL	1 Normal return. No error.

Syntax