生成されたコードでのデータ表示を制御するストレージクラスの選択

"ストレージクラス" は、パラメーター、信号、状態などのデータに適用するコード生成設定です。コードの構成時に、ストレージクラスを使用して生成コード内でのデータ要素の外観および配置を制御したり、最適化によってそのデータ要素のストレージが削除されることを防ぎます。

モデルデータについては、コードマッピングエディターまたはコードマッピング API を使用して、ストレージクラスをモデルデータ要素に直接適用できます。エディターまたは API のいずれかを使用して、データのカテゴリに対して既定のストレージクラスを適用してから、必要に応じて個々のデータ要素の設定をオーバーライドします。

外部データについては、モデルエクスプローラーを使用してストレージクラスをデータオブジェクトに適用するか、get_param および set_param などの関数を使用してプログラムによって適用します。

要素または要素カテゴリのストレージクラスを指定したら、ヘッダーファイル、定義ファイル、メモリセクションなど、そのストレージクラスのプロパティを設定できます。

ストレージクラスプロパティ

ストレージクラスのプロパティ設定によって、コードジェネレーターが生成コード内でデータを表す方法と場所を定義します。ストレージクラスのユーザーが設定できるプロパティは、ストレージクラスによって異なります。ほとんどの個別要素に対して、ユーザーはコード内のデータ要素に名前を付けるために識別子を設定できます。事前定義されたストレージクラス用にユーザーが設定できるプロパティを特定するには、特定のストレージクラスに関する以下の情報を確認してください。

カスタムストレージクラスデザイナーを使用してストレージクラスを作成する場合は、ストレージクラスのユーザーが追加設定を指定できるかどうかを選択できます。ストレージクラスのユーザーによるプロパティ値の指定を許可を参照してください。

既定のストレージクラス

既定では、個々のデータ要素のストレージクラスは Auto です。この既定値を使用すると、ストレージクラスの選択と適用をコードジェネレーターで処理することになります。この場合、データ要素はコード生成の最適化の対象となり、コードから要素が削除されたり、要素の表示が変更されたりする場合があります。最適化によってデータ要素が削除されない場合、その要素は生成されたコード内で標準のデータ構造体のフィールドとして表示されます。

コードマッピングエディターまたはコードマッピング API の使用時に、最適化によって削除されないストレージクラス Auto を使用して構成されたデータ要素は、対応するデータカテゴリの既定のコード生成設定を取得します。データ要素のカテゴリに対してコードの構成を指定しない場合、ストレージクラスは Default になります。データ要素カテゴリでこのストレージクラスが使用されている場合、そのカテゴリに含まれるデータ要素は生成されたコード内で標準データ構造体のフィールドとして表示されます。

組み込みおよび事前定義済みストレージクラス

最適化によってデータ要素のストレージが削除されることを防ぐには、コード生成の要件に基づいて要素のストレージクラスを選択します。使用可能なストレージクラスには、組み込みストレージクラスと Simulink パッケージの事前定義済みストレージクラスが含まれます。また、Embedded Coder ディクショナリで定義されているその他のプロジェクト固有のストレージクラスが含まれる場合もあります。リストされているストレージクラスでは満たされない特別な要件があり、ERT ベースのターゲット向けのコードを生成している場合、新しいストレージクラスを定義して使用することができます。Define Service Interfaces, Storage Classes, Memory Sections, and Function Templates for Software Architectureおよびカスタムストレージクラスデザイナーを使用したストレージクラスの作成を参照してください。

Simulink^® Coder™ では、事前定義された以下の組み込みストレージクラスから選択できます。

要件	ストレージクラス
より効率的なコードを生成するように、最適化を有効にする。	Auto (個別データ要素)
最適化できないデータ要素の場合、データを標準のデータ構造体のフィールドとして表す。	既定値 (既定のマッピング)
最適化によってデータ要素のストレージが削除されることを防ぐ。	Model Default (個別のマッピング)
スタンドアロンのグローバル変数からデータにアクセスする。生成されたコードには変数の宣言と定義が含まれます。	ExportedGlobal
スタンドアロンのグローバル変数からデータにアクセスする。生成されたコードには変数の宣言が含まれます。外部コードによって定義が提供されます。	ImportedExtern、ImportedExternPointer

