Waits to read data from a One Element Stream channel.

You can drop this endpoint on the block diagram by right-clicking a One Element Stream channel terminal or wire and selecting Create»Channel Reader»One Element Stream»Read.


icon

Inputs/Outputs

  • ci32.png timeout in ms (-1) —

    timeout in ms is the time, in milliseconds, that this endpoint has to read the elements from the channel. The default value is -1, which means there is no time limit.

  • cqueuern.png channel —

    channel is the channel wire that connects this endpoint to a writer endpoint.

  • ibool.png timed out? —

    timed out? returns TRUE if the amount of time specified by timeout in ms elapses before the endpoint reads the data specified in element from the channel. If timed out? is TRUE, element valid? and last element? will be FALSE.

  • ibool.png element valid? —

    element valid? returns TRUE if the element was read successfully. This output returns FALSE if a timeout occurs, if the channel closes without a valid last element, or if the channel aborts.

  • isgl.png element —

    element returns the data that this endpoint reads from the channel. This output returns the default value of the transmission data type if a timeout occurs, if the channel closes without a valid last element, or if the channel aborts.

  • ibool.png last element? —

    last element? returns whether this is the last element that the endpoint reads from the channel. last element? can be TRUE even if element valid? is FALSE, which means that the last element was already written to the channel during the previous iteration or the channel closes without a valid last element. This output returns FALSE if a timeout occurs or if the channel aborts.

    • Related Information

    Write

    FPGA Module Details

    The following details apply when you use this object in an FPGA VI.

    Note The following details are subject to change with each version of the LabVIEW FPGA Module.
    Single-Cycle Timed Loop Not supported.
    Usage

    For arrays, this endpoint supports only fixed-sized one-dimensional arrays of supported data types. This endpoint does not support variable-sized arrays even if the array resolves to a single size at compile time.

    This endpoint does not support LabVIEW classes.

    If you use this endpoint with the single-precision floating-point data type, refer to the following topics for resource use, latency, and single-cycle Timed Loop support implications.
    Notes A channel terminal of a non-reentrant subVI can be connected to only one channel. If a non-reentrant subVI is called from multiple locations, the channel wires connected to a given terminal must resolve to the same channel at compile time.

    Examples

    Refer to the following example files included with LabVIEW.

    • labview\examples\Channels\Basics\Channel Basics.lvproj
    • labview\examples\Channels\Replacing The Function At The Heart Of An Algorithm At Run Time\Replacing The Function At The Heart Of An Algorithm At Run Time.lvproj