マスクエディターの概要

マスクはブロックの内容を非表示にするブロックのカスタムユーザーインターフェイスであり、独自のアイコンとパラメーターダイアログボックスをもつ Atomic ブロックとしてユーザーに表示します。

[マスクエディター] ダイアログボックスは、ブロックマスクの作成およびカスタマイズに役立ちます。マスクを作成または編集するときに [マスクエディター] ダイアログボックスが開きます。次のいずれかのオプションから [マスクエディター] ダイアログボックスにアクセスできます。

マスクを作成するには、次の手順を実行します。

[モデル化] タブの [コンポーネント] の下で、[システムマスクの作成] をクリックします。
ブロックを選択し、[ブロック] タブの [マスク] グループ内で [マスクの作成] をクリックします。マスクエディターが開きます。

マスクを編集するには、次の手順を実行します。

[ブロック] タブの [マスク] グループで、[マスクの編集] をクリックします。
ブロックを右クリックし、[マスク] 、 [マスクの編集] を選択します。

メモ

キーボードショートカット Ctrl + M を使用して [マスクエディター] を開くこともできます。

[マスクエディター] ダイアログボックスには、一連のタブ形式のペインが含まれています。各ペインでマスクの機能を定義できます。タブは次のとおりです。

[パラメーターとダイアログ] ペイン:マスクのダイアログボックスを設計するため。
[コード] ペイン:MATLAB^® コードを使用して、マスクされたブロックを初期化するため。
[アイコン] ペイン:ブロックマスクのアイコンを作成するため。
制約:制約を作成するため。

メモ

コマンドラインからブロックマスクを作成および編集する詳細については、プログラムによるマスクの制御を参照してください。

[パラメーターとダイアログ] ペインでは、[パラメーター]、[表示] および [アクション] パレットのダイアログコントロールを使用して、マスクダイアログボックスを設計できます。

Mask Editor showing parameters and dialog pane

[パラメーターとダイアログ] ペインは、次のセクションに分かれています。

[パラメーターとダイアログ] ペイン

セクション	セクションの説明	サブセクション	サブセクションの説明
コントロール	パラメーターはデータの追加や操作のために、ユーザーが対話できるマスクダイアログボックス内の要素です。	パラメーター	パラメーターは、シミュレーションに関係するユーザー入力です。[パラメーター] パレットは、マスクダイアログボックスに追加できる一連のパラメーターダイアログコントロールです。
		コンテナー	[コンテナー] パレットの [コントロール] では、マスクダイアログボックスのコントロールをグループ化できます。
		表示	[表示] パレットの [コントロール] では、マスクダイアログボックスのダイアログコントロールをグループ化して、テキストとイメージを表示できます。
		アクション	[アクション] コントロールによって、マスクダイアログボックスのいくつかのアクションを実行できます。たとえば、マスクダイアログボックスのハイパーリンクやボタンをクリックできます。
ダイアログボックス	ダイアログコントロールをクリックするか、パレットから [ダイアログボックス] にドラッグアンドドロップして、マスクダイアログボックスを作成できます。	NA	NA
プロパティエディター	[プロパティエディター] によって、[パラメーター]、[表示]、[コンテナー] および [アクション] コントロールのプロパティを表示して設定できます。	プロパティ	[名前]、[値]、[プロンプト]、[タイプ] など、すべてのダイアログコントロールの基本情報を定義します。
		属性	マスクダイアログコントロールがどのように解釈されるかを定義します。属性は、パラメーターにのみ関連します。
		ダイアログ	マスクダイアログボックスで、ダイアログコントロールがどのように表示されるかを定義します。
		レイアウト	マスクダイアログボックスで、ダイアログコントロールがどのように配置されるかを定義します。

コントロール

[コントロール] のセクションは、[パラメーター]、[表示] および [アクション] のサブセクションに分かれています。[コントロール] の表には、さまざまなコントロールとその説明がリストされます。

[コントロール] の表