Embedded Coder^® をお持ちの場合、Simulink パッケージで使用できる、以下のような追加の事前定義済みストレージクラスから選択できます。

要件	ストレージクラス
最適化によってデータ要素のストレージが削除されることを防ぐ。	Dictionary Default (既定のマッピング)
スタンドアロンの変数を生成する。	ExportToFile ImportFromFile FileScope Localizable Reusable Const、Volatile、および ConstVolatile
構造体のフィールドとして変数を生成する。	struct ビットフィールド
コードのコンパイル中に修正される値をもつ変数を生成する。	Define、ImportedDefine CompilerFlag
関数呼び出しを通してアクセスする変数を生成する。	GetSet
単一インスタンスデータに対しては変数、マルチインスタンスデータに対しては構造体を生成する。	MultiInstance

これらのストレージクラスは Embedded Coder ディクショナリに追加できるストレージクラスの例です。これらの例は、クイックスタートツールを使用してコード生成用のモデルを準備する際に定義され、利用可能になります。

要件	ストレージクラス
パラメーターデータおよび信号または状態データを含むグローバル構造体を生成する。	ParamStruct、SignalStruct

メモ

ベースワークスペースまたはデータディクショナリで非自動ストレージクラスを使用して定義された信号オブジェクトは、ERT ベースのシステムターゲットファイルとサービスコードインターフェイスで構成されたモデルではサポートされません。

Auto

このストレージクラスを選択すると、コードジェネレーターは、生成されたコード内でのデータの表現方法を処理し、最適化がデータ要素に作用するようにして、より効率的なコードを生成できるようになります。

Auto はモデル内の各データ要素の既定のストレージクラスです。データ要素はコード生成の最適化の対象となり、コードから要素が消去されたり、要素の表示が変更されたりする場合があります。[コンフィギュレーションパラメーター] 、 [コード生成] 、 [最適化] ペインでの最適化など、これらの最適化の詳細については、生成されたコードによる内部信号、状態、パラメーターデータの保存方法を参照してください。

最適化によって、ほとんどのブロック状態など、一部のデータはコードから削除されません。残りのデータは、コードマッピングエディターの [Data Defaults] タブで指定する既定のストレージクラスを取得します (Configure Default Code Generation for Dataを参照)。データ要素を削除できない場合、コード内の要素の名前は、モデルコンフィギュレーションパラメーターを使用して指定する命名規則に基づいています。Identifier Format Controlを参照してください。Embedded Coder が必要です。

既定値

コードマッピングエディターの [Data Defaults] タブでは、Default は各データ要素カテゴリ用の既定のストレージクラス設定です。カテゴリのストレージクラス設定をこの値のままにした場合、コード生成最適化の対象でないデータ要素は標準データ構造体のフィールドとして表示されます。生成されたコードによる内部信号、状態、パラメーターデータの保存方法を参照してください。

Model Default

コード生成用に個別のデータ要素を設定するときに、Model Default ストレージクラスを使用して、最適化によってデータ要素のストレージが削除されることを防ぎます。生成されたコードによる内部信号、状態、パラメーターデータの保存方法を参照してください。このストレージクラス設定では、データ要素は、コードマッピングエディターの [Data Defaults] タブで対応するデータカテゴリに対して指定した既定のストレージクラスを取得します。コード内のデータ要素の名前は、モデル内での名前と同じです。

Dictionary Default

Embedded Coder では、データのカテゴリに対して既定のコード定義を設定するコーダーディクショナリが含まれるデータディクショナリにモデルをリンクする場合、コードマッピングエディターを使用してディクショナリの既定の設定を適用できます。[Data Defaults] タブで、カテゴリを選択し、ストレージクラスを Dictionary Default に設定します。コーダーディクショナリで既定のコードマッピングを設定する方法の詳細については、Configure Default Code Mapping in a Shared Dictionaryを参照してください。

ExportedGlobal

