User manual

Part 2: Automation Programming Reference
Result Interfaces
Tip: The sample scripts for exposing results that are referred to in this section are installed with
XStreamDSO v.8.5.x.x. and later.
"Out.Result" properties are results of the last completed acquisition. They are not affected if other controls
are changed after that acquisition was completed. This distinction between "Out.Result" properties and
other controls is most important when the trigger mode is Single or Stopped. Treat "Out.Result" properties
as read-only.
Note: Although you can write the properties of a result, it is not advisable, as the result properties
and data will be updated on next acquisition.
Caution: It is highly recommended that you STOP acquisitions before accessing result data. Most
remote control problems are caused by failure to follow this practice.
Several of the Out.Result properties mention the "frame": this is the term used to describe the visible
portion of the trace, which is generally smaller than the acquired waveform. The frame could be used, for
example, to display a 500 pt window onto a 1 Mpt trace, or show the center 10 mV of a 100 mV trace.
Several properties, most significantly the DataArray object, are Variants containing either a one- or two-
dimensional array. Dimension the target variable as a Variant type, and assign the DataArray property to it.
See DataArray for examples of its use within each of the Result interfaces.
Result Interface Types
Result Interface type designations are as follows:
Type Definition
Digital Digital (bi-state) waveform generated by mixed-signal oscilloscope.
Histogram Histogram trace.
Param Individual results and result arrays for measurement parameters and Pass/Fail test qualifiers.
Persist Eye diagrams or other waveshapes that are the result of overlaying multiple waveforms.
Table Tabular results primarily used in conjunction with the various low-speed serial decoding options.
Waveform Basic Voltage vs. Time waveforms.
XY XY waveforms.
Digital
The Digital interface is found when using a mixed-signal input to generate digital (bi-state) waveforms.
These waveforms are contained in the Digitaln trace name, where x = 1, 2, 3 etc. Each Digitaln trace is a
bus that may contain multiple digital lines, with a maximum number dependent on the capabilities of the
mixed-signal oscilloscope option. The key property in the Digital interface is the DataArray, which is a 2D
array containing the value of each sample of each digital line in the bus.
2-27