ドキュメンテーション センター

  • 評価版
  • 製品アップデート

目次

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

Simulink.ConfigSet

モデルのコンフィギュレーション セットにアクセスする

説明

このハンドル クラスのインスタンスを使うと、モデルに対して、コンフィギュレーション セットを作成、修正、追加するためのプログラムを記述することができます。詳細は、「コンフィギュレーション セットを管理する」および「概要」を参照してください。

プロパティのまとめ

名前

説明

Components

コンフィギュレーション セットのコンポーネント。

Description

コンフィギュレーション セットの説明。

Name

コンフィギュレーション セット名。

    メモ:   Model Configuration ダイアログ ボックスを使用して、コンフィギュレーション セットの Name プロパティと Description プロパティを設定することができます。詳細は、「モデル コンフィギュレーション ペイン」を参照してください。

メソッドのまとめ

名前

説明

attachComponent

コンポーネントをコンフィギュレーション セットに付加します。

copy

コンフィギュレーション セットのコピーを作成します。

getComponent

コンフィギュレーション セットのコンポーネントを取得します。

getFullName

コンフィギュレーション セットの絶対パス名を取得します。

getModel

コンフィギュレーション セットをもつモデルのハンドルを取得します。

get_param

コンフィギュレーション セット パラメーターの値を取得します。

isActive

コンフィギュレーション セットが、これをもつモデルのアクティブ セットであるかどうかを判定します。

isValidParam

指定したパラメーターがコンフィギュレーション セットの有効なパラメーターであるかどうかを判定します。

saveAs

コンフィギュレーション セットを MATLAB® ファイルに保存します。

setPropenabled

パラメーターをユーザー側で変更可能、または変更不可にします。

set_param

コンフィギュレーション セット パラメーターの値を設定します。

プロパティ

Components

説明

コンフィギュレーション セットのコンポーネントを表す Simulink.ConfigComponent オブジェクトの配列。ソルバーのパラメーター、データのインポート/エクスポート パラメーターなど。

データ型

配列

アクセス

RW

Description

説明

コンフィギュレーション セットの説明。このプロパティを使用して、コンフィギュレーション セットの目的など、コンフィギュレーション セットに関する追加情報を与えることができます。このフィールドは、空白のままにすることができます。

データ型

string

アクセス

RW

Name

説明

コンフィギュレーション セット名。この名前は、モデル エクスプローラーでのコンフィギュレーション セットを表します。

データ型

string

アクセス

RW

メソッド

attachComponent

目的

コンポーネントをこのコンフィギュレーション セットに付加します。

構文

attachComponent(component)

引数

component

Simulink.ConfigComponent クラスのインスタンス。

説明

このメソッドは、このコンフィギュレーション セットのコンポーネントを、同じ名前をもつコンポーネントで置き換えます。

次の例は、モデル A のアクティブ コンフィギュレーション セットのソルバーのコンポーネントを、モデル B のアクティブ コンフィギュレーション セットで置き換えます。

hCs = getActiveConfigSet('B');
hSolverConfig = hCs.getComponent('Solver');
hSolverConfig = hSolverConfig.copy;
hCs = getActiveConfigSet('A');
hCs.attachComponent(hSolverConfig);

copy

目的

このコンフィギュレーション セットのコピーを作成します。

構文

copy

説明

このメソッドは、このコンフィギュレーション セットのコピーを作成します。

    メモ:    Simulink.ConfigSet はハンドル クラスであるため、このメソッドをコンフィギュレーション セットのコピーを作成するために使用する必要があります。詳細は、「ハンドルと値のクラス」を参照してください。

getComponent

目的

コンフィギュレーション セットのコンポーネントを取得します。

構文

getComponent(componentName)

引数

componentName

返されるコンポーネント名を指定する文字列。

説明

指定した要素を返します。このコンフィギュレーション セットが含む、コンポーネント名のリストを取得する引数を省略します。

次のコードは、現在選択されているモデルのアクティブ コンフィギュレーション セットのソルバー コンポーネントを取得します。

hCs = getActiveConfigSet(gcs);
hSolverConfig = hCs.getComponent('Solver');

次のコードは、現在選択されているモデルのアクティブなコンフィギュレーション セットのコンポーネントの名前を MATLAB コマンド ラインに表示します。

hCs = getActiveConfigSet(gcs);
hCs.getComponent

getFullName

目的

コンフィギュレーション セットの絶対パス名を取得します。

構文

getFullName

説明

このメソッドは、コンフィギュレーション セットの絶対パス、たとえば 'vdp/Configuration' を指定する文字列を返します。

getModel

目的

このコンフィギュレーション セットをもつモデルを取得します。

構文

getModel

説明

このコンフィギュレーション セットをもつモデルにハンドルを返します。

以下のコマンドは、MATLAB ワークスペース変数 hCs で参照されるコンフィギュレーション セットをもつ、モデルのブロック線図を開きます。

open_system(hCs.getModel);

get_param

目的

コンフィギュレーション セット パラメーターの値を取得します。

構文

get_param(paramName)

引数

paramName

値が返されるパラメーターの名前を指定する文字列。

説明

このメソッドは、指定したパラメーターの値を返します。paramName'ObjectParameters' として指定すると、コンフィギュレーション セット内の有効なパラメーターの名前を返します。

次のコマンドは、選択されたモデルのアクティブなコンフィギュレーションにより使用されるソルバーの名前を取得します。

hAcs = getActiveConfigSet(bdroot);
hAcs.get_param('SolverName');

    メモ:    モデルのアクティブなコンフィギュレーション セットのパラメーター値を取得するために get_param モデルの作成コマンドも使用できます。たとえば、get_param(bdroot, 'SolverName') は、現在選択されたモデルのソルバー名を取得します。

