RT FIFO Write Function

Owning Palette: RT FIFO Functions

Requires: RT Module

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.

Details  

	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 (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.
	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. This output provides standard error out functionality.
	# elements returns the number of elements remaining in the RT FIFO after the read or write operation.

RT FIFO Write Details

Note  If you use a Real-Time FIFO to transfer waveform data, the variant element of the waveform does not transfer because variants are variable-sized and therefore incompatible with the Real-Time FIFO.