Main Content

clibgen.EnumDefinition クラス

パッケージ: clibgen

C++ 列挙型に対応する MATLAB 列挙型の定義

R2019a 以降

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

説明

clibgen.EnumDefinition クラスには、C++ ヘッダーで定義された列挙型の MATLAB® 定義が含まれます。

clibgen.EnumDefinition クラスは handle クラスです。

作成

MATLAB は、MATLAB が addEnumeration を clibgen.LibraryDefinition オブジェクトで呼び出すときに EnumDefinition オブジェクトを構築します。

プロパティ

すべて展開する

列挙型についてエンド ユーザーに説明するヘルプ テキスト。string または文字ベクトルとして指定します。既定のテキストは次のとおりです。

MATLABName    Representation of C++ enumeration CPPName.
パブリッシャーはライブラリ定義ファイルで Description プロパティの値を変更できます。

例: C++ 列挙型 COLOR の clib.cppSample.COLOR 表現。

属性:

GetAccess
public
SetAccess
public

列挙型についてエンド ユーザーに説明する C++ ヘッダー ファイルからのヘルプ テキスト。string または文字ベクトルとして指定します。C++ コメントに詳細情報が含まれない場合、DetailedDescription は定義ファイルに表示されません。

パブリッシャーはライブラリ定義ファイルで DetailedDescription プロパティの値を変更できます。DetailedDescription が空でない場合、DetailedDescription の値を表示する前に MATLAB doc コマンドにこの文章が表示されます。

This content is from the external library documentation.

属性:

GetAccess
public
SetAccess
public

ライブラリ定義列挙型。clibgen.LibraryDefinition オブジェクトとして指定します。

例: myFonts

属性:

GetAccess
public
SetAccess
private

C++ 列挙型名。string または文字ベクトルとして指定します。MATLAB はヘッダー ファイルの enum class 名から CPPName を作成します。

例: COLOR

属性:

GetAccess
public
SetAccess
private

列挙値の MATLAB 型。int32 として指定します。

属性:

GetAccess
public
SetAccess
private

列挙型の定義が完了しているかどうかを示します。true または false として指定されます。

属性:

GetAccess
public
SetAccess
private

MATLAB の C++ 列挙型名。string または文字ベクトルとして指定します。

例: clib.MyPkg.COLOR

属性:

GetAccess
public
SetAccess
private

列挙値。列挙値の struct および列挙値について説明するヘッダー ファイルからのオプションの C++ コメントとして指定します。MATLAB はヘッダー ファイルの enum class 定義から Entries を作成します。

属性:

GetAccess
public
SetAccess
private

ヒント

  • MATLAB で列挙値の作成が必要になる場合がありますが、その値の名前が有効な MATLAB 名ではないことがあります。たとえば、列挙値名がアンダースコアで始まっている場合があります。実行時にこの名前から値を派生させるには、次の MATLAB 構文を使用します。ここで、enumMember は評価時に列挙型のインスタンスを返す string スカラーまたは文字ベクトルです。

    clib.libName.enumName.(enumMember)

    たとえば、以下のプロパティをもつインターフェイス clib.enums.keywords があるとします。

      EnumDefinition with properties:

        Description: "clib.enums.keywords    Representation of C++ enumeration"
    DefiningLibrary: [1×1 clibgen.LibraryDefinition]
            CPPName: "keywords"
         MATLABType: "int32"
              Valid: 1
         MATLABName: "clib.enums.keywords"
            Entries: ["_for"    "_while"    "_class"    "_enums"    "_template"    "_typename"]

    エントリ _class を変数に割り当てるには、次のように入力します。

    var = clib.enums.keywords.('_class');

    この構文は、識別子の最大長 namelengthmax より短い名前について有効です。

  • MATLAB で作成された C++ 列挙オブジェクトの元となる数値を読み取るには、underlyingValue を呼び出します。

バージョン履歴

R2019a で導入

参考

| |