Main Content

Simulink.Mask Class

Namespace: Simulink

Control masks programmatically

Description

Use an instance of the Simulink.Mask class to perform the following operations:

  • Create, copy, and delete masks.

  • Create, edit, and delete mask parameters.

  • Determine the block that owns the mask.

  • Obtain workspace variables defined for a mask.

Properties

expand all

Mask type of the associated block is specified as a character vector or string.

Data Types: char | string

Description of the block, specified as a character vector or string.

Data Types: char | string

Help text for the masked block, specified as a character vector or string.

Data Types: char | string

Initialization commands for the masked block, specified as a character vector or string.

Data Types: char | string

Option to allow the block to modify its contents, specified as a logical.

Data Types: logical

MATLAB code for the block icon, specified as a character vector or string.

Data Types: char | string

Visibility of the block frame, specified as a logical value.

Data Types: logical

Option to make the icon opaque, specified as a logical.

  • Opaque: Make the icon opaque.

  • Transparent: Make the icon transparent.

Data Types: logical

Option to run mask initialization commands before executing the mask icon commands, specified as enumerated data type.

Data Types: enum

Option to rotate icon along with block, specified as enumerated data type.

Data Types: enum

Port rotation type, specified as enumerated data type. Set this property to default to reorder ports after a clockwise rotation to maintain a left-to-right port numbering order for ports along the top and bottom of the block and a top-to-bottom port numbering order for ports along the left and right sides of the block. Set this property to physical to rotate ports with the block without reordering them after a clockwise rotation.

Data Types: enum

Units for drawing commands, specified as enumerated type. autoscale scales the icon to fit the block frame. normalized draws the icon within a block frame whose bottom-left corner is (0,0) and whose top-right corner is (1,1). Only X and Y values from 0 through 1 appear. When the block is resized, the icon is also resized. pixels draws the icon with X and Y values expressed in pixels. The icon is not automatically resized when the block is resized.

Data Types: enum

Use this option to save the callback file along with the model, if you have mask initialization code and callback code in a separate MAT file, specified as a logical value.

Data Types: logical

Name of the callback file containing the mask initialization code and callback code, specified as a character vector or string.

Data Types: char | string

Mask parameter properties, specified as a Simulink.MaskParameter object.

Port identifier properties, specified as a Simulink.Mask.PortIdentifiers object.

Option to add or remove parameter constraint rule, specified as a Simulink.Mask.Constraints object.

Constraints between parameters, specified as Simulink.Mask.CrossParameterConstraints.

Option to add or remove port constraints, specified as a Simulink.Mask.PortConstraint object.

Option to add or remove constraints on ports of the masked block, specified as a Simulink.Mask.CrossPortConstraint object.

Methods

expand all

Version History

Introduced in R2010a