Exponenta Banner
exponenta event banner

clibgen.EnumDefinition класс

Пакет: clibgen

Определение для перечисления MATLAB, соответствующего перечислению C++

развернуть все на странице

Описание

clibgen.EnumDefinition содержит определение MATLAB ® для перечисления, определенного в заголовке C++.

clibgen.EnumDefinition класс является handle класс.

Создание

MATLAB создает EnumDefinition объект при вызове MATLAB addEnumeration на clibgen.LibraryDefinition объект.

Свойства

развернуть все

Текст справки для конечного пользователя, описывающий перечисление, указанный как строка или символьный вектор. Текст по умолчанию:

MATLABName    Representation of C++ enumeration CPPName.
Издатель может изменить значение Description в файле определения библиотеки.

Пример: clib.cppSample.COLOR Представление перечисления C++ COLOR.

Атрибуты:

GetAccess
public
SetAccess
public

Текст справки из файла заголовка C++ для конечного пользователя, описывающий сведения о перечислении, указанные как строка или символьный вектор. Если комментарий C++ не содержит подробной информации, то DetailedDescription не отображается в файле определения.

Издатель может изменить значение DetailedDescription в файле определения библиотеки. Если DetailedDescription не пуст, тогда MATLAB doc команда отображает это предложение перед отображением значения DetailedDescription.

This content is from the external library documentation.

Атрибуты:

GetAccess
public
SetAccess
public

Библиотека, определяющая перечисление, указанная как clibgen.LibraryDefinition объект.

Пример: myFonts

Атрибуты:

GetAccess
public
SetAccess
private

Имя перечисления C++, указанное как строка или символьный вектор. MATLAB создает CPPName от enum class имя в файле заголовка.

Пример: COLOR

Атрибуты:

GetAccess
public
SetAccess
private

Тип MATLAB для значений перечисления, указанный как int32.

Атрибуты:

GetAccess
public
SetAccess
private

Укажите, завершено ли определение перечисления, указанное как true или false.

Атрибуты:

GetAccess
public
SetAccess
private

Имя перечисления C++ в MATLAB, указанное как строка или символьный вектор.

Пример: clib.MyPkg.COLOR

Атрибуты:

GetAccess
public
SetAccess
private

Перечислители, указанные как структура значений перечислителя и необязательные комментарии C++ из файла заголовка, описывающие сведения о перечислителе. MATLAB создает Entries от enum class определение в файле заголовка.

Атрибуты:

GetAccess
public
SetAccess
private

Совет

  • Возможно, необходимо создать перечисляемое значение в MATLAB, но имя этого значения может не быть допустимым именем MATLAB. Например, имя перечислителя может начинаться с подчеркивания. Для получения значения из этого имени во время выполнения используйте синтаксис MATLAB, где enumMember - строковый скалярный или символьный вектор, который при вычислении возвращает экземпляр перечисления.

    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.

  • Для считывания базового числового значения для объекта перечисления C++, созданного в MATLAB, вызовите underlyingValue.

См. также

| |

Представлен в R2019a

Документация MATLAB

Поддержка