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
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
addCrossParameterConstraint | Add cross-parameter constraint |
addCrossPortConstraint | Create cross-port constraint among ports of the same masked block |
addCrossPortParameterConstraint | Create cross port parameter constraint between ports and parameters of same masked block |
addDialogControl | Add dialog control elements to mask dialog box |
addParameter | Add a parameter to a mask |
addParameterConstraint | Add parameter constraint to a mask |
addPortConstraint | Create port constraint on a mask object |
addPortConstraintAssociation | Associate port constraints to port identifiers |
addPortIdentifier | Creates a port identifier to identify port in mask |
copy | Copy mask from one block to another |
delete | Unmask a block and delete the mask from memory |
getAssociatedParametersOfConstraint | Get mask parameters associated with a constraint |
getCrossParameterConstraint | Get cross-parameter constraint |
getCrossPortConstraint | Display attributes of cross-port constraint |
getCrossPortParameterConstraint | Display attributes of cross port parameter constraint |
getDialogControl | Search for a specific dialog control on the mask |
getDialogControls | Retrieve root level containers from a masked block |
getOwner | Determine the block that owns a mask |
getParameter | Get mask parameter by name |
getParameterConstraint | Get mask parameter constraint properties |
getPortConstraint | Displays attributes of specified port constraint |
getPortConstraintAssociation | Displays port identifiers associated with port constraint |
getPortIdentifier | Displays attributes of specified port identifier |
getWorkspace | Create mask workspace object |
getWorkspaceVariables | Get variables defined in mask workspace for masked block |
insertParameter | Create and insert mask parameter at a specified index |
isMaskWithDialog | Check if block mask contains dialog controls and parameters |
isSimpleMask | Check if block mask contains only mask dialog controls |
numParameters | Display number of parameters in a mask |
removeAllCrossParameterConstraints | Delete all cross-parameter constraints from a mask |
removeAllCrossPortConstraints | Remove all cross-port constraints from mask object |
removeAllCrossPortParameterConstraints | Remove all cross port parameter constraints from mask object |
removeAllParameterConstraints | Delete all mask parameter constraints |
removeAllParameters | Remove all existing parameters from a mask |
removeAllPortConstraintAssociation | Removes the associations of all port constraints from mask |
removeAllPortConstraints | Remove all port constraints on masked block |
removeAllPortIdentifiers | Removes all port identifiers from mask object |
removeCrossParameterConstraint | Delete a cross-parameter constraint |
removeCrossPortConstraint | Remove cross-port constraint |
removeCrossPortParameterConstraint | Remove cross port parameter constraint |
removeDialogControl | Remove dialog control from mask dialog box |
removeParameter | Remove parameter from mask dialog box |
removeParameterConstraint | Delete a mask parameter constraint |
removePortConstraint | Remove specified port constraint |
removePortConstraintAssociation | Remove association between port constraint and port identifiers |
removePortIdentifier | Removes specified port identifier from mask object |
set | |
Simulink.Mask.create | Create a mask on a Simulink block |
get | Returns mask from a specified block |
Version History
Introduced in R2010a
See Also
Simulink.MaskParameter
| Simulink.Mask.Constraint
| Simulink.Mask.PortConstraint
| Simulink.Mask.PortConstraintRule
| Simulink.Mask.PortIdentifier
| Simulink.Mask.CrossPortConstraint
| Simulink.Mask.CrossPortParameterConstraint
| Simulink.Mask.SharedConstraintFile
| Control Masks Programmatically | Author Block Masks
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Seleccione un país/idioma
Seleccione un país/idioma para obtener contenido traducido, si está disponible, y ver eventos y ofertas de productos y servicios locales. Según su ubicación geográfica, recomendamos que seleccione: .
También puede seleccionar uno de estos países/idiomas:
Cómo obtener el mejor rendimiento
Seleccione China (en idioma chino o inglés) para obtener el mejor rendimiento. Los sitios web de otros países no están optimizados para ser accedidos desde su ubicación geográfica.
América
- América Latina (Español)
- Canada (English)
- United States (English)
Europa
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)