Collect Boolean Array Function Block

Owning Palette: Accumulate & Collect Function Blocks

Requires: Real-Time Module

Accumulates Boolean 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.

Use the array size input to specify the size of the array.

Dialog Box Options
Block Diagram Inputs
Block Diagram Outputs

Dialog Box Options

ParameterDescription
InputsContains 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.
OutputsContains 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

ParameterDescription
error inDescribes error conditions that occur before this node runs.
resetClears all outputs and internal states of the function block.
array sizeSpecifies the size of the collected data array.
inputSpecifies the data point to add to the collected data array.
enableSpecifies 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

ParameterDescription
error outContains error information. This output provides standard error out functionality.
fullIndicates whether collected data has reached capacity by returning TRUE when points collected is greater than or equal to array size. Returns FALSE otherwise.
points collectedReturns the number of data values contained in collected data.
collected datacollected data is the array that collects the input points.

WAS THIS ARTICLE HELPFUL?

Not Helpful