コントロール		説明
パラメーター
	エディット	フィールドに入力することでパラメーター値を入力できます。制約を `Edit` パラメーターに関連付けることができます。
	チェックボックス	ブール値を受け入れます。
	ポップアップ	使用可能な値のリストからパラメーター値を選択できます。ポップアップパラメーターの使用可能な値は以下のオプションを使用して指定できます。オプション — オプションのリストのみを指定できます。カスタム値をもつオプション — ポップアップオプションの [説明] と [値] を指定できます。このオプションを使用すると、シミュレーション中の調整可能性が実現します。列挙値を使用 — ポップアップオプションの列挙ファイルを参照するか列挙クラスを作成できます。このオプションを使用すると、シミュレーションとコード生成の調整可能性が実現します。
	コンボボックス	使用可能な値のリストからパラメーター値を選択できます。リストからまたはリスト外から値を入力することもできます。[評価] チェックボックスを選択すると、関連付けられた変数は選択した項目の実際の値を保持します。制約を [コンボボックス] パラメーターに関連付けることができます。
	リストボックス	パラメーター値のリストを作成できます。マスクダイアログボックスに、可能な値のすべてのオプションが表示されます。そこから複数の値を選択できます。
	ラジオボタン	使用可能な値のリストからパラメーター値を選択できます。ラジオボタンのすべてのオプションが、マスクダイアログに表示されます。オプション — オプションのリストのみを指定できます。カスタム値をもつオプション — ラジオボタンオプションの [説明] と [値] を指定できます。このオプションを使用すると、シミュレーション中の調整可能性が実現します。列挙値を使用 — ラジオボタンオプションの列挙ファイルを参照するか列挙クラスを作成できます。このオプションを使用すると、シミュレーションとコード生成の調整可能性が実現します。
	スライダー	最小値と最大値で定義された範囲内で値にスライドできます。[スライダー] パラメーターは入力を数値または変数名として受け入れることができます。指定された変数がベースワークスペースまたはモデルワークスペースの変数である場合、[スライダー] を通じてこの変数の値を調整することができます。 [スケール] ドロップダウンメニューを使用して値を線形スケールまたは対数スケールで調整できます。スライダー範囲を動的に制御することもできます。メモスライダーに対して指定されている値が自動的に適用されます。
	ダイヤル	最小値と最大値で定義された範囲内で値にダイヤルを合わせることができます。[ダイヤル] パラメーターは入力を数値または変数名として受け入れることができます。指定された変数がベースワークスペースまたはモデルワークスペースの変数である場合、[ダイヤル] を通じてこの変数の値を調整することができます。 [スケール] ドロップダウンメニューを使用して値を線形スケールまたは対数スケールで調整できます。ダイヤル範囲を動的に制御することもできます。メモダイヤルに対して指定されている値が自動的に適用されます。
	スピンボックス	最小値と最大値で定義された範囲内で値をスピンできます。値のステップサイズを指定できます。メモスピンボックスに対して指定されている値が自動的に適用されます。
	データ型	マスクパラメーターのデータ型を指定できます。[最小値]、[最大値] および [エディット] パラメーターをデータ型パラメーターに関連付けることができます。詳細については、[データ型] パラメーターを使用した [編集] パラメーターのデータ型の指定を参照してください。
	最小値	[DataTypeStr] パラメーターに関連付けられた編集パラメーターの最小値を指定します。
	最大値	[DataTypeStr] パラメーターに関連付けられた編集パラメーターの最大値を指定します。
	単位	マスクされたブロックの出力値または入力値の測定単位を設定できます。[単位] パラメーターは、任意の測定単位を入力として受け入れることができます。たとえば、角速度のラジアン/秒、加速度のメートル/秒²、距離の km または m などです。
	カスタムテーブル	マスクダイアログボックスにテーブルを追加できます。プロパティエディターの [値] セクションに入れ子にされた cell 配列として値を追加できます。
	1 対 1 でプロモート	ブロックパラメーターを基礎となるブロックからマスクに選択的にプロモートできます。[1 対 1 でプロモート] をクリックして、[プロモート済みパラメーターセレクター] ダイアログボックスを開きます。このダイアログボックスでは、プロモートするブロックパラメーターを選択できます。[OK] をクリックして、ダイアログボックスを閉じます。
	多対 1 でプロモート	基礎となるブロックパラメーターをすべてマスクにプロモートできます。すべてのパラメーターをプロモートする場合、プロモート操作によって、以前プロモートされたパラメーターが削除されます。
コンテナー
	グループボックス	マスクダイアログボックス内のその他のダイアログコントロールおよびコンテナーをグループ化するコンテナー。
	タブ	マスクダイアログボックス内のダイアログコントロールをグループ化するタブ。タブはタブコンテナー内に含まれます。タブコンテナーには、複数のタブを指定できます。
	table	[編集]、[チェックボックス]、および [ポップアップ] パラメーターを表形式でグループ化するためのコンテナー。[テーブル] コンテナー内に一覧表示されるコンテンツの検索および並べ替えを行うこともできます。詳細については、大量のマスクパラメーターの処理を参照してください。
	折りたたみ可能なパネル	[パネル] と同様のダイアログコントロールをグループ化するコンテナー。[折りたたみ可能なパネル] ダイアログコントロールを展開するか折りたたむかを選択できます。
	パネル	ダイアログコントロールをグループ化するコンテナー。ダイアログコントロールの論理グループ化に [パネル] を使用します。Design Mask Dialog Box Layoutを参照してください。
	マスク部分参照	マスクパラメーターとダイアログコントロールを作成して XML ファイルに保存するためのコンテナー。その XML ファイルを複数のマスクブロックで参照してマスクパラメーターとダイアログコントロールを再利用できます。詳細については、Reuse Mask Parameters and Dialog Controls Across Multiple Masked Blocksを参照してください。
表示
	テキスト	マスクダイアログボックスに表示されるテキスト。
	イメージ	マスクダイアログボックスに表示されるイメージ。イメージのファイルパスは絶対パスでなければなりません。
	テキストエリア	マスクダイアログボックスでカスタムテキストまたは MATLAB コードを追加します。
	リストボックスコントロール	テキストをマスクダイアログボックスにリストとして表示します。複数の値 (Ctrl + クリック) を選択できます。
	ツリー制御	使用可能な値の階層ツリーで値を表示できます。複数の値 (Ctrl + クリック) を選択できます。詳細については、例を参照してください。
	ルックアップテーブルコントロール	n 次元テーブルとブレークポイントデータを可視化できます。
	Web ブラウザー	ダイアログのプレビュー時に Web サイトを開くことができます。[URL] プロパティでアドレスを入力します。
アクション
	ハイパーリンク	マスクダイアログボックスに表示されるハイパーリンクテキスト。
	ボタン	マスクダイアログボックスのボタンコントロール。特定のアクションに対して、ボタンをプログラムできます。ボタンコントロールにイメージを追加することもできます。

マスクパラメーターの詳細については、モデル例マスクパラメーターのタイプを参照してください。

ダイアログボックス

ダイアログコントロールを [コントロール] セクションから [パラメーターとダイアログ] タブにドラッグすることで、ダイアログコントロールの階層構造を構築できます。[コントロール] セクションのパレットをクリックして、必要なコントロールを [パラメーターとダイアログ] タブに追加することもできます。[パラメーターとダイアログ] タブに、最大で 32 レベルの階層構造を追加できます。

