Simulink.Mask クラス

名前空間: Simulink

プログラムによるマスクの制御

説明

Simulink.Mask クラスのインスタンスは以下の操作を実行するために使用します。

• マスクの作成、コピーおよび削除

• マスク パラメーターの作成、編集、削除

• マスクを所有するブロックの判定

• マスクに対して定義されているワークスペース変数の取得

プロパティ

Type — ブロックのマスク タイプ

文字ベクトル (既定値) | string

関連付けられたブロックのマスク タイプを文字ベクトルまたは string として指定します。

データ型: char | string

Description — ブロックの説明

文字ベクトル (既定値) | string

ブロックの説明。文字ベクトルまたは string として指定します。

データ型: char | string

Help — マスク ブロックのヘルプ テキスト

文字ベクトル (既定値) | string

マスク ブロックのヘルプ テキスト。文字ベクトルまたは string として指定します。

データ型: char | string

Initialization — 初期化コマンド

文字ベクトル (既定値) | string

マスク ブロックの初期化コマンド。文字ベクトルまたは string として指定します。

データ型: char | string

SelfModifiable — ブロックの内容の変更を許可するオプション

off (既定値) | on

ブロックの内容の変更を許可するオプション。logical として指定します。

データ型: logical

Display — ブロック アイコンの MATLAB^® コード

文字ベクトル (既定値) | string

ブロック アイコンの MATLAB コード。文字ベクトルまたは string として指定します。

データ型: char | string

IconFrame — ブロック フレームの可視性

off (既定値) | on

ブロック フレームの可視性。logical 値として指定します。

データ型: logical

IconOpaque — アイコンを不透明にするオプション

opaque (既定値) | transparent

アイコンを不透明にするオプション。logical として指定します。

• opaque: アイコンを不透明にします。

• transparent: アイコンを透明にします。

データ型: logical

RunInitForIconRedraw — 描画コマンドの実行前に初期化を実行するオプション

off (既定値) | on | analyze

マスク アイコン コマンドを実行する前にマスク初期化コマンドを実行するオプション。列挙データ型として指定します。

データ型: enum

IconRotate — アイコンをブロックと一緒に回転させるオプション

なし (既定値) | port

アイコンをブロックと一緒に回転させるオプション。列挙データ型として指定します。

データ型: enum

PortRotate — 端子の回転タイプ

default (既定値) | physical

端子の回転タイプ。列挙データ型として指定します。このプロパティを default に設定すると、時計回りに回転した後、ブロックの上下に並ぶ端子の番号が左から右の順番になるように、およびブロックの左右に並ぶ端子の番号が上から下の順番になるように端子が並べ替えられます。このプロパティを physical に設定すると、時計回りに回転した後、端子は並べ替えられずにブロックと共に回転します。

データ型: enum

IconUnits — 描画コマンドの単位

autoscale (既定値) | pixels | normalized

描画コマンドの単位。列挙型として指定します。autoscale の場合、ブロックのフレームに合わせてアイコンのサイズが調整されます。normalized の場合、左下隅の座標が (0,0) で右上隅の座標が (1,1) であるブロック フレーム内にアイコンが描画されます。0 ～ 1 の X および Y の値のみが表示されます。ブロックのサイズが変更されると、アイコンのサイズも変更されます。pixels の場合、ピクセルで表現された X 値と Y 値でアイコンが描画されます。ブロックのサイズが変更されても、アイコンのサイズは自動的に変更されません。

データ型: enum

SaveCallbackFileWithModel — コールバック ファイルをモデルと一緒に保存するオプション

off (既定値) | on

このオプションは、マスク初期化コードとマスク コールバック コードが別の MAT ファイルに含まれている場合にコールバック ファイルをモデルと一緒に保存するために使用します。logical 値として指定します。

データ型: logical

CallbackFile — コールバック ファイルの名前

空 (既定値) | 文字ベクトル | string

マスク初期化コードとマスク コールバック コードを含むコールバック ファイルの名前。文字ベクトルまたは string として指定します。

