Read With Abort Endpoint

Requires: Base Development System

Reads the value from an Accumulator Tag channel, optionally clears the accumulator, and optionally signals the channel to abort. This endpoint is the same as the Read endpoint except that it has an abort input and an aborted? output. You can use the abort capability of the Accumulator Tag channel to close a channel abruptly, ignoring any data left in the channel buffer. You must use this endpoint together with the Write With Abort endpoint.

You can drop this endpoint on the block diagram by right-clicking an Accumulator Tag channel terminal or wire and selecting Create»Channel Reader»Accumulator Tag»Read With Abort.

Details  

	clear specifies whether to clear the accumulator or not. The default is TRUE.
	channel is the channel wire that connects this endpoint to a writer endpoint.
	average specifies whether to read the average of the elements from the channel or not. The default is FALSE.
	abort specifies whether to abort this channel. If abort is TRUE, this endpoint marks the channel as closed and ignores further calls to read. Meanwhile, the aborted? output returns TRUE on the next call of this endpoint.
	element returns the data that this endpoint reads from the channel if average is FALSE. If average is TRUE, this output returns the average of the data from the channel.
	count returns the number of times that the value of the channel has been updated since the last time the channel was cleared. This output returns its value even if the channel has aborted.
	aborted? returns TRUE if abort occurred on this endpoint or the writer endpoint connected to the channel. If aborted? is TRUE, further calls to this endpoint will do nothing except returning aborted? TRUE again.

Read With Abort Details

Related Information

Write With Abort