Simulink.defineIntEnumType

列挙データ型を定義

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

構文

Simulink.defineIntEnumType(ClassName,"Members",{{EnumName1,EnumIntValue1},...,{EnumNameN,EnumIntValueN}})
Simulink.defineIntEnumType(ClassName,"Members",{{EnumName1,EnumIntValue1,"Description",EnumDescription1},...,{EnumNameN, EnumIntValueN,"Description",EnumDescriptionN}})
Simulink.defineIntEnumType(___,Name=Value)

説明

Simulink.defineIntEnumType(ClassName,"Members",{{EnumName1,EnumIntValue1},...,{EnumNameN,EnumIntValueN}}) は、各メンバーがそれぞれ EnumName と EnumIntValue で指定された名前と数値をもつ ClassName という名前の列挙を定義します。

例

Simulink.defineIntEnumType(ClassName,"Members",{{EnumName1,EnumIntValue1,"Description",EnumDescription1},...,{EnumNameN, EnumIntValueN,"Description",EnumDescriptionN}}) は、前の構文と同様に各メンバーが名前と数値をもち、オプションとして EnumDescription で指定された説明を含む ClassName という名前の列挙を定義します。

例

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

例

例

すべて折りたたむ

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

TrafficColors.Red(0),TrafficColors.Yellow(1),TrafficColors.Green(2)

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

Simulink.defineIntEnumType("TrafficColors", ... 
	"Members",{{"Red",0,"Description","Stop!"}, ...
       {"Yellow",1,"Description","Prepare to stop!"}, ...
       {"Green",2,"Description","Go!"}}, ... 
	Description="Traffic light colors", ...
	DefaultValue="Green", ...
	HeaderFile="mytrafficcolors.h", ...
	DataScope="Imported", ...
	AddClassNameToEnumNames=true, ...
	StorageType="int16", ...
      IsTunableInCode=true);

入力引数

すべて折りたたむ

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

例: BasicColors

データ型: char | string

列挙メンバー名。文字ベクトルまたは string スカラーとして指定します。

例: "Yellow"

データ型: char | string

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

例: 1

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

R2026a 以降

列挙メンバーの説明。文字ベクトルまたは string スカラーとして指定します。

例: "Prepare to stop!"

データ型: char | string

名前と値の引数

すべて折りたたむ

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

例: Simulink.defineIntEnumType("TrafficColors","Members",{{"Red",0,"Description","Stop!"},{"Yellow",1,"Description","Prepare to stop!"},{"Green",2,"Description", "Go!"}},HeaderFile="mytrafficcolors.h",DataScope="Imported"); は、DataScope を Imported に設定し、コード ジェネレーターで列挙型定義を外部ファイル mytrafficcolors.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 および MISRA C:2023 の違反を回避するには、データ スコープの選択を [インポート] または [エクスポート] に設定します。

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

例: 'mybasiccolors.h'

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

例: true

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

例: "int16"

R2025a 以降

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

例: true

バージョン履歴

R2010b で導入

すべて展開する

参考

| | |

トピック