This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

Check Box

Select parameter or variable value

  • Library:
  • Simulink / Dashboard

Description

The Check Box block allows you to set the value of a parameter or variable during simulation by checking or clearing the box. Use the Check Box block with other Dashboard blocks to create an interactive dashboard for your model.

Double-clicking the Check Box block does not open its dialog box during simulation and when the block is selected. To edit the block's parameters, you can use the Property Inspector, or you can right-click the block and select Block Parameters from the context menu.

Connecting Dashboard Blocks

Dashboard blocks do not use ports to make connections. To connect Dashboard blocks to variables and block parameters in your model, use connect mode. Connect mode facilitates the process of connecting Dashboard blocks in your model, especially when you want to connect multiple blocks at once. If you only want to connect a single Dashboard block, you can also use the Connection table in the block dialog box to make the connection.

Note

Dashboard blocks cannot connect to variables until you update your model diagram. To connect Dashboard blocks to variables or modify variable values between opening your model and running a simulation, update your model diagram using Ctrl+D.

To enter connect mode, click the Connect button that appears above your unconnected Dashboard block when you pause on it.

In connect mode, when you select one or more signals or blocks, a list of parameters and signals available for connection appears. Select a signal or parameter from the list to connect the selected Dashboard block. To connect another Dashboard block, pause on the block and click the Connect button above it. Then, make a selection of signals and blocks in your model, and choose a signal or parameter to connect.

When you finish connecting the Dashboard blocks in your model, click the Exit button in the upper-right of the canvas to exit connect mode.

Parameter Logging

Tunable parameters connected to Dashboard blocks are logged to the Simulation Data Inspector, where you can view parameter values along with logged signal data. You can access logged parameter data in the MATLAB® workspace by exporting the parameter data from the Simulation Data Inspector UI or by using the Simulink.sdi.exportRun function. For more information about exporting data with the Simulation Data Inspector UI, see Export Data from the Simulation Data Inspector. The parameter data is stored in a Simulink.SimulationData.Parameter object, accessible as an element in the exported Simulink.SimulationData.Dataset.

Limitations

  • Dashboard blocks can only connect to real scalar signals.

  • You cannot use the Connection table to connect a Dashboard block to a block that is commented out. When you connect a Dashboard block to a commented block using connect mode, the Dashboard block does not display the connected value until the you uncomment the block.

  • Dashboard blocks cannot connect to signals inside referenced models.

  • Parameters specified by indexing a variable array do not appear in the Connection table. For example, a block parameter defined as engine(1) using the variable engine does not appear in the table.

    To access the parameter in the Connection table, assign the indexed value to a scalar variable, such as engine_1. Then, use the scalar variable to define the block parameter.

  • When you simulate a model in external mode with the Default parameter behavior set to Inlined, Dashboard blocks can appear to change parameter and variable values. However, the change does not propagate to the simulation. For example, the Gain block displays changes made to its Gain parameter using the Dashboard blocks, but the Gain value used in the simulation does not change.

Parameters

expand all

Select the variable or block parameter to control using the Connection table. Populate the Connection table by selecting one or more blocks in your model. Select the radio button next to the variable or parameter you want to control, and click Apply.

Note

To see workspace variables in the connection table, update the model diagram using Ctrl+D.

Programmatic Use

To programmatically connect a Dashboard block to a tunable parameter or a variable, use a Simulink.HMI.ParamSourceInfo object. The Simulink.HMI.ParamSourceInfo object contains four properties. Some of the properties apply to connecting Dashboard blocks to parameters, and some apply to connecting Dashboard blocks to variables. Not all fields have a value for a connection because a given Dashboard block connects to either a parameter or a variable.

Block Parameter: Binding
Type: Simulink.HMI.ParamSourceInfo
Default: []

Label that appears next to the check box. You can use the Check Box Label to describe what happens in your model when you check the check box.

Example: Enable sound

Programmatic Use

Block Parameter: Label
Type: character vector
Default: 'Label'

Value to assign to the connected variable or parameter for the checked and unchecked block states.

  • Unchecked — Value assigned to the connected parameter when the Check Box block is not checked.

  • Checked — Value assigned to the connected parameter when the Check Box block is checked.

Programmatic Use

You set the Unchecked and Checked values programmatically using a 2-by-1 vector that contains the Unchecked and Checked values, in that order.

Block Parameter: Values
Type: 2x1 vector
Default: [0 1]

Position of the block label. When the block is connected to an element in the model, the label is the name of the connected element.

Programmatic Use

Block Parameter: LabelPosition
Type: character vector
Values: 'Top' | 'Bottom' | 'Hide'
Default: 'Top'

Block Characteristics

Data Types

double | integer | single

Direct Feedthrough

no

Multidimensional Signals

no

Variable-Size Signals

no

Zero-Crossing Detection

no

Introduced in R2017b