[パラメーターとダイアログ] セクションには、次の情報が表示されます。

タイプ:— ダイアログコントロールのタイプ。編集することはできません。また、パラメーターダイアログコントロールの連続番号も表示されます。
プロンプト:— ダイアログコントロールのプロンプトテキスト。
名前:— 名前が自動的に設定されダイアログコントロールを一意に識別します。[名前] フィールドで、さまざまな値 (有効な MATLAB 名) を選択して追加できます。組み込みのパラメーター名と一致してはなりません。
検索:— 名前またはプロンプトに基づいてパラメーター、ダイアログコントロール、コンテナーを検索します。
フィルター:— マスクパラメーターのプロパティとその値に基づいて検索結果を絞り込みます。プロパティには、[タイプ]、[評価]、[調整可能]、[表示] があります。

[ダイアログボックス] の [パラメーター] コントロールは薄い青の背景で表示され、[表示] コントロールおよび [アクション] コントロールは白の背景で表示されます。

階層内でダイアログコントロールを移動させたり、ダイアログコントロールのコピーと貼り付けを行ったり、ノードを削除したりすることもできます。詳細については、ダイアログコントロールの操作を参照してください。

プロパティエディター

[プロパティエディター] によって、[パラメーター]、[表示]、[コンテナー] および [アクション] ダイアログコントロールのプロパティを表示して設定できます。[パラメーター] の [プロパティエディター] が示されます。

Property editor of the Mask Editor showing the properties of an edit parameter

[パラメーター]、[アクション] および [表示] ダイアログコントロールに対して、以下のプロパティを設定できます。詳細については、プロパティエディターの表を参照してください。

プロパティエディター

プロパティ説明

プロパティ

名前

マスクダイアログボックスのダイアログコントロールを一意に識別します。[名前] プロパティは、すべてのダイアログコントロールで設定しなければなりません。

エイリアス

ダイアログコントロールの代替名。たとえば、パラメーターの値はパラメーターの代替名を使用して設定することもできます。

値

[パラメーター] の値。[値] プロパティは、[パラメーター] ダイアログコントロールにのみ適用されます。

プロンプト

マスクダイアログボックスのパラメーターを識別するラベルテキスト。[プロンプト] プロパティは、[パネル] および [イメージ] ダイアログコントロールを除くすべてのダイアログコントロールに適用されます。

タイプ

ダイアログコントロールのタイプ。[タイプ] フィールドを使用して [パラメーター] のタイプと [コンテナー] のタイプを変更できます。どのコンテナーのタイプも [Tab] に変更することはできません。その逆についても同様です。

展開

折りたたみ可能なパネルのダイアログコントロールが既定で展開されているか折りたたまれているかを指定できます。

データ型オプション

[データ型オプション] プロパティでは、特定の [パラメーター] プロパティを設定できます。[データ型オプション] プロパティは、[ポップアップ]、[ラジオボタン]、[DataTypeStr] および [プロモート済み] パラメーターに適用されます。

ファイルパス

[イメージ] ダイアログコントロールを使用してマスクにイメージを追加できます。[ボタン] ダイアログコントロールにイメージを表示することもできます。いずれの場合も、それら 2 つのダイアログコントロールに有効化されている [ファイルパス] プロパティにイメージへのパスを指定します。[ボタン] ダイアログコントロールの場合は、イメージが表示されるようにするため、[プロンプト] プロパティには空の文字ベクトルを指定します。

ファイルパスを指定する際は、引用符 (' ') を使用してはならないことに注意してください。たとえば、イメージを追加する場合、ファイルパスは C:\Users\User1\Image_Repositort\motor.png のように指定します。

右端での折り返し

[右端での折り返し] プロパティでは、長いテキストの右端での折り返しが可能です。[右端での折り返し] プロパティは、[テキスト] ダイアログコントロールにのみ適用されます。

最小値と最大値

[最大値] と [最小値] プロパティでは、[スピンボックス]、[スライダー] および [ダイヤル] などのコントロールの範囲を指定できます。

ステップサイズ

値のステップサイズを指定できます。このプロパティは、[スピンボックス] ダイアログコントロールに対してのみ適用されます。

ツールヒント

選択したダイアログコントロールタイプのツールヒントを指定できます。マスクダイアログボックスのダイアログコントロールにカーソルを合わせると、ツールヒントが表示されます。[グループボックス]、[タブ]、[折りたたみ可能なパネル] および [パネル] を除く、すべてのダイアログコントロールタイプにツールヒントを追加できます。

スケール

[スライダー] および [ダイヤル] ダイアログコントロールの調整スケールを linear または log として設定できます。

テーブルパラメーター

[ルックアップテーブル] パラメーターのテーブルデータを指定します。

テーブルの単位テーブルデータの単位を指定します。

テーブルの表示名 [ルックアップテーブル] コントロールの表示名を指定します。

ブレークポイントパラメーター [ルックアップテーブル] コントロールのブレークポイントパラメーターを指定します。例: {'torque','engine speed'}

ブレークポイントの単位ブレークポイントパラメーターの単位を指定します。例: {'Nm','rpm'}

データの仕様パラメーターの値を明示的に指定するか、データオブジェクトを使用して、テーブルパラメーターとブレークポイントパラメーターのデータを指定できます。

ルックアップテーブルオブジェクトテーブルパラメーターとブレークポイントパラメーターの値に対するデータオブジェクトの名前を指定します。

