- •Block Reference
- •Commonly Used
- •Continuous
- •Discontinuities
- •Discrete
- •Logic and Bit Operations
- •Lookup Tables
- •Math Operations
- •Model Verification
- •Model-Wide Utilities
- •Ports & Subsystems
- •Signal Attributes
- •Signal Routing
- •Sinks
- •Sources
- •User-Defined Functions
- •Additional Math & Discrete
- •Additional Discrete
- •Additional Math: Increment — Decrement
- •Run on Target Hardware
- •Target for Use with Arduino Hardware
- •Target for Use with BeagleBoard Hardware
- •Target for Use with LEGO MINDSTORMS NXT Hardware
- •Blocks — Alphabetical List
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Settings Pane
- •Measurements Pane
- •Signal Statistics Measurements
- •Settings Pane
- •Transitions Pane
- •Overshoots/Undershoots
- •Cycles
- •Settings Pane
- •Peaks Pane
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Command-Line Information
- •Function Reference
- •Model Construction
- •Simulation
- •Linearization and Trimming
- •Data Type
- •Examples
- •Main Toolbar
- •Command-Line Alternative
- •Command-Line Alternative
- •Command-Line Alternative
- •Command-Line Alternative
- •Command-Line Alternative
- •Command-Line Alternative
- •Mask Icon Drawing Commands
- •Simulink Classes
- •Model Parameters
- •About Model Parameters
- •Examples of Setting Model Parameters
- •Common Block Parameters
- •About Common Block Parameters
- •Examples of Setting Block Parameters
- •Block-Specific Parameters
- •Mask Parameters
- •About Mask Parameters
- •Notes on Mask Parameter Storage
- •Simulink Identifier
- •Simulink Identifier
- •Model Advisor Checks
- •Simulink Checks
- •Simulink Check Overview
- •See Also
- •Identify unconnected lines, input ports, and output ports
- •Description
- •Results and Recommended Actions
- •Capabilities and Limitations
- •Tips
- •See Also
- •Check root model Inport block specifications
- •Description
- •Results and Recommended Actions
- •See Also
- •Check optimization settings
- •Description
- •Results and Recommended Actions
- •Tips
- •See Also
- •Description
- •Results and Recommended Actions
- •See Also
- •Check for implicit signal resolution
- •Description
- •Results and Recommended Actions
- •See Also
- •Check for optimal bus virtuality
- •Description
- •Results and Recommended Actions
- •Capabilities and Limitations
- •See Also
- •Description
- •Results and Recommended Actions
- •Capabilities and Limitations
- •See Also
- •Identify disabled library links
- •Description
- •Results and Recommended Actions
- •Capabilities and Limitations
- •Tips
- •See Also
- •Identify parameterized library links
- •Description
- •Results and Recommended Actions
- •Capabilities and Limitations
- •Tips
- •See Also
- •Identify unresolved library links
- •Description
- •Results and Recommended Actions
- •Capabilities and Limitations
- •See Also
- •Results and Recommended Actions
- •Capabilities and Limitations
- •See Also
- •Results and Recommended Actions
- •Capabilities and Limitations
- •See Also
- •Check usage of function-call connections
- •Description
- •Results and Recommended Actions
- •See Also
- •Check signal logging save format
- •Description
- •Results and Recommended Actions
- •See Also
- •Description
- •Results and Recommended Actions
- •See Also
- •Description
- •Results and Recommended Actions
- •Tips
- •See Also
- •Check data store block sample times for modeling errors
- •Description
- •Results and Recommended Actions
- •See Also
- •Check for potential ordering issues involving data store access
- •Description
- •Results and Recommended Actions
- •Tips
- •See Also
- •Check for partial structure parameter usage with bus signals
- •Description
- •Results and Recommended Actions
- •Tips
- •See Also
- •Check for calls to slDataTypeAndScale
- •Description
- •Results and Recommended Actions
- •Tips
- •See Also
- •Check for proper bus usage
- •Description
- •Results and Recommended Actions
- •Action Results
- •Tips
- •See Also
- •Description
- •Results and Recommended Actions
- •See Also
- •Description
- •Results and Recommended Actions
- •See Also
- •Check for proper Merge block usage
- •Description
- •Input Parameters
- •Results and Recommended Actions
- •See Also
- •Description
- •Results and Recommended Actions
- •Action Results
- •See Also
- •Check for non-continuous signals driving derivative ports
- •Description
- •Results and Recommended Actions
- •See Also
- •Runtime diagnostics for S-functions
- •Description
- •Results and Recommended Actions
- •See Also
- •Check file for foreign characters
- •Description
- •Results and Recommended Actions
- •Tips
- •See Also
- •Check model for known block upgrade issues
- •Description
- •Results and Recommended Actions
- •Action Results
- •See Also
- •Description
- •Results and Recommended Actions
- •Action Results
- •See Also
- •Check that the model is saved in SLX format
- •Description
- •Results and Recommended Actions
- •Tips
- •See Also
- •Check Model History properties
- •Description
- •Results and Recommended Actions
- •See Also
- •Analyze model hierarchy for upgrade issues
- •Description
- •Results and Recommended Actions
- •Tips
- •See Also
- •Description
- •Results and Recommended Actions
- •See Also
- •Simulink Performance Advisor Checks
- •Simulink Performance Advisor Check Overview
- •See Also
- •Baseline
- •See Also
- •Check Preupdate Items
- •See Also
- •Checks that need Update Diagram
- •See Also
- •Checks that require simulation to run
- •See Also
- •Check Accelerator Settings
- •See Also
- •Create Baseline
- •See Also
- •Identify resource intensive diagnostic settings
- •See Also
- •Check optimization settings
- •See Also
- •Identify inefficient lookup table blocks
- •See Also
- •Identify Interpreted MATLAB Function blocks
- •See Also
- •Check MATLAB Function block debug settings
- •See Also
- •Check Stateflow block debug settings
- •See Also
- •Identify simulation target settings
- •See Also
- •Check model reference rebuild setting
- •See Also
- •Check Model Reference parallel build
- •See Also
- •Check solver type selection
- •See Also
- •Select normal or accelerator simulation mode
- •See Also
- •Simulink Limits
- •Maximum Size Limits of Simulink Models
- •Index
- •Filter Structures and Filter Coefficients
- •Valid Initial States
- •Number of Delay Elements (Filter States)
- •Frame-Based Processing
- •Sample-Based Processing
- •Valid Initial States
- •Frame-Based Processing
- •Sample-Based Processing
- •Model Parameters in Alphabetical Order
- •Common Block Parameters
- •Continuous Library Block Parameters
- •Discontinuities Library Block Parameters
- •Discrete Library Block Parameters
- •Logic and Bit Operations Library Block Parameters
- •Lookup Tables Block Parameters
- •Math Operations Library Block Parameters
- •Model Verification Library Block Parameters
- •Model-Wide Utilities Library Block Parameters
- •Ports & Subsystems Library Block Parameters
- •Signal Attributes Library Block Parameters
- •Signal Routing Library Block Parameters
- •Sinks Library Block Parameters
- •Sources Library Block Parameters
- •User-Defined Functions Library Block Parameters
- •Additional Discrete Block Library Parameters
- •Additional Math: Increment - Decrement Block Parameters
- •Mask Parameters
Mask Parameters
Mask Parameters
In this section...
“About Mask Parameters” on page 8-259
“Notes on Mask Parameter Storage” on page 8-265
About Mask Parameters
This section lists parameters that describe masked blocks. You can use these descriptive parameters with get_param and set_param to obtain and specify the properties of a block mask.
The descriptive mask parameters listed in this section apply to all masks, and provide access to all mask properties. Be careful not to confuse these descriptive mask parameters with the mask-specific parameters defined for an individual mask in the Mask Editor Parameters pane.
See “What Are Masks?” and “Masking” for information about block masks and the Mask Editor.
Mask Parameters
|
Parameter |
Description/Prompt |
Values |
|
|
Mask |
Turns mask on or off. |
{'on'} | 'off' |
|
|
MaskCallbackString |
Mask parameter callbacks |
pipe-delimited string {''} |
|
|
|
that are executed when |
|
|
|
|
the respective parameter is |
|
|
|
|
changed on the dialog. Set by |
|
|
|
|
the Dialog callback field on |
|
|
|
|
the Parameters pane of the |
|
|
|
|
Mask Editor dialog box. |
|
|
|
MaskCallbacks |
Cell array version of |
cell array {'[]'} |
|
|
|
MaskCallbackString. |
|
|
8-259
8 Model and Block Parameters
Mask Parameters (Continued)
|
Parameter |
Description/Prompt |
Values |
|
|
MaskDescription |
Block description. Set by the |
string {''} |
|
|
|
Mask description field on |
|
|
|
|
the Documentation pane of |
|
|
|
|
the Mask Editor dialog box. |
|
|
|
MaskDisplay |
Drawing commands for the |
string {''} |
|
|
|
block icon. Set by the Icon |
|
|
|
|
Drawing commands field on |
|
|
|
|
the Icon & Ports pane of the |
|
|
|
|
Mask Editor dialog box. |
|
|
|
MaskEditorHandle |
For internal use only. |
|
|
|
MaskEnableString |
Option that determines |
pipe-delimited string {''} |
|
|
|
whether a parameter is greyed |
|
|
|
|
out in the dialog. Set by the |
|
|
|
|
Enable parameter check box |
|
|
|
|
on the Parameters pane of |
|
|
|
|
the Mask Editor dialog box. |
|
|
|
MaskEnables |
Cell array version of |
cell array of strings, each |
|
|
|
MaskEnableString. |
either 'on' or ’'off' {'[]'} |
|
|
MaskHelp |
Block help. Set by the |
string {''} |
|
|
|
Mask help field on the |
|
|
|
|
Documentation pane of the |
|
|
|
|
Mask Editor dialog box. |
|
|
|
MaskIconFrame |
Set the visibility of the icon |
{'on'} | 'off' |
|
|
|
frame (Visible is on, Invisible |
|
|
|
|
is off). Set by the Block |
|
|
|
|
Frame option on the Icon & |
|
|
|
|
Ports pane of the Mask Editor |
|
|
|
|
dialog box. |
|
|
8-260
Mask Parameters
Mask Parameters (Continued)
|
Parameter |
Description/Prompt |
Values |
|
|
MaskIconOpaque |
Set the transparency of |
{'on'} | 'off' |
|
|
|
the icon (Opaque is on, |
|
|
|
|
Transparent is off). Set by |
|
|
|
|
the Icon Transparency |
|
|
|
|
option on the Icon & Ports |
|
|
|
|
pane of the Mask Editor dialog |
|
|
|
|
box. |
|
|
|
MaskIconRotate |
Set the rotation of the icon |
'on' | {'off'} |
|
|
|
(Rotates is on, Fixed is off). |
|
|
|
|
Set by the Icon Rotation |
|
|
|
|
option on the Icon & Ports |
|
|
|
|
pane of the Mask Editor dialog |
|
|
|
|
box. |
|
|
|
MaskIconUnits |
Set the units for the drawing |
'pixel' | {'autoscale'} | |
|
|
|
commands. Set by the Icon |
'normalized' |
|
|
|
Units option on the Icon & |
|
|
|
|
Ports pane of the Mask Editor |
|
|
|
|
dialog box. |
|
|
|
MaskInitialization |
Initialization commands. |
MATLAB command {''} |
|
|
|
Set by the Initialization |
|
|
|
|
commands field on the |
|
|
|
|
Initialization pane of the |
|
|
|
|
Mask Editor dialog box. |
|
|
|
MaskNames |
Cell array of mask dialog |
matrix {'[]'} |
|
|
|
parameter names. Set inside |
|
|
|
|
the Variable column in the |
|
|
|
|
Parameters pane of the Mask |
|
|
|
|
Editor dialog box. |
|
|
8-261
8 Model and Block Parameters
Mask Parameters (Continued)
|
Parameter |
Description/Prompt |
Values |
|
|
MaskPortRotate |
Specify the port rotation policy |
{'default} | 'physical' |
|
|
|
for the masked block. Set in |
|
|
|
|
the Port Rotation area on |
|
|
|
|
the Icon & Ports pane of the |
|
|
|
|
Mask Editor dialog box. |
|
|
|
|
For more information, see |
|
|
|
|
“Change the Appearance of |
|
|
|
|
a Block” in the Simulink |
|
|
|
|
documentation. |
|
|
|
MaskPrompts |
List of dialog parameter |
cell array of strings {'[]'} |
|
|
|
prompts (see below). Set inside |
|
|
|
|
the Dialog parameters area |
|
|
|
|
on the Parameters pane of |
|
|
|
|
the Mask Editor dialog box. |
|
|
|
MaskPromptString |
List of dialog parameter |
string {''} |
|
|
|
prompts (see below). Set inside |
See Note 1. |
|
|
|
the Dialog parameters area |
|
|
|
|
on the Parameters pane of |
|
|
|
|
the Mask Editor dialog box. |
|
|
|
MaskPropertyName |
Pipe-delimited version of |
string {''} |
|
|
String |
MaskNames. |
|
|
|
MaskRunInitForIconRedraw |
For internal use only. |
|
|
|
MaskSelfModifiable |
Indicates that the block can |
'on' | {'off'} |
|
|
|
modify itself. Set by the Allow |
|
|
|
|
library block to modify its |
|
|
|
|
contents check box on the |
|
|
|
|
Initialization pane of the |
|
|
|
|
Mask Editor dialog box. |
|
|
8-262
Mask Parameters
Mask Parameters (Continued)
|
Parameter |
Description/Prompt |
Values |
|
|
MaskStyles |
Determines whether the |
cell array {'[]'} |
|
|
|
dialog parameter is a check |
|
|
|
|
box, edit field, or pop-up list. |
|
|
|
|
Set by the Type column in the |
|
|
|
|
Parameters pane of the Mask |
|
|
|
|
Editor dialog box. |
|
|
|
MaskStyleString |
Comma-separated version of |
string {''} |
|
|
|
MaskStyles. |
See Note 2. |
|
|
|
|
|
|
|
MaskTabNameString |
For internal use only. |
|
|
|
MaskTabNames |
For internal use only. |
|
|
|
MaskToolTipsDisplay |
Determines which mask dialog |
cell array of 'on' and 'off' |
|
|
|
parameters to display in the |
{’’} |
|
|
|
data tip for this masked block |
|
|
|
|
(see "Block Data Tips" in the |
|
|
|
|
Simulink documentation). |
|
|
|
|
Specify as a cell array of |
|
|
|
|
'on' or 'off' values, each of |
|
|
|
|
which indicates whether to |
|
|
|
|
display the parameter named |
|
|
|
|
at the corresponding position |
|
|
|
|
in the cell array returned by |
|
|
|
|
MaskNames. |
|
|
|
MaskToolTipString |
Comma-delimited version of |
string {''} |
|
|
|
MaskToolTipsDisplay. |
|
|
|
MaskTunableValues |
Allows the changing of |
cell array of strings {'[]'} |
|
|
|
mask dialog values during |
|
|
|
|
simulation. Set by the |
|
|
|
|
Tunable column in the |
|
|
|
|
Parameters pane of the Mask |
|
|
|
|
Editor dialog box. |
|
|
8-263
8 Model and Block Parameters
Mask Parameters (Continued)
|
Parameter |
Description/Prompt |
Values |
|
|
MaskTunableValueString |
Comma-delimited |
delimited string {''} |
|
|
|
string version of |
|
|
|
|
MaskTunableValues. |
|
|
|
MaskType |
Mask type. Set by the |
string {'Stateflow'} |
|
|
|
Mask type field on the |
|
|
|
|
Documentation pane of the |
|
|
|
|
Mask Editor dialog box. |
|
|
|
MaskValues |
Dialog parameter values. |
cell array {'[]'} |
|
|
MaskValueString |
Delimited string version of |
delimited string {''} |
|
|
|
MaskValues. |
See Note 3. |
|
|
|
|
|
|
|
MaskVarAliases |
Specify aliases for a block’s |
cell array {'[]'} |
|
|
|
mask parameters. The aliases |
|
|
|
|
must appear in the same order |
|
|
|
|
as the parameters appear |
|
|
|
|
in the block’s MaskValues |
|
|
|
|
parameter. |
|
|
|
MaskVarAliasString |
For internal use only. |
|
|
|
MaskVariables |
List of the dialog parameters’ |
string {''} |
|
|
|
variables (see below). Set |
See Note 4. |
|
|
|
inside the Dialog parameters |
|
|
|
|
area on the Parameters pane |
|
|
|
|
of the Mask Editor dialog box. |
|
|
|
MaskVisibilities |
Specifies visibility of |
matrix {'[]'} |
|
|
|
parameters. Set with the |
|
|
|
|
Show parameter check box |
|
|
|
|
in the Options for selected |
|
|
|
|
parameter area on the |
|
|
|
|
Parameters pane of the Mask |
|
|
|
|
Editor dialog box. |
|
|
8-264