addParameter

クラス: Simulink.Mask
名前空間: Simulink

パラメーターをマスクに追加する

このページをすべて展開する

構文

maskobj.addParameter(Name,Value)

説明

maskobj.addParameter(Name,Value) はパラメーターをマスクに追加します。名前と値の引数をまったく指定しなければ、マスク パラメーターの名前が自動生成され、コントロール タイプが edit に設定されます。

blockName という名前のブロックのマスク オブジェクトを取得するには、次のコマンドを使用します。

maskObj = Simulink.Mask.get('BlockName')

名前と値の引数

すべて展開する

オプションの引数のペアを Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定しなければなりませんが、ペアの順序は重要ではありません。

例: p.addParameter('Type','popup',...'TypeOptions',{'Red' 'Blue' 'Green'},'Evaluate','off');

R2021a より前では、コンマを使用して名前と値をそれぞれ区切り、Name を引用符で囲みます。

パラメーターのタイプ。文字ベクトルとして指定します。

データ型: char | string

ポップアップ、コンボボックス、またはリストボックス パラメーター内に表示されるオプション。cell 配列として指定します。

データ型: cell

マスク パラメーターの名前。文字ベクトルとして指定します。この名前は、このパラメーターで作成されたマスク ワークスペース変数に割り当てられます。

データ型: char | string

マスク パラメーターの表示名。文字ベクトルとして指定します。この名前は、マスク ダイアログのパラメーターに関連付けられているラベルに表示されます。

データ型: char | string

[マスク パラメーター] ダイアログのマスク パラメーターの既定値。タイプ固有であり、パラメーターの Type によって異なります。文字ベクトルとして指定します。

データ型: char | string

マスク パラメーターを評価するオプション。logical として指定します。

データ型: char

シミュレーション中にマスク パラメーターを変更するオプション。文字ベクトルまたは string として指定します。利用可能なオプションは次のとおりです。

  • オフ - このモードでは、シミュレーション中にマスク パラメーターの値を変更できません。

  • オン - シミュレーション中にマスク パラメーターの値を変更できます。変更を行うたびにモデルはコンパイルされます。

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

データ型: char

マスク パラメーターの値をモデル ファイルに保存するオプション。logical として指定します。

データ型: char

マスク ダイアログでマスク パラメーターを編集するオプション。logical として指定します。

データ型: char

マスク ダイアログでマスク パラメーターを非表示にするオプション。logical として指定します。

データ型: char

マスク ダイアログでマスク パラメーターを有効にするオプション。logical として指定します。

データ型: char

マスク ダイアログでマスク パラメーターを表示するオプション。logical として指定します。

データ型: char

マスク パラメーターのコールバック コード。文字ベクトルとして指定します。コールバック コードは、ユーザーがマスク ダイアログ ボックスでパラメーター値を変更したときに実行されます。

データ型: char

マスク パラメーターのツールヒントを有効にするオプション。logical 値として指定します。

データ型: char

マスク パラメーターの代替名。文字ベクトルとして指定します。

データ型: char | string

マスク ダイアログのパラメーターのレイアウト オプション。文字ベクトルまたは logical 値として指定します。行の位置、プロンプトの位置など、マスク ダイアログにおけるパラメーターの位置を指定します。また、マスク パラメーターを水平方向に広げたり縮小したりする処理も指定します。

データ型: object

例

すべて展開する

ライブ スクリプトを開く

手順 1: マスクされたブロックのパスを使用して、オブジェクトとしてマスクを取得します。

new_system('paramexample');
add_block('built-in/subsystem','paramexample/subsystem');
save_system;
open_system('paramexample');
p= Simulink.Mask.create(gcb);

手順 2: パラメーター属性の名前と値のペアを指定せずにパラメーターをマスクに追加します。

p.addParameter;

手順 3: 評価できないポップアップ タイプのマスク パラメーターを追加します。

p.addParameter('Type','popup','TypeOptions',{'Red' 'Blue' 'Green'},'Evaluate','off');
save_system;

バージョン履歴

R2014a で導入

参考

トピック