テキストタイプ [テキストエリア] パラメーターのテキストのタイプを指定します。[プレーンテキスト]、[HTML テキスト]、および [MATLAB コード] を受け取ることができます。[テキストエリア] パラメーターには、HTML コードを処理し、その出力をマスクダイアログボックスに表示する機能があります。同様に、[MATLAB コード] を処理して出力を表示できます。

属性

評価

マスクパラメーターの入力として MATLAB 式を入力した場合、Simulink^® ではそのエントリを次の 2 つのいずれかの方法で扱います。

[評価] オプションが選択されている場合、Simulink は式を評価し、最終的な計算結果を使用します。評価が正しく完了するには、式の変数がモデルワークスペースまたはベースワークスペースで初期化されていなければなりません。たとえば、変数 a と b のそれぞれで保持されている値が 2 と 9 の場合、'a + b' は 11 と評価されます。
[評価] オプションが選択されていない場合、Simulink はマスクパラメーターのダイアログボックスで入力された入力エントリをリテラルとしてそのまま読み取ります。たとえば、'a + b' は a + b として読み取られます。

[評価] オプションは、[エディット]、[チェックボックス]、および [ポップアップ] のマスクパラメーターでは既定で選択されています。

調整可能

シミュレーション中にマスクパラメーターの値を変更するには、マスクパラメーターの [調整可能] プロパティを設定します。

マスクパラメーターがパラメーターの調整をサポートしない場合、Simulink では、マスクパラメーターの [調整可能] プロパティは無視されます。このようなパラメーターは、シミュレーション時にマスクダイアログボックスで無効になります。

マスクパラメーターの調整可能なオプションは次のとおりです。

オフ - このモードでは、シミュレーション中にマスクパラメーターの値を変更できません。
オン - シミュレーション中にマスクパラメーターの値を変更できます。変更を行うたびにモデルはコンパイルされます。
実行ごと - 高速リスタートモードでマスクパラメーターを [実行ごと] に設定すると、実行ごとに値を変更できます。モデルは再コンパイルされず、シミュレーション結果に値は反映されません。

[調整可能] 属性に指定した値とシミュレーションモードに基づいて、マスクパラメーターは読み取り専用または読み取り/書き込みのどちらにすることもできます。

	オフ	オン	run-to-run
ノーマル	読み取り専用	読み取り/書き込み
高速リスタート	読み取り専用	読み取り/書き込み	読み取り/書き込み

パラメーターの調整およびそれをサポートするブロックの詳細は、ブロックパラメーター値の調整と試行を参照してください。

メモ

コード生成時に、パラメーターが生成されたコードに変数として表示されるのは、[コード生成設定] で [既定のパラメーター動作] が [調整可能] に設定されている場合だけです。

読み取り専用

パラメーターを変更できないことを示します。読み取り専用属性は永続的なパラメーターを作成する場合に使用できます。このパラメーターは特定の値またはデータをそのまま保持できますが、直接変更することはできません。

非表示

マスクダイアログボックスでパラメーターを表示してはならないことを示します。

保存しない

パラメーターの値をモデルファイルに保存できないことを示します。

制約

選択したパラメーターに制約を追加できます。

ダイアログボックス

有効

既定では、[有効] が選択されています。このオプションをオフにすると、選択されたコントロールが編集できなくなります。マスクブロックのユーザーがパラメーター値を設定できなくなります。

表示

選択されたコントロールがマスクダイアログボックスに表示されるのは、このオプションがオンになっている場合のみです。

コールバック

選択したコントロールにユーザーが変更を適用するときに、Simulink で実行される MATLAB コード。Simulink は一時ワークスペースを使用してコールバックコードを実行します。

メモ

[有効]/[表示] プロパティを使用すると、パラメーターが他のパラメーターの値の変更時に有効化または表示される動的なブロックダイアログボックスを作成できます。

レイアウト

項目の場所

現在の行または新しい行のいずれかに、ダイアログコントロールを表示する場所を設定できます。

プロンプトの整列

マスクダイアログボックスでパラメーターを整列できます。このオプションはテーブル以外のすべての表示コントロールでサポートされます。

プロンプトの場所

ダイアログコントロールの上または左のいずれかに、ダイアログコントロールのプロンプトの場所を設定できます。

[プロンプトの場所] プロパティを [チェックボックス]、[ダイヤル]、[DataTypeStr]、[折りたたみ可能なパネル] および [ラジオボタン] に設定することはできません。

方向

スライダーおよびラジオボタンに水平または垂直の方向を指定できます。

水平方向に広げる

既定では、マスクダイアログのサイズを変更するとすべてのコントロールが水平方向に広がります。このオプションは、コンテナー内の同じ行にあるコントロールの伸張プロパティを管理するのに役立ちます。たとえば、コンテナー内の同じ行にあるポップアップパラメーターとボタンについて考えてみます。サイズの変更時に、ポップアップパラメーターは広げ、ボタンは広げないとします。これを実現するには、ポップアップパラメーターの [水平方向に広げる] プロパティを [オン] に設定し、ボタンについては [オフ] に設定します。詳細については、Design Mask Dialog Box Layoutを参照してください。

[ドキュメンテーション] ペイン

[ドキュメンテーション] ペインでは、マスクブロックのタイプ、説明、およびヘルプテキストを定義または変更できます。

documentation pane

タイプ

マスクタイプは、ブロックのマスクダイアログボックスと、[マスクエディター] のすべてのペインに表示されるブロックの分類です。Simulink にマスクダイアログボックスが表示される場合、マスクタイプの後ろに (mask) が追加されます。マスクタイプを定義するには、[タイプ] フィールドに入力します。テキストには、有効な MATLAB 文字を使用できますが、改行を含めることはできません。

説明

