Collector (Simulation Module)
Collects a signal at each time step of the simulation and returns a history of the signal value and the time at which this function recorded each value in the history. Details Example
| Dialog Box Options |
| Block Diagram Inputs |
| Block Diagram Outputs |
Dialog Box Options
| Parameter | Description |
|---|---|
| Polymorphic instance | Specifies whether this function is single-input single-output (SISO) or multiple-input multiple-output (MIMO). The default value is SISO. |
| Parameters | Lists all the parameters associated with this function. Select a parameter from this list to configure the parameter. When you select a parameter, the parameter and its associated Parameter source control appear in the Parameter Information section of the configuration dialog box. |
| Preview | Displays a graphical preview, if available, of the function output or configuration. |
| Parameter Information | Contains the parameters you can configure for this function. You must select a parameter from the Parameters list to make that parameter and its associated Parameter source control visible in the Parameter Information section of the configuration dialog box. |
| Parameter source | Specifies whether you configure this parameter using the Configuration Dialog Box or a Terminal on the simulation diagram. The default value is Configuration Dialog Box. If you select Terminal, LabVIEW displays an input for that parameter on the simulation diagram, and you can wire values to that input to configure this function programmatically. If you select Configuration Dialog Box, LabVIEW removes that input from the simulation diagram. You then must set the value for this parameter inside the configuration dialog box. |
| collector mode | Specifies when you want this function to return collected data. You can select from the following options:
|
| Decimation | Specifies the value the function uses to determine when to record a value. If you set the value of Decimation to 1, this function records a value every time step. If you set the value of Decimation to n, where n > 1, this function plots a value once every n time steps. The default value is 1. |
| History length | Specifies the time interval of the history to store, in seconds. If t is the current simulation time, this function stores the signal values for the time interval from t – History length to t. The default value is Inf, which stores the entire history. |
Block Diagram Inputs
| Parameter | Description |
|---|---|
| collector mode | Specifies when you want this function to return collected data. You can select from the following options:
|
| Decimation | Specifies the value the function uses to determine when to record a value. If you set the value of Decimation to 1, this function records a value every time step. If you set the value of Decimation to n, where n > 1, this function plots a value once every n time steps. The default value is 1. |
| History length | Specifies the time interval of the history to store, in seconds. If t is the current simulation time, this function stores the signal values for the time interval from t – History length to t. The default value is Inf, which stores the entire history. |
| Input Signal | Specifies the signal from which to collect a history. |
Block Diagram Outputs
| Parameter | Description |
|---|---|
| Signal History | Returns the history of the signal value and the time at which this function recorded each value in the history as a cluster of time-signal arrays. |
Collector Details
This function operates like an auto-indexing output tunnel of a While Loop or For Loop but ensures that the simulation data is correlated to the simulation time correctly.
Feedthrough Behavior
All input/output pairs of this function have direct feedthrough behavior.
Example
Refer to the collector VI in the labview\examples\simulation\Getting Started\Utilities directory for an example of using the Collector VI.