Main Content

Simulink.defineIntEnumType

列挙データ型を定義

説明

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

Simulink.defineIntEnumType(___,'Description',ClassDesc) は記述で列挙を定義します。

Simulink.defineIntEnumType(___,'DefaultValue',DefValue) は列挙型に対する既定の値を定義します。これは CellOfEnums に指定する文字ベクトルの 1 つです。

Simulink.defineIntEnumType(___,'DataScope',ScopeSelection) はコード生成時にヘッダー ファイルからデータ型定義をインポートまたはエクスポートするかを指定します。

Simulink.defineIntEnumType(___,'HeaderFile',FileName) はモデルから生成されたコードで使用する列挙型クラス定義が含まれるヘッダー ファイルの名前を指定します。

Simulink.defineIntEnumType(___,'AddClassNameToEnumNames',Flag) は、コード ジェネレーターがクラス名を CellOfEnums に指定する列挙値の接頭辞として適用するかどうかを指定します。Flag には、true または false を指定します。たとえば、true を指定すると、コード ジェネレーターは Red ではなく、BasicColors.Red を使用して列挙値を表します。

Simulink.defineIntEnumType(___,'StorageType',DataType) はモデルから生成されたコードで列挙型の基となる整数値を保存する際に使用するデータ型を指定します。

すべて折りたたむ

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

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

生成されたコードの基となる整数データ型として int16 を指定する際に、列挙型クラス定義を MATLAB® ワークスペースにインポートします。

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

入力引数

すべて折りたたむ

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

例: 'BasicColors'

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

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

列挙型の数値。配列として指定します。

例: [0;1;2]

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

例: 'Basic colors'

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

例: 'Blue'

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

例: 'mybasiccolors.h'

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

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

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

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

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

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

例: true

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

例: 'int16'

バージョン履歴

R2010b で導入