マスクの説明はブロックの目的または機能を説明する概要ヘルプテキストです。既定では、[マスク] ダイアログボックスのマスクタイプの下にマスクの説明が表示されます。マスクの説明を定義するには、[説明] フィールドに入力します。テキストには有効な MATLAB 文字を含めることができます。長い行は Simulink によって自動的に改行されます。Enter キーを押して改行を挿入できます。

ヘルプ

マスクブロックのオンラインヘルプは、[タイプ] フィールドと [説明] フィールドで提供される情報の追加情報を提供します。この情報は、マスクダイアログボックスの [ヘルプ] ボタンがクリックされたときに個別のウィンドウに表示されます。マスクのヘルプを定義するには、次のいずれかを [ヘルプ] フィールドに入力します。

URL 仕様
web コマンドまたは eval コマンド
リテラルテキストまたは HTML テキスト

URL の指定

[ヘルプ] フィールドの最初の行が URL である場合、Simulink は、この URL を既定の Web ブラウザーに渡します。URL は、https:、www:、file:、ftp: または mailto: から開始できます。次に例を示します。

https://www.mathworks.com
file:///c:/mydir/helpdoc.html

ブラウザーがアクティブになると、MATLAB と Simulink は、そのアクションに対して制御をもたなくなります。

`web` コマンドの指定

[ヘルプ] フィールドの最初の行が web コマンドである場合、Simulink はコマンドを MATLAB に渡し、指定されたファイルが HTML ビューアーで表示されます。次に例を示します。

web([docroot '/MyBlockDoc/' get_param(gcb,'MaskType') '.html'])

詳細は、MATLAB web コマンドのドキュメンテーションを参照してください。マスクのヘルプに使用する web コマンドは値を返すことができません。

`eval` コマンドの指定

[ヘルプ] フィールドの最初の行が eval コマンドである場合、Simulink はコマンドを MATLAB に渡し、指定した評価が実行されます。次に例を示します。

eval('open My_Spec.doc')

詳細は、MATLAB eval コマンドのドキュメンテーションを参照してください。マスクのヘルプに使用する eval コマンドは値を返すことができません。

リテラルテキストまたは HTML テキストの指定

[ヘルプ] フィールドの最初の行が URL、web コマンドまたは eval コマンドでない場合、Simulink では、[マスクタイプ] フィールドの値である見出しでシステムの Web ブラウザーにテキストが表示されます。テキストには、有効な MATLAB 文字、改行、および標準の HTML タグ (イメージを表示する img タグなどを含む) を含めることができます。

Simulink は、最初にテキストを一時フォルダーにコピーし、次に web コマンドを使用してテキストを表示します。テキストにイメージを表示する場合、イメージファイルへの URL パスを指定するか、一時フォルダーにイメージファイルを配置できます。Simulink がシステムで使用する一時フォルダーを検索するには、tempdir を使用します。

[コード] ペイン

初期化およびパラメーターコールバック
初期化コマンドの規則
マスク初期化コードによるサブシステムの内容の変更を許可

[コード] ペインには、ブロックの初期化コードとパラメーターコールバックコードがまとめて表示されます。マスクエディターのコード機能は MATLAB エディターのコード機能と似ていますが、制限がいくつかあります。たとえば、オートコンプリート機能はサポートされていますが、コードにブレークポイントを設定できません。マスク初期化およびマスクコールバックコードを別個の MATLAB クラスファイルで整理できます。詳細については、Organize Mask Initialization and Callbacks in a MATLAB Fileを参照してください。

Mask initialization and parameter callback pane

モデルを開くと、Simulink は、そのモデルの最上位または開いているサブシステムに存在している可視状態のマスクブロックを見つけます。Simulink は、これらの可視状態のマスクブロックに対してのみ、以下のいずれかの条件が満たされた上で初期化コマンドを実行します。

マスク設定されたブロックに、アイコン描画コマンドがある。
メモ
Simulink は、マスクブロックに初期化コマンドがあっても、アイコン描画コマンドがないと初期化しません。
マスクブロックがライブラリに属しており、[マスク初期化コードでサブシステムのコンテンツを変更できるようにする] 設定が有効になっている。

モデル内のすべてのマスクブロック用の初期化コマンドは、以下の場合に実行されます。

ブロック線図を更新するとき。
シミュレーションを開始するとき。
コード生成を開始する
ダイアログボックスで [適用] をクリックする
コールバックを編集して保存する

個別のマスクブロックの初期化コマンドは、以下の場合に実行されます。

マスクエディターまたは set_param コマンドを使用して、MaskDisplay や MaskInitialization などマスクを定義するマスクパラメーターのいずれかを変更するとき。
アイコンが初期化コマンドに依存する場合に、マスクブロックを回転または反転させるとき。
アイコンを描画または再描画する際に、そのアイコン描画が初期化コードに依存するとき。
ブロックのダイアログボックスまたは set_param コマンドを使用してマスクパラメーターの値を変更するとき。
同じモデル内または異なるモデル間でマスクブロックをコピーするとき。

この節では、[コード] ペインのコントロールについて説明します。

初期化およびパラメーターコールバック

code pane をクリックして、エディターで初期化コードテンプレートおよびパラメーターコールバックテンプレートを追加します。MATLAB 関数およびスクリプト、演算子、およびマスクワークスペースで定義済みの変数で構成された任意で有効な MATLAB 式を入力できます。初期化コマンドは、ベースワークスペースではなくマスクワークスペースで実行します。

[コード] ペインには、マスク初期化コードとマスクコールバックコードがまとめて表示されます。パラメーターコールバックコードを追加するには、[パラメーター] リストのパラメーターの隣にあるプラスボタンをクリックします。コールバックコードのスケルトンが表示されます。コールバックの MATLAB コマンドを入力します。

