Main Content

addParameter

Class: Simulink.Mask
Namespace: Simulink

Add a parameter to a mask

expand all in page

Syntax

maskobj.addParameter(Name,Value)

Description

maskobj.addParameter(Name,Value) appends a parameter to the mask. If you do not specify any name-value arguments, the software generates name for the mask parameter with the control type set to edit.

To get the mask object for a block named blockName, use this command.

maskObj = Simulink.Mask.get('BlockName')

Input Arguments

expand all

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: p.addParameter('Type','popup',...'TypeOptions',{'Red' 'Blue' 'Green'},'Evaluate','off');

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Type of parameter, specified as character vector.

Data Types: char | string

The options that are displayed within a popup or combobox or listbox parameter, specified as a cell array.

Data Types: cell

The name of the mask parameter, specified as a character vector. This name is assigned to the mask workspace variable created for this parameter.

Data Types: char | string

Display name for the mask parameter, specified as a character vector. This name appears as the label associated with the parameter on the mask dialog.

Data Types: char | string

The default value of the mask parameter in the Mask Parameters dialog. Type specific, depends on the Type of the parameter, specified as a character vector.

Data Types: char | string

Option to evaluate mask parameter, specified as a logical.

Data Types: char

Option to change the mask parameter during simulation, specified as character vector or string. The available options are:

  • off - you cannot change mask parameter values during simulation in this mode.

  • on - you can change the mask parameter value during simulation. Each time you make a change the model is compiled.

  • run-to-run - If the mask parameter is set to run-to-run in Fast Restart mode, the value can be changed between runs. The model is not recompiled to reflect the value in simulation results.

Data Types: char

Option to save the mask parameter value in the model file, specified as a logical.

Data Types: char

Option to edit the mask parameter in the mask dialog, specified as a logical.

Data Types: char

Option to hide the mask parameter in the mask dialog, specified as a logical.

Data Types: char

Option to enable the mask parameter in the mask dialog, specified as a logical.

Data Types: char

Option to show the mask parameter in the mask dialog, specified as a logical.

Data Types: char

Callback code for the mask parameter, specified as a character vector. The callback code executes when a user changes the parameter value in the mask dialog box.

Data Types: char

Option to enable tooltips for the mask parameter, specified as a logical value.

Data Types: char

Alternative name for the mask parameter is specified as character vector.

Data Types: char | string

Layout options for the parameter in the mask dialog, specified as a character vector or logical value. The location of the parameter in the mask dialog such as the row location, prompt location is specified. Additionally horizontal stretch or shrink of the mask parameter is also specified.

Data Types: object

Examples

expand all

Open Live Script

Step 1: Get mask as an object using a masked block’s path.

new_system('paramexample');
add_block('built-in/subsystem','paramexample/subsystem');
save_system;
open_system('paramexample');
p= Simulink.Mask.create(gcb);

Step 2: Add a parameter to the mask without specifying name–value pairs for parameter attributes.

p.addParameter;

Step 3: Add a mask parameter of type popup that cannot be evaluated.

p.addParameter('Type','popup','TypeOptions',{'Red' 'Blue' 'Green'},'Evaluate','off');
save_system;

Version History

Introduced in R2014a

See Also

Topics