この組み込みストレージクラスを使用して、グローバル変数の定義と宣言を生成します。既定では、変数の名前はデータ要素の名前です。コードでは、生成されたファイル model.h で変数が宣言されます。これは外部コードにインクルード (#include) できます。このグローバル変数は、コードジェネレーターによって生成コードから最適化されることはありません。

このストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。

このストレージクラスを使用する例については、C Data Code Interface Configuration for Model Interface Elementsを参照してください。

ImportedExtern、ImportedExternPointer

モデル内のデータ要素が、外部コードによって定義されたグローバル変数を表すようにするには、組み込みストレージクラス ImportedExtern を使用します。生成されたアルゴリズムコードでは変数を定義せずに使用します。

外部コードで定義されたグローバル変数に対して読み取りと書き込みを実行するコードを生成します。生成されたコードでは、生成されたファイル model_private.h 内で変数を宣言し、モデルのエントリポイント関数が変数に対して読み取りと書き込みをできるようにします。

たとえば、ストレージクラス ImportedExtern を信号線、ブロックの状態、パラメーターオブジェクトに適用できます。インポートしたデータには以下が適用されます。

生成されたコードはパラメーターデータを初期化しない。インポートしたパラメーターデータはコードで初期化しなければなりません。
生成した初期化関数は一部の信号と状態データを動的に初期化する。生成されたコードによって割り当てられるデータとは異なり、コードは、インポートした信号または状態データを保存されたゼロの値に初期化しません。その代わり、コードはデータを Simulink で指定した実際の非ゼロ値にすぐに初期化します。

メモ
Initialize Function ブロックで指定したゼロ値にインポートされたスコープが含まれている場合でも、これらのゼロ値はコードジェネレーターで初期化されます。

外部コードでデータ要素を定義し、そのデータにアクセスするためのポインターを提供する場合は、ImportedExternPointer を使用します。生成されたコードは、そのポインターに対して読み書きを行います。生成されたコードでは生成されたファイル model_private.h 内で変数を宣言し、ポインターを逆参照してデータに対する読み取りと書き込みを行います。

これらのストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。

ビットフィールド

このストレージクラスを使用して、boolean、固定小数点、整数のデータを名前付きビットフィールドに保存する構造体を生成します。

このストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。
`StructName`	生成されたコード内でのデータ要素の構造体の名前。

このストレージクラスを使用する例については、ビットフィールドを参照してください。

CompilerFlag

このストレージクラスを使用して、コンパイラフラグまたはオプションを使用して定義されたプリプロセッサの条件をサポートします。

Embedded Coder を使用して生成コードをビルドする場合、コンパイラオプションを指定するには、モデルコンフィギュレーションパラメーター [コンフィギュレーションパラメーター] 、 [コード生成] 、 [カスタムコード] 、 [コード情報] 、 [定義] を使用できます。[コード生成] ペイン: カスタムコード: 追加のビルド情報: 定義を参照してください。

このストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。

このストレージクラスを使用する例については、Compile Code Conditionally for Variations of Component Represented Using Variant Blockを参照してください。

Const、Volatile、および ConstVolatile

これらのストレージクラスを使用して、グローバル変数の定義と宣言を const、volatile、または const および volatile 型修飾子を使用して生成します。

これらのストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。
`HeaderFile`	データ要素および外部コードによって読み取られるグローバルデータの宣言を含むソースヘッダーファイル。
`DefinitionFile`	データ要素および外部コードによって読み取られるグローバルデータの定義を含むソース定義ファイル。
`Owner`	データを使用する複数のコンポーネントのいずれかのために生成されたコードで定義されているグローバルデータのオーナー。
`PreserveDimensions`	モデルコンフィギュレーションパラメーター [配列のレイアウト] が `[行優先]` に設定されている場合、生成されたコード内で多次元配列として表されるデータ要素の次元を保持するかどうかを示すフラグ。

このストレージクラスを使用する例については、型修飾子を参照してください。

Define、ImportedDefine

Define ストレージクラスを使用して、#define myParam 5 などのマクロ (#define 命令) を生成します。

ImportedDefine を使用して、外部コードのヘッダーファイルで定義されるマクロ (#define 命令) を使用するコードを生成します。例については、マクロ定義 (#define)を参照してください。

これらのストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。
`HeaderFile`	データ要素および外部コードによって読み取られるグローバルデータの宣言を含むソースヘッダーファイル。

このストレージクラスを使用するデータ要素は、コード記述子 API や生成された ARXML 記述には表示されません。コード記述子 API の詳細については、参照してください。ARXML 記述の生成については、AUTOSAR C コードおよび XML 記述の生成 (AUTOSAR Blockset)を参照してください。

ExportToFile

外部ファイルに対するグローバル変数の定義と宣言を生成します。変数を定義して宣言するファイルの名前と配置を指定できます。Control Placement of Global Data Definitions and Declarations in Generated Filesを参照してください。

このストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。
`HeaderFile`	データ要素および外部コードによって読み取られるグローバルデータの宣言をコードジェネレーターが配置するソースヘッダーファイル。
`DefinitionFile`	データ要素および外部コードによって読み取られるグローバルデータの定義をコードジェネレーターが配置するソース定義ファイル。コードジェネレーターはこの設定を単一インスタンスのモデルにのみ適用します。データ定義は親レベルで処理されるため、この設定は再利用可能なマルチインスタンスのモデルで無視されます。
`Owner`	コードジェネレーターが、階層の最上位レベルコンポーネントに配置する代わりに、グローバルデータ定義を配置するモデルの階層構造内のコンポーネント。モデルコンフィギュレーションパラメーター [データ定義の配置にデータオブジェクトからオーナーを使用する] を設定する必要があります。
`PreserveDimensions`	モデルコンフィギュレーションパラメーター [配列のレイアウト] が `[行優先]` に設定されている場合、生成されたコード内で多次元配列として表されるデータ要素の次元を保持するかどうかを示すフラグ。

このストレージクラスを使用する例については、パラメーターデータの定義、初期化および宣言を参照してください。

FileScope

このストレージクラスを使用して、static 型修飾子をもつグローバル変数の定義と宣言を生成します。生成されたコードで、変数のスコープは現在のファイル (通常は model.c) に制限されます。

モデルの参照階層で、参照モデルが、ベースワークスペースまたはデータディクショナリで作成したパラメーターオブジェクト (Simulink.Parameter など) を使用する場合、FileScope をオブジェクトに適用できません。回避策として、パラメーターオブジェクトを参照モデルのモデルワークスペースに移動します。これで、FileScope を使用できます。

このストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。
`PreserveDimensions`	モデルコンフィギュレーションパラメーター [配列のレイアウト] が `[行優先]` に設定されている場合、生成されたコード内で多次元配列として表されるデータ要素の次元を保持するかどうかを示すフラグ。

GetSet

このストレージクラスを使用して、カスタムのアクセサー関数を呼び出してデータを処理するコードを生成します。外部コードでデータを定義し、関数定義を提供します。

このストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。
`HeaderFile`	関数 `get` と関数 `set` の宣言を含むソースヘッダーファイル。
`GetFunction`	生成されたコード内で、指定された関数 `get` の呼び出しとして表示されるデータ要素。
`SetFunction`	生成されたコード内で、指定された関数 `set` の呼び出しとして表示されるデータ要素。
`PreserveDimensions`	モデルコンフィギュレーションパラメーター [配列のレイアウト] が `[行優先]` に設定されている場合、生成されたコード内で多次元配列として表されるデータ要素の次元を保持するかどうかを示すフラグ。

このストレージクラスを使用する例については、Access Data Through Functions with Storage Class GetSetを参照してください。

ImportFromFile

このストレージクラスを使用して、外部コードによって定義されているグローバル変数に対して読み書きを行うコードを生成します。ImportFromFile は ExportToFile に類似していますが、生成されたコードは変数を定義しません。

このストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。
`HeaderFile`	データ要素および外部コードによって読み取られるグローバルデータの宣言を含むソースヘッダーファイル。リンカーエラーを回避するには、ヘッダーファイルの先頭にインクルードガードを含める必要があります。
`PreserveDimensions`	モデルコンフィギュレーションパラメーター [配列のレイアウト] が `[行優先]` に設定されている場合、生成されたコード内で多次元配列として表されるデータ要素の次元を保持するかどうかを示すフラグ。

このストレージクラスを使用する例については、Integrate External Application Code with Code Generated from PID Controllerを参照してください。

Localizable

可能であれば、ローカル変数を使用して、信号に対するグローバルストレージの使用を最小限に抑えます。

変数が 1 つの関数で使用されている場合、その変数はその関数に対してローカルです。
変数が 1 つのファイルで使用されている場合、その変数はそのファイルに対してローカルです。
変数が 1 つを超える関数またはファイルで使用されている場合、その変数はグローバルです。

ローカル変数を生成すると、コードジェネレーターによって変数が生成コードから削除されることはありません。

このストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。
`PreserveDimensions`	モデルコンフィギュレーションパラメーター [配列のレイアウト] が `[行優先]` に設定されている場合、生成されたコード内で多次元配列として表されるデータ要素の次元を保持するかどうかを示すフラグ。

このストレージクラスを使用する例については、Generate Local Variables with Localizable Storage Classを参照してください。

Reusable

このストレージクラスを使用して、モデル内の独立した複数の信号に対して同じ変数を再利用します。コードジェネレーターは、単一の再利用されるグローバル変数にデータパスの中間計算 (一連の接続されたブロック) を保存します。

このストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。

このストレージクラスを使用する例については、Specify Buffer Reuse for Signals in a Pathを参照してください。

struct

このストレージクラスを使用して、指定可能な名前をもつグローバル構造体を生成します。

このストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。
`StructName`	生成されたコード内でのデータ要素の構造体の名前。

このストレージクラスを使用する例については、Struct ストレージクラスを使用してパラメーターデータを構造体に整理するおよび信号の構造体を参照してください。

MultiInstance

単一インスタンスデータに対しては構造化されていない変数、マルチインスタンスデータに対しては構造体を生成するには、このストレージクラスを使用します。このストレージクラスをデータ項目に適用すると、Embedded Coder ディクショナリはそれが単一インスタンスストレージクラスまたはマルチインスタンスストレージクラスであるかを決定します。ディクショナリは、データのタイプとモデル参照階層におけるモデルのコンテキストによってクラスのタイプを決定します。このストレージクラスを複製して、編集可能なコピーを作成できます。

このストレージクラスを個別のデータ要素に適用すると、[識別子] プロパティも設定できます。[識別子] プロパティは、生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列です。

このストレージクラスを使用する例については、モデルの階層構造の異なるコンテキストに対応する柔軟なストレージクラスを参照してください。

ParamStruct、SignalStruct

これらのストレージクラスを使用して、パラメーターと信号または状態データを含むグローバル構造体をそれぞれ生成します。コンポーネント (参照モデルまたは Atomic Subsystem) の階層で、これらのストレージクラスを使用して対応する構造体の階層を作成できます。これらのストレージクラスがコードマッピングエディターに表示されるのは、クイックスタートツールを使用してコード生成用のモデルを準備した後になります。

これらのストレージクラスは、モデルが所有するデータに対してのみ使用可能です。

これらのストレージクラスを使用するときに、以下のプロパティも設定できます。

プロパティ	説明
`Identifier`	生成されたコード内のデータ要素に名前を付けるためにコードジェネレーターが使用する識別文字列。

ストレージクラスの制限

コードマッピングエディター (Embedded Coder) またはコードマッピング API でストレージクラスを使用する場合、いくつかの制限が適用されます。Limitationsを参照してください。
データオブジェクトでは、Embedded Coder ストレージクラスとマルチワードデータ型を使用できません。
参照モデルを使用するモデルの Embedded Coder ストレージクラスの場合は、次のようになります。
- グループ化されたストレージクラス (Struct または Bitfield など) を複数のデータ項目に適用する場合、ストレージクラス [データスコープ] プロパティを [Imported] に設定しなければならず、外部ヘッダーファイルでデータ宣言を指定しなければなりません。グループ化されたストレージクラスでは、生成されたコードで単一の変数を使用して、複数のデータオブジェクトを表します。
- パラメーターオブジェクトがベースワークスペースまたはデータディクショナリ内に存在し、参照モデルがそのオブジェクトを使用する場合、ストレージクラス FileScope を適用できません。このストレージクラスをパラメーターオブジェクトに適用するには、オブジェクトを参照モデルのモデルワークスペースに移動します。
ストレージクラス FileScope は、データ交換インターフェイス (C API、エクスターナルモード、または ASAP2) または MAT ファイルロギングで使用されるデータ項目に適用できません。ファイルスコープのデータには外部からアクセスできません。
ストレージクラス FileScope を複数のファイルで使用されているデータに適用することはできません。
Simulink Function ブロックに入力される信号にストレージクラス Reusable は適用できません。