Main Content

Simulink.data.getEnumTypeInfo

列挙データ型に関する情報の取得

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

構文

information = Simulink.data.getEnumTypeInfo(enumTypeName,infoRequest)

説明

例

information = Simulink.data.getEnumTypeInfo(enumTypeName,infoRequest) は列挙データ型 enumTypeName に関する情報を返します。

この関数は列挙データ型に関する情報を返す場合にのみ使用します。たとえば既定の列挙型メンバーを指定したり、生成コード内で型定義のスコープを制御したりするなど、列挙データ型をカスタマイズする方法については、Simulink 列挙型のカスタマイズを参照してください。

例

すべて折りたたむ

列挙データ型 LEDcolor の既定の列挙型メンバーを取得します。LEDcolor で 2 つの列挙型メンバー GREEN と RED を定義し、GREEN を既定メンバーとして使用すると仮定します。

Simulink.data.getEnumTypeInfo('LEDcolor','DefaultValue')
ans = 

    GREEN

列挙データ型 LEDcolor について、生成されたコードが型の定義をヘッダー ファイルからエクスポートまたはヘッダー ファイルにインポートするかどうかを調べます。

Simulink.data.getEnumTypeInfo('LEDcolor','DataScope')
Simulink.data.getEnumTypeInfo('LEDcolor','HeaderFile')
ans =

Auto


ans =

     ''

DataScope は 'Auto' で HeaderFile は空なので、生成されたコードは列挙データ型 LEDcolor をヘッダー ファイル model_types.h で定義します。ここで model はコードの生成に使用するモデルの名前です。

入力引数

すべて折りたたむ

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

例: 'myFirstEnumType'

データ型: char

返す情報。表のいずれかの文字ベクトル オプションとして指定します。

指定した値返される情報戻り値の例
'DefaultValue'既定の列挙型メンバー。列挙データ型のインスタンスとして返されます。enumMember1
'Description'このデータ型のカスタムの説明。文字ベクトルとして返されます。この型に対する説明が指定されていない場合は、空の文字ベクトルを返します。'My first enum type.'
'HeaderFile'生成されたコード内でデータ型を定義するカスタム ヘッダー ファイルの名前。文字ベクトルとして返されます。この型に対するヘッダー ファイルが指定されていない場合は、空の文字ベクトルを返します。'myEnumType.h'
'DataScope'生成されたコードがデータ型の定義をインポートするかエクスポートするかを示すインジケーター。'Auto' の戻り値は生成されたコードがヘッダー ファイル model_types.h で型を定義するか、HeaderFile で識別されたヘッダー ファイルから定義をインポートするかを示します。'Exported' または 'Imported' の戻り値は生成されたコードが HeaderFile で識別されたヘッダー ファイルに定義をエクスポートまたはそのヘッダー フィルから定義をインポートすることを示します。'Exported'
'StorageType'生成されたコードで使用され、列挙型メンバーの数値を格納する整数データ型。文字ベクトルとして返されます。列挙型に対してストレージ型を指定しなかった場合は 'int' を返します。この場合、生成されたコードはハードウェア ターゲットのネイティブ整数型を使用します。'int32'
'AddClassNameToEnumNames'生成されたコードの列挙型メンバー名の先頭にデータ型の名前を付けるかどうかを示すインジケーター。true または false として返されます。true

バージョン履歴

R2014b で導入

参考

トピック