collapse_allSyntax

Top  Previous  Next

 

Boonton55xxx IVI Driver Reference


 

Btn55xxx_ReadTimeArray Function


AutoMeasurements See Also



Returns an array of the current automatic timing measurements performed on a periodic pulse waveform. Measurements performed are: the frequency, period, width, offtime and duty cycle of the pulse waveform, and the risetime and falltime of the edge transitions. For each of the measurements to be performed, the appropriate items to be measured must within the trace window. Pulse frequency, period, offtime and duty cycle measurements require that an entire cycle of the pulse waveform (minimum of three edge transitions) be present. Pulse width measurement requires that at least one full pulse is visible, and is most accurate if the pulse width is at least 0.4 divisions. Risetime and falltime measurements require that the edge being measured is visible, and will be most accurate if the transition takes at least 0.1 divisions. It is always best to have the power meter set on the fastest timebase possible that meets the edge visibility restrictions. Set the trace averaging as high as practical to reduce fluctuations and noise in the pulse timing measurements. Note that the timing of the edge transitions is defined by the settings of the SENSe:PULSe:DISTal, :MESIal and :PROXimal settings; see the descriptions for those commands. Units are the same as the channel's units.

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

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_ReadTimeArray(
 ViSession Vi,
 ViConstString Channel,
 ViReal32Frequency,
 ViInt32FrequencyValid,
 ViReal32Period,
 ViInt32PeriodValid,
 ViReal32Width,
 ViInt32WidthValid,
 ViReal32Offtime,
 ViInt32OfftimeValid,
 ViReal32DutyCycle,
 ViInt32DutyCycleValid,
 ViReal32Risetime,
 ViInt32RisetimeValid,
 ViReal32Falltime,
 ViInt32FalltimeValid,
 ViReal32EdgeDelay,
 ViInt32EdgeDelayValid,
 ViReal32Skew,
 ViInt32SkewValid
);

Parameters

Vi

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.

Frequency

The number of cycles of a repetitive signal that take place in one second (Pulse Repetition Frequency).

FrequencyValid

Measurement condition code.

Period

The interval between two successive pulses. (Reciprocal of the Pulse Repetition Frequency).

PeriodValid

Measurement condition code.

Width

The interval between the first and second signal crossings of the mesial line.

WidthValid

Measurement condition code.

Offtime

The time a repetitive pulse is off. (Equal to the pulse period minus the pulsewidth).

OfftimeValid

Measurement condition code.

DutyCycle

The ratio of the pulse on-time to period.

DutyCycleValid

Measurement condition code.

Risetime

The interval between the first signal crossing of the proximal line to the first signal crossing of the distal line.

RisetimeValid

Measurement condition code.

Falltime

The interval between the last signal crossing of the distal line to the last signal crossing of the proximal line.

FalltimeValid

Measurement condition code.

EdgeDelay

Time offset from the trigger reference to the first mesial transition level of either slope on the waveform.

EdgeDelayValid

Measurement condition code.

Skew

The trigger offset between the assigned trigger channel and this channel.

SkewValid

Measurement condition code.

Return Value

 

Success or failure code.

collapse_allRequirements

Supported Models

All supported

collapse_allDefined Values For Parameter FrequencyValid

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

collapse_allDefined Values For Parameter PeriodValid

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

collapse_allDefined Values For Parameter WidthValid

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

collapse_allDefined Values For Parameter OfftimeValid

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

collapse_allDefined Values For Parameter DutyCycleValid

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

collapse_allDefined Values For Parameter RisetimeValid

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

collapse_allDefined Values For Parameter FalltimeValid

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

collapse_allDefined Values For Parameter EdgeDelayValid

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

collapse_allDefined Values For Parameter SkewValid

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

collapse_allSee Also

Reference

AutoMeasurements

Btn55xxx

Footer image

Copyright 2013-16 Boonton. All rights reserved.