callback code

初期化コマンドの規則

マスクの初期化コマンドには、以下の規則が適用されます。

初期化はマスクダイアログボックスが変更されたときに通常は行われないため、動的なマスクダイアログでは初期化コードを使用しないでください。代わりに、関連するパラメーターのマスクコールバックを使用してください。このマスクコールバックは所定のパラメーターが更新されたときに即時に実行されます。
初期化コマンドの変数名の前に MaskParam_L_ や MaskParam_M_ を付けないでください。これらの接頭辞は、内部変数名での使用のために予約されています。
set_param は、初期化されるマスクサブシステムに常駐するマスクサブシステムに存在するブロックのパラメーターの設定には使用しないでください。詳細については、Create Library Blocks Using Self-Modifiable Masks and Variant Blocksを参照してください。

マスク初期化コードによるサブシステムの内容の変更を許可

このチェックボックスが有効になるのは、マスクされたブロックがライブラリ内にある場合だけです。このオプションを選択すると、マスクされたブロックのパラメーターを変更できます。マスクされたブロックがマスクサブシステムである場合、このオプションを使用してブロックを追加または削除し、そのサブシステム内でブロックのパラメーターを設定できます。このオプションがオフの場合は、マスクライブラリブロックが何らかの形で内容を変更しようとするとエラーが発生します。

[アイコン] ペイン

グラフィカルアイコンエディター
マスクアイコン描画コマンド

[アイコン] ペインは、説明テキスト、状態方程式、イメージおよびグラフィックスを含むブロックアイコンの作成に役立ちます。ブロックアイコンは、グラフィカルエディターまたはマスク描画コマンドを使用して作成できます。

グラフィカルアイコンエディター

グラフィカルエディター: ブロックのマスクアイコンをグラフィカル環境で作成および編集できます。グラフィカルアイコンエディターには、アイコンの作成を簡単にするさまざまな機能があります。グラフィカルアイコンエディターはマスクエディターから起動します。

対話型のグラフィカル環境: ペン、曲率、テキスト、ハサミ、コネクタ、方程式 (LaTeX をサポート) などのグラフィカルツールを使用して、豊富なグラフィカルアイコンを作成します。グリッド、スマートガイド、およびルーラーにより、ピクセルパーフェクトなアイコンを作成できます。描画ツールとは別に、抵抗、インダクタ、回転ダンパーなど、いくつかの組み込みの形状が用意されています。
要素ブラウザー: アイコンのすべての要素が要素ブラウザーにリストされます。
- アイコンの要素を非表示にする (または非表示を解除する)。
- アイコンの要素の形状や位置を他の要素を操作しているときに誤って変更しないように要素をロックする (またはロックを解除する)。
- アイコンの要素を識別しやすいように各要素に名前を付ける。
端子のバインド/バインド解除: ブロックコンテキストを使用してブロックを作成または変更する場合、各ブロックの端子数があらかじめ定義されています。たとえば、Simscape™ ブロックや Aerospace ブロックの端子数はあらかじめ定義されており、それらの端子がブロックアイコンに表示されます。ブロックコンテキストなしでブロックを作成または変更する場合は、ブロックアイコンの端子数も定義できます。
条件付き表示: ブロックパラメーターまたはマスクパラメーターに基づいてブロックの要素を非表示にします (または非表示を解除します)。
プレビューオプション: 水平方向に広げる、反転、スケールなどのプレビューオプションを使用して、Simulink でアイコンをプレビューします。ブロックパラメーターを変更してアイコンをプレビューすることもできます。
アイコンのサイズに適合する要素の表示: ファーストフィット機能を使用すると、ブロックのサイズを変更するときにアイコンのサイズに収まる要素だけを表示できます。
要素の相対的な配置: 自動レイアウト制約機能を使用すると、各要素を他の要素との相対的な位置関係でキャンバスに配置できます。
テキストのパラメーター化: ブロックパラメーターまたはマスクパラメーターの評価値をブロックアイコンに表示できます。実行時にテキストまたは値を返すブロックパラメーターの名前かプレースホルダーを [パラメーター/値] に入力します。ブロックアイコンに表示されるブロックパラメーターの評価値を確認するには、Simulink キャンバスでアイコンをプレビューします。

グラフィカルアイコンエディターの詳細については、Graphical Icon Editor Overviewを参照してください。

マスクアイコン描画コマンド

マスクエディターは、各描画コマンドのスケルトンを提供します。マスクアイコンのイメージを設定できます。[イメージの追加] をクリックしてイメージをインポートします。

icon drawing commands

マスクアイコンの [描画コマンド] ペインは、次のセクションに分かれています。

プロパティ:マスクアイコンに適用できるさまざまなコントロールのリストを示します。
プレビュー:[ブロックマスク] アイコンのプレビューを表示します。
アイコンを描画するコマンド:MATLAB コードを使用してマスクアイコンを描画できるようにします。

メモ

静的および動的なブロックのマスクアイコンを作成できます。詳細については、マスクの表示と初期化のコマンドを参照してください。

プロパティ. 右側のペインで利用可能な [プロパティ] は、マスクアイコンに属性を指定できるようにするコントロールのリストです。次のオプションがあります。

ブロックのフレーム. ブロックフレームはブロックを囲む四角形です。[ブロックのフレーム] パラメーターを [表示] または [非表示] に設定して、フレームを表示するか非表示にするかを選択できます。既定の設定では、ブロックフレームは表示されます。たとえば、次の図は、AND ゲートブロックの表示ブロックフレームと非表示ブロックフレームを示します。

Difference between a visible and invisible block frame.

メモ

