appendEnumeral

データ ディクショナリの列挙データ型定義に列挙型メンバーを追加

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

構文

appendEnumeral(typeObj,memberName,memberValue,memberDesc)

説明

appendEnumeral(typeObj,memberName,memberValue,memberDesc) は、typeObj (Simulink.data.dictionary.EnumTypeDefinition オブジェクト) に格納された列挙型定義に列挙型メンバーを追加します。

例

例

すべて折りたたむ

列挙型の定義を格納できるオブジェクトを作成します。既定では、新しい型には基となる整数値が 0 である列挙型メンバー enum1 が 1 つ定義されます。

myColors = Simulink.data.dictionary.EnumTypeDefinition
myColors = 

   Simulink.data.dictionary.EnumTypeDefinition
      enum1

型の定義に列挙型メンバーをいくつか追加します。

appendEnumeral(myColors,'Orange',1,'')
appendEnumeral(myColors,'Black',2,'')
appendEnumeral(myColors,'Cyan',3,'')
myColors
myColors = 

   Simulink.data.dictionary.EnumTypeDefinition
      enum1
      Orange
      Black
      Cyan

既定の列挙型メンバー enum1 を削除します。enum1 はリストの最初の列挙型メンバーであるため、インデックス 1 を指定します。

removeEnumeral(myColors,1)
myColors
myColors = 

   Simulink.data.dictionary.EnumTypeDefinition
      Orange
      Black
      Cyan

対応するオブジェクトのプロパティを設定して列挙型をカスタマイズします。

myColors.Description = 'These are my favorite colors.';
myColors.DefaultValue = 'Cyan';
myColors.HeaderFile = 'colorsType.h';

データ ディクショナリ myDictionary_ex_API.sldd を開き、myDictionaryObj という名前の Simulink.data.Dictionary オブジェクトで表します。

myDictionaryObj = Simulink.data.dictionary.open('myDictionary_ex_API.sldd');

列挙型 myColors を定義するオブジェクトをディクショナリにインポートします。

importFromBaseWorkspace(myDictionaryObj,'varList',{'myColors'});

入力引数

すべて折りたたむ

ターゲットの列挙型定義。Simulink.data.dictionary.EnumTypeDefinition オブジェクトとして指定します。

新しい列挙型メンバーの名前。文字ベクトルとして指定します。

例: 'myNewEnumMember'

データ型: char

新しい列挙型メンバーの基となる整数値。整数として指定します。

列挙型メンバーの基となる値を格納するために生成コードで使用される整数データ型は列挙型クラスの定義で設定されます。

例: 3

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

新しい列挙型メンバーの説明。文字ベクトルとして指定します。

列挙型メンバーの説明を指定しない場合は、空の文字ベクトルを使用します。

例: 'Enumeration member number 1.'

例: ''

データ型: char

代替方法

モデル エクスプローラーを使用して、Simulink.data.dictionary.EnumTypeDefinition オブジェクトで表される列挙データ型に列挙型メンバーを追加することができます。

バージョン履歴

R2015a で導入

参考

|

トピック