Btn55xxx_ReadPowerArray Function


Boonton55xxx IVI Driver Reference

Btn55xxx_ReadPowerArray Function
AutoMeasurements See Also

Returns an array of the current automatic amplitude measurements performed on a periodic pulse waveform. Measurements performed are: peak amplitude during the pulse, average amplitude over a full cycle of the pulse waveform, average amplitude during the pulse, IEEE top amplitude, IEEE bottom amplitude, and overshoot. Units are the same as the channel's units. Note the pulse overshoot is returned in dB for logarithmic channel units, and percent for all other units. Also, the pulse ?ON interval used for peak and average calculations is defined by the SENSe:PULSe:STARTGT and :ENDGT time gating settings. A full pulse (rise and fall) must be visible on the display to make average and peak pulse power measurements, and a full cycle of the waveform must be visible to calculate average cycle amplitude.

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

Visual C++

ViStatus Btn55xxx_ReadPowerArray(
ViSession Vi,
ViConstString Channel,
ViReal32* PulsePeak,
ViInt32* PulsePeakValid,
ViReal32* PulseCycleAvg,
ViInt32* PulseCycleAvgValid,
ViReal32* PulseOnAvg,
ViInt32* PulseOnValid,
ViReal32* IEEETop,
ViInt32* IEEETopValid,
ViReal32* IEEEBottom,
ViInt32* IEEEBottomValid,
ViReal32* Overshoot,
ViInt32* OvershootValid,
ViReal32* Droop,
ViInt32* DroopValid
);

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.

The IEEE-defined top line, i.e. the portion of a pulse waveform, which represents the second nominal state of a pulse.

The IEEE-define base line, i.e. The two portions of a pulse waveform which represent the first nominal state from which a pulse departs and to which it ultimately returns.

The difference between the distortion following a major transition and the IEEE top line in dB or percent,depending on the channel units.

Return Value

Requirements

Supported Models

Defined Values For Parameter PulsePeakValid

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 PulseCycleAvgValid

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 PulseOnValid

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 IEEETopValid

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 IEEEBottomValid

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 OvershootValid

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 DroopValid

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