Admin Production ni-theme
Current Publication

Fetch Waveform

IVI Compliance Package

IviScope Fetch Waveform

IviScope Base Capability Group

This VI returns the waveform the oscilloscope acquires for the channel you specify. The waveform is from an acquisition that you initiate prior to calling this VI.

You use the IviScope Initiate Acquisition VI to start an acquisition on the channels that you enable with the IviScope Configure Channel VI. The oscilloscope acquires waveforms for the enabled channels concurrently. You use the IviScope Acquisition Status VI to determine when the acquisition is complete. You must call this VI separately for each enabled channel to obtain the waveforms.

You can call the IviScope Read Waveform VI instead of the IviScope Initiate Acquisition VI. The IviScope Read Waveform VI starts an acquisition on all enabled channels, waits for the acquisition to complete, and returns the waveform for the channel you specify. You call this VI to obtain the waveform for each of the remaining channels.

Notes
  1. After this VI executes, each element in the Waveform Array parameter is either a voltage or a value indicating that the oscilloscope could not sample a voltage.
  2. You configure the interpolation method the oscilloscope uses with the IviScope Configure Interpolation [I] VI. If you disable interpolation, the oscilloscope does not interpolate points in the waveform. If the oscilloscope cannot sample a value for a point in the waveform, the driver sets the corresponding element in the Waveform Array to an IEEE-defined NaN (Not a Number) value and the VI returns IVISCOPE_WARN_INVALID_WFM_ELEMENT.
  3. You can test a waveform value for an invalid value condition by calling the IviScope Is Invalid Waveform Element VI.
  4. This VI does not check the instrument status. Typically, you call this VI only in a sequence of calls to other low-level driver VIs. The sequence performs one operation. You use the low-level VIs to optimize one or more aspects of interaction with the instrument. If you want to check the instrument status, call the IviScope Error-Query VI at the conclusion of the sequence.
  5. The class driver returns a simulated waveform when this VI is called and the IviScope Simulate property is set to TRUE and the IviScope Use Specific Simulation property is set to FALSE. For information on how to configure a simulated waveform, refer to IviScope Simulator Setup Dialog Box.
instrument handle The instrument handle that you obtain from the IviScope Initialize or the IviScope Initialize With Options VI.
channel name Pass the virtual channel name that you assign to the instrument in MAX from which you want to fetch a waveform.

Virtual channel names are aliases for instrument specific channel strings. The instrument specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument specific channel through MAX. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument specific channel names.

Default Value: "CHANNEL1"

waveform size Pass the number of elements in the Waveform Array parameter.
error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

instrument handle out The instrument handle that you obtain from the IviScope Initialize or the IviScope Initialize With Options VI.
waveform array Returns the waveform that the oscilloscope acquires.

Units: volts

Notes
  1. You configure the interpolation method the oscilloscope uses with the IviScope Is Invalid Waveform Element VI. If you disable interpolation, the oscilloscope does not interpolate points in the waveform. If the oscilloscope cannot sample a value for a point in the waveform, the driver sets the corresponding element in the Waveform Array to an IEEE defined NaN (Not a Number) value and the VI returns IVISCOPE_WARN_INVALID_WFM_ELEMENT.
  2. You can test a waveform value for an invalid value condition by calling the IviScope Is Invalid Waveform Element VI.
actual points Indicates the number of points the VI places in the Waveform Array parameter.
initial x Indicates the time of the first point in the Waveform Array. The time is relative to the trigger event. For example, if the oscilloscope acquires the first point in the Waveform Array 1 second before the trigger, this parameter returns the value –1.0. If the acquisition of the first point occurs at the same time as the trigger, this parameter returns the value 0.0.

Units: seconds

x increment Indicates the length of time between points in the Waveform Array.

Units: seconds

error out The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.