Collect Numeric Array Function Block

»Table of Contents

LabVIEW 2009 Real-Time Module Help

Edition Date: June 2009

Part Number: 370622G-01

»View Product Info

Owning Palette: Accumulate & Collect Function Blocks

Requires: RT Module

Accumulates numeric input elements when enable is TRUE. The collected data array contains the collection of input elements. If collected data reaches the capacity you specify using the array size input, the function block discards additional input values until you clear the function block by setting the reset input to TRUE.

Dialog Box Options

Block Diagram Inputs

Block Diagram Outputs

Dialog Box Options

Parameter	Description
Inputs	Contains the following configuration options: Terminal name—Contains the name of the block diagram terminal to configure. Visible?—Specifies whether to display the terminal on the block diagram. Variable scope—Specifies the availability and scope of the variable associated with the terminal. Select Single-process to use a single-process shared variable. Select Network-published to use a network-published shared variable. Select No Variable if you do not want to use a terminal variable. To minimize overhead, include function block terminal variables only when necessary. If you change the Variable scope to No Variable after creating the function block instance, LabVIEW deletes the terminal variable. Data source—Specifies the data source of the input. Select Terminal to wire the input value to the terminal on the block diagram. Select Variable to supply the input value to the function block through the associated terminal variable, if available. Select Default value to use the Default value. The Variable data source option is not available if you select No Variable under Variable Scope. If you select Terminal as the data source and leave the block diagram terminal unwired, LabVIEW uses the Default value. Default value—Specifies the default value of the input. If you select Variable as the data source, LabVIEW uses this value as the initial value of the variable. If you select Default value as the data source, LabVIEW uses this value for every iteration of the function block.
Outputs	Contains the following configuration options: Terminal name—Contains the name of the block diagram terminal to configure. Visible?—Specifies whether to display the terminal on the block diagram. Variable scope—Specifies the availability and scope of the variable associated with the terminal. Select Single-process to use a single-process shared variable. Select Network-published to use a network-published shared variable. Select No Variable if you do not want to use a terminal variable. To minimize overhead, include function block terminal variables only when necessary. If you change the Variable scope to No Variable after creating the function block instance, LabVIEW deletes the terminal variable.

Parameter

Description

Inputs

Contains the following configuration options:

Terminal name—Contains the name of the block diagram terminal to configure.
Visible?—Specifies whether to display the terminal on the block diagram.
Variable scope—Specifies the availability and scope of the variable associated with the terminal. Select Single-process to use a single-process shared variable. Select Network-published to use a network-published shared variable. Select No Variable if you do not want to use a terminal variable. To minimize overhead, include function block terminal variables only when necessary. If you change the Variable scope to No Variable after creating the function block instance, LabVIEW deletes the terminal variable.
Data source—Specifies the data source of the input. Select Terminal to wire the input value to the terminal on the block diagram. Select Variable to supply the input value to the function block through the associated terminal variable, if available. Select Default value to use the Default value. The Variable data source option is not available if you select No Variable under Variable Scope. If you select Terminal as the data source and leave the block diagram terminal unwired, LabVIEW uses the Default value.
Default value—Specifies the default value of the input. If you select Variable as the data source, LabVIEW uses this value as the initial value of the variable. If you select Default value as the data source, LabVIEW uses this value for every iteration of the function block.

Outputs

Contains the following configuration options:

Terminal name—Contains the name of the block diagram terminal to configure.
Visible?—Specifies whether to display the terminal on the block diagram.
Variable scope—Specifies the availability and scope of the variable associated with the terminal. Select Single-process to use a single-process shared variable. Select Network-published to use a network-published shared variable. Select No Variable if you do not want to use a terminal variable. To minimize overhead, include function block terminal variables only when necessary. If you change the Variable scope to No Variable after creating the function block instance, LabVIEW deletes the terminal variable.

Block Diagram Inputs

Parameter	Description
error in (no error)	Describes error conditions that occur before this node runs.
reset	Clears all outputs and internal states of the function block.
array size	Specifies the size of the collected data array.
input	Specifies the input signal for the function block to process.
enable	Specifies whether to process input. If enable is TRUE (default), the function block updates output terminals based on the current input. If enable is FALSE, the function block does not process input.

Block Diagram Outputs

Parameter	Description
error out	Contains error information. This output provides standard error out functionality.
full	Indicates whether collected data has reached capacity by returning TRUE when points collected is greater than or equal to array size.
points collected	Returns the number of data values contained in collected data.
collected data	Returns the array that collects the input data values.