Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

RT FIFO Write (RT Module)

LabVIEW Real-Time Module 8.2 Help
August 2006

NI Part Number:
370622D-01

»View Product Info

Writes an element to an RT FIFO. If the RT FIFO does not have empty elements, this function waits for an amount of time equal to the value of timeout in ms for an element to become available. If an empty element does not become available before the value of timeout is ms expires and the overwrite on timeout input is TRUE, this function overwrites the oldest element in the RT FIFO and returns TRUE in the timed out? output.

rt fifo is a reference to an existing RT FIFO.
element is the data to write to the RT FIFO. This data type changes to match the type of the value you want to write.
timeout in ms (0) specifies the amount of time to wait for an empty slot to write the data in the RT FIFO. The default is 0, which returns immediately. A value of -1 waits indefinitely.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
overwrite on timeout specifies whether to overwrite the oldest value in the RT FIFO if the FIFO does not have an available open slot and the value of the timeout in ms input expires. Use the timeout in ms input to specify an amount of time to wait for an open slot before overwriting the oldest value. If the value of the timeout in ms input expires and the overwrite on timeout input equals TRUE, the RT FIFO overwrites the oldest value and returns TRUE in the timed out? output.
rt fifo out is a reference to an existing RT FIFO.
timed out? returns TRUE if the timeout value has expired before an empty slot becomes available in the RT FIFO for the write operation.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
# elements returns the number of elements remaining in the RT FIFO after the read or write operation.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit