Simulink Reference

Mask Parameters

This section lists parameters that describe masked blocks. This table lists masking parameters, which correspond to Mask Editor dialog box parameters (see Setting Mask Parameters).

Mask Parameters 

Parameter	Description/Prompt	Values
Mask	Turns mask on or off.	{'on'} | 'off'
MaskCallbackString	Mask parameter callbacks 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.	pipe delimited string {''}
MaskCallbacks	Cell array version of MaskCallbackString.	cell array {'[]'}
MaskDescription	Block description. Set by the Mask description field on the Documentation pane of the Mask editor dialog box.	string {''}
MaskDisplay	Drawing commands for the block icon. Set by the Drawing commands field on the Icon pane of the Mask editor dialog box.	string {''}
MaskEditorHandle	For internal use.
MaskEnableString	Option that determines 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.	pipe delimited string {''}
MaskEnables	Cell array version of MaskEnableString.	cell array of strings, each either 'on' or 'off' {'[]'}
MaskHelp	Block help. Set by the Mask help field on the Documentation pane of the Mask editor dialog box.	string {''}
MaskIconFrame	Set the visibility of the icon frame (Visible is on, Invisible is off). Set by the Frame option on the Icon pane of the Mask editor dialog box.	{'on'} | 'off'
MaskIconOpaque	Set the transparency of the icon (Opaque is on, Transparent is off). Set by the Transparency option on the Icon pane of the Mask editor dialog box.	{'on'} | 'off'
MaskIconRotate	Set the rotation of the icon (Rotates is on, Fixed is off). Set by the Rotation option on the Icon pane of the Mask editor dialog box.	'on' | {'off'}
MaskIconUnits	Set the units for the drawing commands. Set by the Units option on the Icon pane of the Mask editor dialog box.	'pixel' | {'autoscale'} | 'normalized'
MaskInitialization	Initialization commands. Set by the Initialization commands field on the Initialization pane of the Mask editor dialog box.	MATLAB command {''}
MaskNames	Cell array of mask dialog parameter names. Set inside the Variable column in the Parameters pane of the Mask editor dialog box.	matrix {'[]'}
MaskPrompts	List of dialog parameter prompts (see below). Set inside the Dialog parameters area on the Parameters pane of the Mask editor dialog box.	cell array of strings {'[]'}
MaskPromptString	List of dialog parameter prompts (see below). Set inside the Dialog parameters area on the Parameters pane of the Mask editor dialog box.	string {''}
MaskPropertyName String	Pipe-delimited version of MaskNames.	string {''}
MaskRunInitForIconRedraw	For internal use.
MaskSelfModifiable	Indicates that the block can modify itself. Set by the Allow library block to modify its contents check box on the Initialization pane of the Mask editor dialog box.	'on' | {'off'}
MaskStyles	Determines whether the 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.	cell array {'[]'}
MaskStyleString	Comma-separated version of MaskStyles.	string {''}
MaskTabNameString	For internal use.
MaskTabNames	For internal use.
MaskToolTips Display	Determines which of the mask dialog parameters to display.	cell array of 'on' and 'off' {''}
MaskToolTipString	Comma-delimited version of MaskToolTipsDisplay.	string {''}
MaskTunableValues	Allows the changing of mask dialog values during simulation. Set by the Tunable column in the Parameters pane of the Mask editor dialog box.	cell array of strings {'[]'}
MaskTunableValue String	Delimited string version of MaskTunableValueString.	delimited string {''}
MaskType	Mask type. Set by the Mask type field on the Documentation pane of the Mask editor dialog box.	string {'Stateflow'}
MaskValues	Dialog parameter values.	cell array {'[]'}
MaskValueString	Delimited string version of MaskValues.	delimited string {''}
MaskVarAliases	For internal use.
MaskVarAliasString	For internal use.
MaskVariables	List of the dialog parameters' variables (see below). Set inside the Dialog parameters area on the Parameters pane of the Mask editor dialog box.	string {''}
MaskVisibilities	Specifies visibility of parameters.	matrix {'[]'}
MaskVisibility String	Cell array version of MaskVisibilities.	string {''}
MaskWSVariables	List of the variables defined in the mask workspace (read only).	matrix {'[]'}

Setting Mask Parameters

When you use the Mask Editor to create a dialog box parameter for a masked block, you provide this information:

• The prompt, which you enter in the Prompt field
• The variable that holds the parameter value, which you enter in the Variable field
• The type of field created, which you specify by selecting a Control type
• Whether the value entered in the field is to be evaluated or stored as a literal, which you specify by selecting an Assignment type

How Masked Parameters are Stored

The mask parameters, listed in the preceding table, store the values specified for the dialog box parameters in these ways:

• The Prompt field values for all dialog box parameters are stored in the MaskPromptString parameter as a string, with individual values separated by a vertical bar (|), as shown in this example:

• "Slope:|Intercept:"
  

• The Variable field values for all dialog box parameters are stored in the MaskVariables parameter as a string, with individual assignments separated by a semicolon. A sequence number indicates the prompt that is associated with a variable. A special character preceding the sequence number indicates the Assignment type: @ indicates Evaluate, & indicates Literal.

• For example, "a=@1;b=&2;" indicates that the value entered in the first parameter field is assigned to variable a and is evaluated in MATLAB before assignment, and the value entered in the second field is assigned to variable b and is stored as a literal, which means that its value is the string entered in the dialog box.

• The Control type field values for all dialog box parameters are stored in the MaskStyleString parameter as a string, with individual values separated by a comma. The Popup strings values appear after the popup type, as shown in this example:

• "edit,checkbox,popup(red|blue|green)"
  

• The parameter values are stored in the MaskValueString mask parameter as a string, with individual values separated by a vertical bar. The order of the values is the same as the order in which the parameters appear on the dialog box. For example, these statements define values for the parameter field prompts and the values for those parameters:

• MaskPromptString     "Slope:|Intercept:"
  MaskValueString      "2|5"
  

Block-Specific Parameters

Model File Format

© 1994-2005 The MathWorks, Inc.