アイコンの透明性を [透明] に設定した場合、[ブロックのフレーム] プロパティを [非表示] に設定しても Simulink はブロックのフレームを非表示にしません。

アイコンの透明性. アイコンの透明性は、アイコンの下にある項目を表示するか非表示にするかに基づいて、[不透明]、[不透明 (端子あり)] または [透明] に設定できます。既定のオプション [不透明] は、端子ラベルなどの情報を非表示にします。

Difference between an opaque and transparent icon.

Subsystem ブロックの場合、アイコンの透明性を [不透明 (端子あり)] に設定した場合、ポートのラベルが表示されます。

opaque ports

メモ

端子ラベルを非表示にする [不透明] オプションについては、マスクエディターで追加されたアイコンを描画するコマンドがなければなりません。

アイコンの単位. このオプションは、描画コマンドで使用する座標系を制御します。これは、plot、text および patch 描画コマンドのみに適用されます。以下のいずれかを選択することができます。[オートスケール]、[正規化]、[ピクセル]

icon units controlling the coordinate system of the drawing commands.

[オートスケール] を選択すると、ブロックのフレームに合わせてアイコンのサイズが調整されます。ブロックのサイズが変更されると、アイコンのサイズも変更されます。たとえば、次の図は、これらのベクトルを使用して描画したアイコンを示します。
```
X = [0 2 3 4 9]; Y = [4 6 3 5 8];
```
ブロックのフレームの左下隅の座標は (0,3) で、右上隅の座標は (9,8) です。x 軸の範囲は 9 (0 ～ 9) で、y 軸の範囲は 5 (3 ～ 8) です。"x" 軸と "y" 軸が変化する描画コマンドが複数ある場合、それらのコマンドをレンダリングするときにプロット全体の範囲が考慮されます。
[正規化] を選択すると、左下隅の座標が (0,0) で右上隅の座標が (1,1) であるブロックフレーム内にアイコンが描画されます。0 ～ 1 の X および Y の値のみが表示されます。ブロックのサイズが変更されると、アイコンのサイズも変更されます。たとえば、次の図は、これらのベクトルを使用して描画したアイコンを示します。
```
X = [.0 .2 .3 .4 .9]; Y = [.4 .6 .3 .5 .8];
```
[ピクセル] を選択すると、ピクセルで表現された X 値と Y 値でアイコンが描画されます。ブロックのサイズが変更されても、アイコンのサイズは自動的に変更されません。アイコンのサイズをブロックに合わせて変更するには、ブロックのサイズで描画コマンドを定義します。

アイコンの回転. ブロックを回転または反転させるとき、アイコンを回転または反転させるか、アイコンの元の向きを維持するかを選択できます。既定の設定では、アイコンは回転しません。アイコンの回転は、ブロック端子の回転に一致します。次の図は、AND ゲートブロックで [アイコンの回転] オプションを [固定] と [回転] として選択した場合の結果を示します。

icon rotation

端子の回転. このオプションによって、マスクされたブロックの端子の回転タイプを指定できます。選択肢は以下になります。

既定の設定
時計回りに回転した後、端子はブロックの上下に並ぶ端子の番号が左から右の順番になるように、およびブロックの左右に並ぶ端子の番号が上から下に順番になるように並べ替えられます。
物理的
時計回りに回転した後、端子は並べ替えられずにブロックと共に回転します。

[既定の設定] 回転オプションは、一般的にブロック線図に上下と左右の向きがある制御システムおよびモデリングアプリケーションに適しています。このオプションでは、回転の後に標準の向きを維持するためにブロックを再接続する必要性を最小化することで、ブロック線図の編集が容易になります。

同様に、[物理的] 回転オプションは、ブロックが物理的なコンポーネントを表し、ラインが物理的な接続を表す電子、機械、油圧、およびその他のモデリングアプリケーションに適しています。[物理的] 回転オプションでは、表現するデバイスの動作がより厳密にモデル化されます (端子は物理デバイスの場合と同様にブロックと共に回転します)。さらに、回転してもラインが交差しないので、ブロック線図が読みやすくなります。

たとえば、次の図は、同じトランジスター回路を表す 2 つのブロック線図を示します。一方の図では、マスクブロックは既定の回転を使用するトランジスターを示し、もう一方の図は物理的回転を使用するトランジスターを示します。

port rotation

両方のブロック線図では、ブロック線図が読みにくくならないようにラインは交差しません。次の図は、時計回りに 1 回転したブロック線図を示します。

clockwise port rotation

メモ

回転の後、既定の回転を使用したブロック線図ではラインが交差しますが、物理的回転を使用したブロック線図ではラインは交差しません。既定の回転では、ブロック線図を編集してラインの交差をなくすこともできません。詳細については、ブロックの反転または回転を参照してください。

初期化の実行. [初期化の実行] オプションで、マスクの初期化コマンドの実行を制御できます。選択肢は以下になります。

オフ (既定の設定): マスクの初期化コマンドを実行しません。マスク描画コマンドがマスクワークスペースに依存しない場合は、[初期化の実行] の値を [オフ] に指定することをお勧めします。値を [オフ] に設定すると、マスクの初期化コマンドが実行されないため、Simulink のパフォーマンスが最適化されます。
オン: マスクワークスペースが最新でない場合、マスクの初期化コマンドを実行します。このオプションを指定すると、マスク描画コマンドがマスクワークスペースに依存しているかどうかにかかわらず、マスク描画コマンドを実行する前に、マスクの初期化コマンドが実行されます。
解析: マスクワークスペースに依存している場合にのみ、マスクの初期化コマンドを実行します。このオプションを指定すると、Simulink ではマスクアイコン描画コマンドが実行される前に、マスクの初期化コマンドが実行されます。[解析] オプションは下位互換性のためのもので、それ以外では推奨されません。R2016b 以前の Simulink モデルは、アップグレードアドバイザーを使用してアップグレードすることをお勧めします。
詳細については、描画コマンドを使用したマスクアイコンの描画を参照してください。

