ドキュメンテーション

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

Simulink.defineIntEnumType

列挙データ型を定義

構文

Simulink.defineIntEnumType(ClassName, CellOfEnums, IntValues)
Simulink.defineIntEnumType(ClassName, CellOfEnums, IntValues, 'Description', ClassDesc)
Simulink.defineIntEnumType(ClassName, CellOfEnums, IntValues, 'DefaultValue', DefValue)
Simulink.defineIntEnumType(ClassName, CellOfEnums, IntValues, 'DataScope', ScopeSelection)
Simulink.defineIntEnumType(ClassName, CellOfEnums, IntValues, 'HeaderFile', FileName)
Simulink.defineIntEnumType(ClassName, CellOfEnums, IntValues, 'AddClassNameToEnumNames', Flag)
Simulink.defineIntEnumType(ClassName, CellOfEnums, IntValues, 'StorageType', DataType)

説明

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

Simulink.defineIntEnumType(ClassName, CellOfEnums, IntValues, 'Description', ClassDesc) は記述 (文字ベクトル) で列挙を定義します。

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

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

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

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

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

入力引数

ClassName

列挙データ型の名前。

CellOfEnums

列挙データ型を定義する文字ベクトルの cell 配列。

IntValues

データ型の列挙に対応する数値の配列。

'Description', ClassDesc

列挙データ型を記述する文字ベクトルを指定します。

'DefaultValue', DefValue

既定の列挙値を指定します。

'HeaderFile', FileName

データ型定義を含むヘッダー ファイルに名前を付ける文字ベクトルを指定します。

既定では、生成された #include 命令は、< および > の代わりに、プリプロセッサの区切り記号である " を使用します。命令 #include <myTypes.h> を生成するには、FileName'<myTypes.h>' として指定します。

'DataScope', 'Auto' | 'Exported' | 'Imported'

コード生成時にヘッダー ファイルからデータ型定義をインポートまたはエクスポートするかを指定します。

アクション
Auto (既定の設定)

Headerfile に値を指定しなかった場合、型定義を model_types.h にエクスポートします (model はモデル名)。

Headerfile に値を指定した場合は、指定されたヘッダー ファイルからデータ型定義をインポートします。

Exported

ヘッダー ファイルに、データ型定義をエクスポートします。

Headerfile に値を指定しなかった場合、ヘッダー ファイル名の既定値は type.h になります (type はデータ型名)。

Imported

ヘッダー ファイルからデータ型定義をインポートします。

Headerfile に値を指定しなかった場合、ヘッダー ファイル名の既定値は type.h になります (type はデータ型名)。

'AddClassNameToEnumNames', Flag

コード ジェネレーターがクラス名を列挙型の接頭辞として適用するかどうかを指定する論理フラグ。

'StorageType', DataType

生成されたコードで列挙型の基となる整数値の格納に使用されるデータ型を識別する文字ベクトルを指定します。'int8''int16''int32''uint8' または 'uint16' のデータ型がサポートされます。

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

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');

R2010b で導入