isActive

目的

コンフィギュレーション セットが、モデルのアクティブなコンフィギュレーション セットであるかどうかを判定します。

構文

isActive

説明

このコンフィギュレーション セットが、このコンフィギュレーション セットをもつモデルのアクティブ コンフィギュレーション セットである場合、true を返します。

isValidParam

目的

指定したパラメーターがコンフィギュレーション セットの有効なパラメーターであるかどうかを判定します。パラメーターは、コンフィギュレーション セットの他のパラメーターと互換である場合に有効です。たとえば、SolverType'variable-step' の場合、FixedStep は無効なパラメーターです。

構文

isValidParam(paramName)

引数

paramName

パラメーターが有効であるかどうか判定する場合に、そのパラメーターのパラメーター名を指定する文字列。

説明

このメソッドは、指定したパラメーターがこのコンフィギュレーション セットの有効なパラメーターである場合は true を返します。そうでない場合は false を返します。

次のコードは、現在選択されているアクティブなコンフィギュレーション セットでパラメーター StopTime が有効なパラメーターである場合に限り、このパラメーターを設定します。

hAcs = getActiveConfigSet(gcs);
if hAcs.isValidParam('StopTime')
	set_param('StopTime', '20');
end

saveAs

目的

コンフィギュレーション セットを MATLAB ファイルに保存します。

構文

saveAs(fileName)
saveAs(fileName, 'paramName', paramValue)

引数

fileName

メソッドが作成する MATLAB ファイルの名前を指定する文字列。

paramName, paramValue

オプションで MATLAB ファイルの形式を設定するために使用するパラメーターの名前と値のペア。

名前
'-format'
  • 'MATLAB function' (既定の設定) — MATLAB 関数を作成します。

  • 'MATLAB script' — MATLAB スクリプトを作成します。

'-comments'
  • 'on' (既定の設定) — MATLAB ファイル:

    • パラメーターの特定に役立つコメントとしてのパラメーターの GUI 名が含まれています。

    • 表示される [コンフィギュレーション パラメーター] ダイアログ ボックスのペインでパラメーターをグループ分けします。

  • 'off' — MATLAB ファイルにコメントが含まれていないため、ファイルの生成が高速化されます。

'-varname'

'variable' — 任意の有効な変数名。このパラメーターを指定しない場合、MATLAB スクリプトは変数に cs を使用します。

'-format', 'MATLAB script' を指定する場合は、'-varname', 'variable' を使用して、スクリプトがコンフィギュレーション セット オブジェクトに使用する変数を指定します。スクリプトを実行すると、スクリプトはベース ワークスペースに変数を作成します。

説明

saveAs(fileName) はコンフィギュレーション セットを MATLAB ファイルに保存します。保存する前に、コンフィギュレーション セットに対するハンドルを取得しなければなりません。fileName を使用してファイル名を指定します。

saveAs(fileName, 'paramName', paramValue) は 1 つまたは複数のコンマ区切りパラメーター名と値のペアを受け入れます。有効なパラメーター名と値のペアについては、前の引数の節を参照してください。

次のコードは sldemo_counters のコンフィギュレーション セットを取得し、ConfiguredDataFunction と言う関数を作成します。

% Get the active configuration set from sldemo_counters.
hCs = getActiveConfigSet('sldemo_counters');
% Save the configuration set as a function.
hCs.saveAs('ConfiguredDataFunction');

次のコードは sldemo_counters のコンフィギュレーション セットを取得し、ConfiguredDataScript と言うスクリプトを作成します。スクリプトは変数名に config_set を使用します。

% Get the active configuration set from sldemo_counters.
hCs = getActiveConfigSet('sldemo_counters');
% Save the configuration set as a script.
hCs.saveAs('ConfiguredDataScript', '-format', 'MATLAB script', '-varname', 'config_set');

参考

getActiveConfigSet, getConfigSet

setPropenabled

目的

変更されるコンフィギュレーション セット パラメーターを有効にします。

構文

setPropEnabled(paramName, isenabled)

引数

paramName

値が設定されるパラメーターの名前。

isenabled

パラメーターを有効にする場合は true と指定し、無効にする場合は false と指定します。

説明

このメソッドは、paramName によって指定されるパラメーターのイネーブル ステータスを isenabled によって指定される値に設定します。パラメーターをディセーブルにすると、ユーザー側でパラメーターを変更できなくなります。

以下のコードにより、現在選択されているモデルのシミュレーション停止時間を、ユーザーが設定することはできなくなります。

hAcs = getActiveConfigSet(gcs);
hAcs.setPropEnabled('StopTime', false);

set_param

目的

コンフィギュレーション セット パラメーターの値を設定します。

構文

set_param(paramName, paramValue)

引数

paramName

値が設定されるパラメーターの名前。

paramValue

パラメーターに割り当てられる値。

説明

このメソッドは、paramName で指定されるコンフィギュレーション セット パラメーターを、paramValue で指定される値に設定します。

次のコマンドは、選択されたアクティブなコンフィギュレーション セットのシミュレーション停止時間を設定します。

hAcs = getActiveConfigSet(gcs);
hAcs.set_param('StopTime', '20');

    メモ:    また、アクティブなコンフィギュレーション セットのパラメーターを設定するために、モデルを作成するコマンド set_param を使用することもできます。たとえば、set_param(gcs, 'StopTime', '20') は、現在選択されているモデルのシミュレーション停止時間を設定します。

この情報は役に立ちましたか?