プレビュー. このセクションには、ブロックマスクアイコンのプレビューが表示されます。ブロックマスクのプレビューは、マスクでアイコンの描画が行われる場合にのみ利用できます。

アイコンを描画するコマンドを追加して [適用] をクリックすると、プレビューイメージが更新され、[アイコン] ペインの [プレビュー] セクションに表示されます。

アイコンを描画するコマンド. コードをエディターに追加してブロックアイコンを描画します。左ペインのコマンドリストを使用して、ブロックアイコンを描画できます。

マスクアイコン描画コマンド

描画コマンド	説明	構文の例
`color`	マスクアイコン描画コマンドの描画色を変更する	`color('red'); port_label('output',1,'Text')`
`disp`	マスクアイコン上にテキストを表示する	`disp('Gain')`
`dpoly`	マスクアイコン上に伝達関数を表示する	`dpoly([0 0 1], [1 2 1], 'z')`
`droots`	マスクアイコン上に伝達関数を表示する	`droots([-1], [-2 -3], 4)`
`fprintf`	マスクアイコン上に変数テキストを表示する	`fprintf('Sum = %d', 7)`
`image`	マスクアイコン上に RGB イメージを表示するイメージを追加するには、マスクブロックを選択し、[ブロック] タブで [イメージの追加] をクリックします。複数の image コマンドを使用することで、複数のイメージをマスクアイコンに追加することもできます。メモイメージは MATLAB パス上になければなりません。	`image('sine.svg')`
`patch`	マスクアイコン上に指定された形状のカラーパッチを描画する	`patch([0 10 20 30 30 0], [10 30 20 25 10 10],[1 0 0])`
`plot`	マスクアイコン上に一連の点を結ぶグラフを描画する	`plot([10 20 30 40], [10 20 10 15])`
`port_label`	マスクアイコンに端子ラベルを描画する	`port_label('output', 1, 'xy')`
`text`	マスクアイコンの特定の位置にテキストを表示する。 [アイコンの単位] ボックスで [`Pixels`] を選択しなければなりません。	`text(5,10, 'Gain')`
`block_icon`	サブシステムに含まれるブロックのアイコンをサブシステムマスクにプロモートする	`block_icon(BlockName)` ここで、ブロックのアイコンはその Subsystem ブロックにプロモートされます。詳細については、描画コマンドを使用したマスクアイコンの描画を参照してください。

メモ

Simulink は、無名関数内でマスク描画コマンドをサポートしていません。

描画コマンドは、テキストボックスに追加されたのと同じ順序で実行されます。描画コマンドは、マスクワークスペースのすべての変数にアクセスします。いずれかの描画コマンドが正常に実行できない場合、ブロックアイコンに疑問符が表示されます。

描画コマンドは、次の場合には、ブロックが描画された後に実行されます。

マスクダイアログボックスで変更を行い、適用するとき。
マスクエディターで変更を行うとき。
ブロックの回転のように、ブロックの外観に影響を与えるブロック線図への変更を行うとき。

制約

マスクパラメーターの制約ではマスクパラメーターに対する検証を作成することができ、独自の検証コードを記述する必要はありません。3 種類の制約、つまりパラメーター制約、クロスパラメーター制約、端子制約があります。

Constraints showing parameter, cross parameter, and port constraints in a file.

パラメーター制約: マスクには、ユーザー入力値を受け入れるパラメーターを含めることができます。マスクダイアログボックスを使用して、マスクパラメーターの入力値を指定できます。制約を使用して、マスクパラメーターの入力値を、必ず指定された範囲内に収めることができます。たとえば、Gain ブロックのマスクについて考えます。入力値が 1 ～ 10 の範囲内でなければならないという制約を設定できます。指定された範囲外の入力を提供すると、エラーが表示されます。左ペインの制約ブラウザーは、共有の制約を管理するのに役立ちます。

クロスパラメーター制約: クロスパラメーター制約は [エディット] または [コンボボックス] タイプの 2 つ以上のマスクパラメーター間に適用されます。Parameter1 が Parameter2 よりも大きくなければならないといったシナリオを指定する場合に、クロスパラメーター制約を使用できます。

端子制約: マスクされたブロックの入力端子と出力端子に対する制約を指定できます。モデルをコンパイルするときに、端子の属性が制約に対してチェックされます。

端子間制約: 同じマスクブロックの端子間でコンパイル時の信号属性を検証する端子間制約を作成します。たとえば、マスクブロックの入力端子と出力端子の信号間に、同じデータ型をもつという制約を設定できます。

追加オプション

マスクエディターに以下のボタンが表示されます。

[マスクの保存] をクリックすると、マスク設定が適用され、[マスクエディター] が開いたままになります。
[ダイアログのプレビュー] をクリックすると、変更が適用され、マスクダイアログボックスが開きます。
[マスクの削除] をクリックすると、マスクが削除され、[マスクエディター] が閉じます。マスクを再作成するには、ブロックを選択し、[ブロック] タブの [マスク] グループ内で [マスクの作成] をクリックします。
[マスクのコピー] をクリックすると、Simulink ライブラリブロックからマスクの定義がコピーされます。目的のブロックを検索し、[マスクのコピー] をクリックして既存のブロックからマスク定義をインポートします。
[ブロックの評価] をクリックすると、コールバックと初期化コードが評価されます。