
Boonton55xxx IVI Driver Reference

Btn55xxx_ReadCWArray Function
AutoMeasurements See Also

Returns the current average, maximum, minimum powers or voltages and the peak-to-average ratio of the specified channel. Units are the same as the channel's units. Note the peak-to-average ratio and marker ratio are returned in dB for logarithmic channel units, and percent for all other channel units.

Function Tree Node: \Boonton55xxx\Instrument Specific\Channel\Measurements\AutoMeasurements\ReadCW Array

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_ReadCWArray(
ViSession Vi,
ViConstString Channel,
ViReal32* PeakAverage,
ViInt32* PeakAverageValid,
ViReal32* PeakMax,
ViInt32* PeakMaxValid,
ViReal32* PeakMin,
ViInt32* PeakMinValid,
ViReal32* PeakToAvgRatio,
ViInt32* PeakToAvgRatioValid
);

Parameters

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

Channel

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.

PeakAverage

Average power

PeakAverageValid

Measurement condition code.

PeakMax

Max CW power.

PeakMaxValid

Measurement condition code.

PeakMin

Minimum CW power.

PeakMinValid

Measurement condition code.

PeakToAvgRatio

Peak to average ratio.

PeakToAvgRatioValid

Measurement condition code.

Return Value

Success or failure code.

Remarks

Note that the values for maximum and minimum power will depend on the peak hold mode; see the description of the CALCulate:PKHLD command for details.

Instrument Command

READ{Channel}:ARRay:CW:POWer?

Requirements

Supported Models

All supported

Defined Values For Parameter PeakAverageValid

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.

Top

Defined Values For Parameter PeakMaxValid

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.

Top

Defined Values For Parameter PeakMinValid

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.

Top

Defined Values For Parameter PeakToAvgRatioValid

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.

Top

Syntax

Parameters

Return Value

Remarks

Instrument Command

Requirements

Supported Models

Defined Values For Parameter PeakAverageValid

Defined Values For Parameter PeakMaxValid

Defined Values For Parameter PeakMinValid

Defined Values For Parameter PeakToAvgRatioValid

See Also

Reference