ドキュメンテーション

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

Simulink.Parameter

ブロック パラメーターの値、値の範囲、データ型、およびその他のプロパティを指定

説明

このクラスによって、ワークスペース オブジェクトを作成できます。これを、Gain ブロックの Gain パラメーターの値のようなブロック パラメーターの値として使用できます。Simulink.Parameter オブジェクトは、ベース MATLAB® ワークスペースまたはモデル ワークスペースで作成可能です。しかし、オブジェクトをモデル ワークスペースで作成するには、オブジェクトのストレージ クラスに 自動 に設定しなければなりません。

パラメーター オブジェクトを使うとパラメーターの値だけでなく、パラメーターの目的、次元、最小値、最大値などのパラメーターに関するその他の情報も指定することができます。Simulink® 製品によってはこの情報を利用するものもあります。たとえば、Simulink と Simulink Coder™ 製品は、Simulink.Parameter オブジェクトが指定する情報を使ってパラメーターが調整可能かどうかを判断します (「ブロック パラメーター値の調整と試行」を参照)。

Simulink は、パラメーター値の範囲チェックを行います。パラメーター オブジェクトの値が、指定した最小値と最大値およびデータ型に対応する範囲外であるときに警告が表示されます。

[Simulink.Parameter] ダイアログ ボックスを使用すると、Simulink.Parameter オブジェクトを定義できます。このダイアログ ボックスを開くには、モデル エクスプローラーで、ベース ワークスペースまたはモデル ワークスペースを選択し、[追加][Simulink パラメーター] を選択します。

プロパティ ダイアログ ボックス

パラメーターの実世界での理想的な値。MATLAB 式を使用してパラメーターの次元と実数/複素数を指定できます。値を指定する適切な方法の例をテーブルに示します。

説明
15.23

スカラー値を指定します

[3 4; 9 8]

行列を指定します

3+2i

複素数値を指定します

struct('A',20,'B',5)

倍精度の値 205 をもつ 2 つの信号要素 AB から成るバス初期化用の構造体を指定します。

構造体の形と属性は、バスの要素の形状と属性に一致する必要があります。初期条件構造体の指定方法の詳細は、「バス信号の初期条件の指定」を参照してください。

Simulink.Parameter オブジェクトを使用して特定の数値データ型のパラメーターを表現するには、[値] プロパティを使用して理想値を指定し、[データ型] プロパティを使用して型を指定します。

たとえば、パラメーター オブジェクトを使用して数値 single(32.5) を表すには、[値] プロパティに 32.5 を、[データ型] プロパティに single を指定します。

single(32.5) のような型をもつ表現を使用して [値] を設定した場合、[データ型] プロパティは新しい型を反映するように変更されます。ベスト プラクティスは型のない表現を使用することです。このベスト プラクティスは、量子化の繰り返しや不完全なデータ型の飽和よる数値誤差の蓄積を避けるのに役立ちます (特に固定小数点データ型の場合)。

データ型

パラメーターのデータ型。コードをシミュレーションまたは生成するときに、Simulink は理想的なパラメーター値を指定されたデータ型にキャストします。

データ型はドロップダウン リストから選択することも、文字列を使用して型の名前を指定することもできます。文字列を指定する場合は、次のいずれかのエンティティに評価されなければなりません。

  • Simulink でサポートされている組み込みデータ型。サポートされているデータ型の一覧は、「Simulink でサポートされているデータ型」を参照してください。

  • Simulink.NumericType オブジェクト。この手法は固定小数点データ型の指定に使用できます。

  • Simulink.AliasType オブジェクト。

  • Simulink.Bus オブジェクト。

    バス エディターを使用して、バス オブジェクトをデータ型として使用する Simulink.Parameter オブジェクトを定義または編集できます。バス エディターでは次のいずれかの方法を使用します。

    • [ファイル][Simulink.Parameter オブジェクトの作成/編集] を選択します。

    • ツール バーの [Simulink.Parameter オブジェクトの作成/編集] をクリックします。

    新しいオブジェクトをカスタマイズするには、MATLAB エディターでコードを編集します。

  • 列挙データ型の名前。名前に Enum: の接頭辞を付けます。たとえば、myEnumType という列挙データ型を使用するには、'Enum: myEnumType' を指定します。

既定の設定の auto を選択した場合、ターゲット ブロックによってデータ型が決まります。たとえば、出力データ型が int8 である Constant ブロックの [定数値] パラメーターを、オブジェクトを使用して指定する場合、コードをシミュレーションまたは生成するときに、このブロックではパラメーター値を int8 にキャストします。

[データ型アシスタントを表示] ボタン をクリックして、[データ型] パラメーターに関する設定を行う [データ型アシスタント] を表示します 詳細は、「データ型アシスタントを利用したデータ型の指定」を参照してください。

