Table Of Contents

IviDigitizer Read Waveform Int8 (G Dataflow)

Version:
    Last Modified: October 24, 2017

    Initiates an acquisition on the channels that the end-user configures with the IviDigitizer Configure Channel Node. If the channel is not enabled for the acquisition, this node returns Channel Not Enabled error. It then waits for the acquisition to complete, and returns the waveform for the channel the end-user specifies. If the digitizer did not complete the acquisition within the time period the user specified with the Maximum Time parameter, the node returns the Max Time Exceeded error. Notes: (1) You call the IviDigitizer Fetch Waveform Node to obtain the waveforms for each of the remaining enabled channels without initiating another acquisition. After this node executes, each element in the Waveform Array parameter is an unscaled value directly from the digitizer's analog-to-digital converter (ADC). (2) If the Num Records property set for the acquisition is not equal to 1, then the Read Node shall return an error. You must use the IviDigitizer Initiate Acquisition Node and the IviDigitizer Fetch Multi Record Waveform nodes in this case. (3) The data type of the returned waveform array is ViInt8.

    connector_pane_image
    datatype_icon

    Initial X Time Seconds

    Specifies the seconds portion of the absolute time at which the first data point was acquired. Note that the actual time is the sum of Initial X Time Seconds and Initial X Time Fraction. The time is specified as the sum of two values because a single double-precision floating-point number does not have sufficient range and resolution to specify the time.

    datatype_icon

    Initial X Offset

    The time in relation to the Trigger Event of the first point in the waveform in seconds. Negative values mean that the first point in the waveform array was acquired before the trigger event.

    datatype_icon

    Initial X Time Fraction

    Specifies the fractional portion of the absolute time at which the first data point was acquired. Note that the actual time is the sum of Initial X Time Seconds and Initial X Time Fraction. The time is specified as the sum of two values because a single double-precision floating-point number does not have sufficient range and resolution to specify the time.

    datatype_icon

    Waveform Array

    Buffer into which the acquired waveform is stored. Notes: This array is always user allocated, and it must contain at least as many elements as the value you specify with the Number of Points parameter.

    datatype_icon

    Actual Points

    Indicates how many data points were actually retrieved from the instrument.

    datatype_icon

    First Valid Point

    Indicates the index of the first valid data point in the output Data array. This value will often be zero. However, some digitizer hardware designs transfer data most efficiently when the data is aligned with specific memory address boundaries. In those cases, the hardware may return a few invalid data points at the beginning of a record. This eliminates the need to shift the data during the transfer, ensuring maximum data transfer rates.

    datatype_icon

    X Increment

    The time between points in the acquired waveform in seconds.

    datatype_icon

    Scale Offset

    Scaling offset for the waveform data.

    datatype_icon

    Scale Factor

    Scaling factor for the waveform data.

    datatype_icon

    Waveform Array Size (256)

    Specifies the allocated size of the WaveformArray buffer, in number of data points. If this value is smaller than the total number of points to be retrieved, the driver will fill the waveform buffer as fully as possible and return the actual number of points retrieved in the Actual Points parameter. Default Value: 256

    datatype_icon

    Maximum Time (5000)

    Specifies the maximum time the end-user allows for this method to complete in milliseconds. Unit: millisecond Default Value: 5000

    datatype_icon

    Channel Name ("")

    Specifies the name of the channel from which to retrieve the data. Users who want to achieve interchangeability should use a virtual channel name. The virtual channel name should be sufficiently specific to the test system such that it is unlikely to conflict with a physical channel name. Default Value: "" Note: You can specify the trace name as a string variable or as a literal enclosed in double quotes.

    datatype_icon

    instrument handle out

    The instrument handle that you obtain from the IviDigitizer Initialize Node or IviDigitizer Initialize With Options Node. The handle identifies a particular instrument session.

    Default: None

    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    instrument handle

    The instrument handle that you obtain from the IviDigitizer Initialize Node or IviDigitizer Initialize With Options Node. The handle identifies a particular instrument session.

    Default: None

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported

    Web Server: Not supported in VIs that run in a web application


    Recently Viewed Topics