Main Content

coder.EnumType クラス

パッケージ: coder
スーパークラス: coder.ArrayType

入力仕様に対して許容される MATLAB 列挙のセットを表す

このページをすべて展開する

説明

coder.EnumType クラスのオブジェクトは、生成されたコードが受け入れる MATLAB® 列挙を指定します。このクラスのオブジェクトは、codegen コマンドの -args オプションでのみ使用します。生成された MEX 関数に入力として渡さないでください。

作成

t = coder.typeof(enumValue) は、クラス enumValue の列挙値のセットを表す coder.EnumType オブジェクトを作成します。

t = coder.typeof(enumValue,sz,variableDims) は、上限サイズ sz と variableDims で示された可変次元をもつ型オブジェクト coder.EnumType を作成します。sz で次元に inf を指定すると、その次元はサイズの制限のない可変サイズになります。sz が [] の場合、v の上限サイズは変化しません。variableDims を指定しないと、この型の制限付き次元は固定になり、制限のない次元は可変サイズになります。variableDims がスカラーの場合、関数は固定の 1 または 0 でない制限付き次元にこの値を適用します。

t = coder.newtype(enumName,sz,variableDims) は、上限サイズが sz の可変サイズと可変次元 variableDims をもつ coder.EnumType オブジェクトを作成します。sz で次元に inf を指定すると、その次元はサイズの制限のない可変サイズになります。variableDims を指定しないと、この型の制限付き次元は固定になります。variableDims がスカラーの場合、関数は固定の 1 または 0 でない制限付き次元にこの値を適用します。

入力引数

すべて展開する

MATLAB パス上で定義されている列挙値。列挙オブジェクトとして指定します。

型オブジェクトの次元。正の整数のベクトルまたはスカラーの正の整数として指定します。

各次元が可変サイズかどうかを指定するオプション。boolean ベクトルとして指定します。このベクトルの要素を 1 と指定すると、対応する次元が可変サイズになります。それ以外の場合、次元は固定サイズになります。

MATLAB パス上で定義されている列挙の名前。string スカラーまたは文字ベクトルとして指定します。

プロパティ

すべて展開する

セット内の値のクラス。string スカラーまたは文字ベクトルとして返されます。

セット内の配列の上限サイズ。整数のベクトルとして指定します。

配列の各次元が固定サイズであるか可変サイズであるか。ベクトルの要素が 1 の場合、対応する次元は可変サイズになります。それ以外の場合、次元は固定サイズになります。

例

すべて折りたたむ

ライブ スクリプトを開く

MATLAB® パス上で MyColors という名前の列挙を定義します。

type MyColors.m
classdef MyColors < int32
    enumeration
        green(1),
        red(2),
    end
end

coder.typeof を使用して、この列挙から coder.EnumType オブジェクトを作成します。

t = coder.newtype('MyColors')
t = 
coder.EnumType
   1×1 MyColors

    Edit Type Object

バージョン履歴

R2011a で導入

参考

| | | | | |

トピック