Simulink.defineIntEnumType

列挙データ型を定義

ページ内をすべて折りたたむ

構文

Simulink.defineIntEnumType(ClassName,CellOfEnums,IntValues)
Simulink.defineIntEnumType(ClassName,CellOfEnums,IntValues,Name=Value)

説明

Simulink.defineIntEnumType(ClassName,CellOfEnums,IntValues) は、CellOfEnums で指定された列挙値および IntValues により指定された基本的な数値により ClassName という名前の列挙を定義します。

例

Simulink.defineIntEnumType(ClassName,CellOfEnums,IntValues,Name=Value) は、前述の構文の入力引数に加えて、1 つ以上の名前と値の引数を使用してオプションを指定します。たとえば、データ型定義を外部ヘッダー ファイルからインポートするには、DataScope を Imported に設定します。

例

すべて折りたたむ

外部データ ディクショナリに次の列挙型が含まれるとします。

BasicColors.Red(0), BasicColors.Yellow(1), BasicColors.Blue(2)

列挙クラス定義をヘッダー ファイル mybasiccolors.h から MATLAB® ワークスペースにインポートします。生成コードの列挙値を調整可能にし、基となる整数データ型として int16 を指定します。

Simulink.defineIntEnumType(BasicColors, ... 
	{"Red","Yellow","Blue"},[0;1;2], ... 
	Description="Basic colors", ...
	DefaultValue="Blue", ...
	HeaderFile="mybasiccolors.h", ...
	DataScope="Imported", ...
	AddClassNameToEnumNames=true, ...
	StorageType="int16", ...
      IsTunableInCode=true);

入力引数

すべて折りたたむ

列挙データ型の名前。文字ベクトルまたは string として指定します。

例: BasicColors

列挙データ型。文字ベクトルまたは string の cell 配列として指定します。

例: {"Red", "Yellow", "Blue"}

列挙型の数値。配列として指定します。uint32 ベースの列挙の場合、列挙値は intmax('int32') 以下でなければなりません。

例: [0;1;2]

名前と値の引数

すべて折りたたむ

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

例: Simulink.defineIntEnumType(BasicColors, ...{"Red","Yellow","Blue"},[0;1;2],DataScope,"Imported",FileName,"MyBasicColors.h"); は、ScopeSelection を Imported に設定し、コード ジェネレーターで列挙型定義を外部ファイル mybasiccolors.h からインポートするように指定します。

列挙データ型の説明。文字ベクトルまたは string として指定します。

例: "Basic colors"

既定の列挙値。文字ベクトルまたは string として指定します。値は CellOfEnums に指定した値のいずれかです。

例: "Blue"

コード生成時のデータ型定義に対するアクション。次の値のいずれかとして指定します。

  • "Auto" — HeaderFile に値を指定しなかった場合、型定義を model_types.h にエクスポートします (model はモデル名)。HeaderFile に値を指定した場合は、指定されたヘッダー ファイルからデータ型定義をインポートします。

  • "Exported" — ヘッダー ファイルにデータ型定義をエクスポートします。HeaderFile に値を指定しなかった場合、ヘッダー ファイル名の既定値は type.h になります (type はデータ型名)。

  • "Imported" — ヘッダー ファイルからデータ型定義をインポートします。HeaderFile に値を指定しなかった場合、ヘッダー ファイル名の既定値は type.h になります (type はデータ型名)。

MISRA C:2012 の違反を回避するには、データ スコープの選択を [インポート] または [エクスポート] に設定します。

データ型定義を含む外部ヘッダー ファイル。文字ベクトルまたは string として指定します。既定では、生成された #include 命令は、< および > の代わりに、プリプロセッサの区切り記号である " を使用します。命令 #include <mytypes.h> を生成するには、FileName を '<myTypes.h>' として指定します。

例: 'mybasiccolors.h'

コード ジェネレーターがクラス名を列挙型の接頭辞として適用するかどうか。数値または logical 1 (true) または 0 (false) として指定します。

例: true

生成されたコードで列挙の基となる整数値の格納に使用されるデータ型。string として指定します。

例: "int16"

R2025a 以降

生成コードでの列挙値の調整可能性 (変更、追加、並べ替え) を有効にするオプション。数値または logical 1 (true) または 0 (false) として指定します。この引数を true に設定するには、DataScope を "Imported" に設定する必要があります。

例: true

バージョン履歴

R2010b で導入

参考

| | |

トピック