データ型: char | string

Parameters — マスク パラメーターのプロパティ

Simulink.MaskParameter オブジェクト (既定値)

マスク パラメーターのプロパティ。Simulink.MaskParameter オブジェクトとして指定します。

PortIdentifiers — 端子識別子のプロパティ

Simulink.Mask.PortIdentifiers オブジェクト (既定値)

端子識別子のプロパティ。Simulink.Mask.PortIdentifiers オブジェクトとして指定します。

ParameterConstraints — パラメーター制約のプロパティ

Simulink.Mask.Constraints オブジェクト (既定値)

パラメーター制約ルールを追加または削除するオプション。Simulink.Mask.Constraints オブジェクトとして指定します。

CrossParameterConstraints — パラメーター間の制約

Simulink.Mask.CrossParameterConstraints (既定値)

パラメーター間の制約。Simulink.Mask.CrossParameterConstraints として指定します。

PortConstraints — 端子制約のプロパティ

Simulink.Mask.PortConstraint オブジェクト (既定値)

端子制約を追加または削除するオプション。Simulink.Mask.PortConstraint オブジェクトとして指定します。

CrossPortConstraints — 端子間制約のプロパティ

Simulink.Mask.CrossPortConstraint オブジェクト (既定値)

マスク ブロックの端子の制約を追加または削除するオプション。Simulink.Mask.CrossPortConstraint オブジェクトとして指定します。

メソッド

パブリック メソッド

addCrossParameterConstraint	クロスパラメーター制約を追加
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	マスク ダイアログ ボックスにダイアログ コントロール要素を追加
addParameter	パラメーターをマスクに追加する
addParameterConstraint	パラメーター制約をマスクに追加
addPortConstraint	Create port constraint on a mask object
addPortConstraintAssociation	端子制約を端子識別子に関連付け
addPortIdentifier	Creates a port identifier to identify port in mask
copy	あるブロックから別のブロックにマスクをコピーする
delete	ブロックのマスクを解除してメモリからマスクを削除
getAssociatedParametersOfConstraint	制約に関連付けられたマスク パラメーターを取得
getCrossParameterConstraint	クロスパラメーター制約を取得
getCrossPortConstraint	Display attributes of cross-port constraint
getCrossPortParameterConstraint	Display attributes of cross port parameter constraint
getDialogControl	マスク上の特定のダイアログ コントロールの検索
getDialogControls	Retrieve root level containers from a masked block
getOwner	マスクを所有するブロックの判別
getParameter	マスク パラメーターを名前で取得
getParameterConstraint	マスク パラメーター制約のプロパティを取得
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	マスク ブロックのマスク ワークスペースで定義された変数を取得する
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	マスク内のパラメーターの数の表示
removeAllCrossParameterConstraints	すべてのクロスパラメーター制約をマスクから削除
removeAllCrossPortConstraints	Remove all cross-port constraints from mask object
removeAllCrossPortParameterConstraints	Remove all cross port parameter constraints from mask object
removeAllParameterConstraints	すべてのマスク パラメーター制約を削除
removeAllParameters	マスクから既存のすべてのパラメーターを削除
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	クロスパラメーター制約を削除
removeCrossPortConstraint	Remove cross-port constraint
removeCrossPortParameterConstraint	Remove cross port parameter constraint
removeDialogControl	Remove dialog control from mask dialog box
removeParameter	マスク ダイアログ ボックスからパラメーターを削除
removeParameterConstraint	マスク パラメーター制約を削除
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	Simulink ブロックにマスクを作成
get	指定されたブロックからマスクを返す

バージョン履歴

R2010a で導入

参考

Simulink.MaskParameter | Simulink.Mask.Constraint | Simulink.Mask.PortConstraint | Simulink.Mask.PortConstraintRule | Simulink.Mask.PortIdentifier | Simulink.Mask.CrossPortConstraint | Simulink.Mask.CrossPortParameterConstraint | Simulink.Mask.SharedConstraintFile | プログラムによるマスクの制御 | ブロック マスクの作成