Добавил:
Upload Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
slref.pdf
Скачиваний:
39
Добавлен:
26.03.2015
Размер:
16.01 Mб
Скачать

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

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]