単位

この値を表現する物理単位 (たとえばインチ)。単位を指定するには、テキスト ボックスに入力します。入力中、パラメーターには一致する可能性のある単位文字列が表示されます。詳細については、「Simulink モデルでの単位の指定」を参照してください。

次元

パラメーターの次元。Simulink は、このパラメーターの [値] フィールドの入力内容から、このパラメーターの次元を判断します。ユーザーはこのフィールドを設定できません。

実数/複素数

このパラメーターの数値型 (すなわち、実数または複素数)。Simulink は、このパラメーターの [値] フィールドの入力内容からこのパラメーターの数値型を判断します。ユーザーはこのフィールドを設定できません。

最小値

このパラメーターがもつことができる最小値。既定値は [] (指定なし) です。有限で実数の double のスカラー値を指定します。

    メモ:   パラメーターのデータ型としてバス オブジェクトを指定する場合はパラメーターのプロパティ ダイアログ ボックスでバス データの最小値を設定しないでください。Simulink によりこの設定は無視されます。代わりに、データ型として指定したバス オブジェクトのバス要素の最小値を設定してください。バス要素の最小値プロパティの詳細は、Simulink.BusElement を参照してください。

パラメーター値が最小値よりも小さいか、あるいは最小値がパラメーターのデータ型の範囲外である場合、Simulink は、警告を表示します。ブロック線図を更新するか、あるいはシミュレーションを開始するときは、Simulink はエラーを表示します。

最大値

このパラメーターがもつことができる最大値。既定値は [] (指定なし) です。有限で実数の double のスカラー値を指定します。

    メモ:   パラメーターのデータ型としてバス オブジェクトを指定する場合はパラメーターのプロパティ ダイアログ ボックスでバス データの最大値を設定しないでください。Simulink によりこの設定は無視されます。代わりに、データ型として指定したバス オブジェクトのバス要素の最大値を設定します。バス要素の最大プロパティの詳細は、Simulink.BusElement を参照してください。

パラメーター値が最大値よりも大きいかあるいは最大値がパラメーターのデータ型の範囲外である場合、Simulink は警告を表示します。ブロック線図を更新するか、あるいはシミュレーションを開始するときは、Simulink はエラーを表示します。

ストレージ クラス

このパラメーターのストレージ クラス。Simulink コード生成製品は、このプロパティを使用して、生成コードでこのパラメーターにメモリを割り当てます。詳細は、Simulink Coder ドキュメンテーションの「調整可能なパラメーター ストレージ クラス」および Embedded Coder® ドキュメンテーションの「Simulink Package Custom Storage Classes」を参照してください。

エイリアス

このパラメーターの別名。Simulink はこの設定を無視します。

配置

バイト数で指定するデータ配置境界。このパラメーターに割り当てられるデータの開始メモリ アドレスは [配置] 設定の倍数になります。既定値は -1 です。これは使用に基づいてコード ジェネレーターが最適な配置を決定することを指定します。それ以外の場合は 128 を超えない 2 のべき乗である正の整数を指定します。このフィールドは Simulink Coder ソフトウェアによって使用されることを意図しています (「Data Alignment for Code Replacement」を参照)。Simulink ソフトウェアはこの設定を無視します。

説明

このパラメーターの説明。このフィールドは、このパラメーターの説明を記述するためのものです。

Embedded Coder のライセンスがあれば、生成コードの変数宣言に対するコメントとして信号の説明を追加できます。

  • 信号オブジェクトのストレージ クラスを Auto 以外に指定します。

  • [モデル コンフィギュレーション パラメーター] ダイアログ ボックスの [コード生成][コメント] ペインで、モデル コンフィギュレーション パラメーター [Simulink データ オブジェクトの説明] を選択します。詳細は、「Simulink データ オブジェクトの説明」を参照してください。

プロパティ

名前

アクセス

説明

Value

RW

このパラメーターの値 ()。

CoderInfo

R

Simulink Coder がこのパラメーターのためのコードを生成するために使用する情報。このプロパティの値は、Simulink.CoderInfo クラスのオブジェクトです。

Description

RW

このパラメーターを説明する文字列。このプロパティはユーザーによる使用を目的としています。Simulink はこれを使用しません(説明)。

DataType

RW

このパラメーターのデータ型を指定する文字列 (データ型)。

Min

RW

このパラメーターがもつことができる最小値 (最小値)。

Max

RW

このパラメーターがもつことができる最大値 (最大値)。

Unit

RW

このパラメーターの値を表す物理単位 (単位)。

Complexity

RO

このパラメーターの数値型を指定する文字列。使用できる値は、'real' または 'complex' です (実数/複素数)。

Dimensions

RO

このパラメーターのサイズを指定するベクトル (次元)。

R2006a より前に導入

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