clibgen.EnumDefinition class

Пакет: clibgen

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

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

Описание

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

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

Создание

MATLAB создает EnumDefinition объект, когда MATLAB вызывает addEnumeration на clibgen.LibraryDefinition объект.

Свойства

расширить все

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

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

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

Атрибуты:

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

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

Атрибуты:

GetAccess
public
SetAccess
private

Совет

  • Возможно, вам потребуется создать перечисленное значение в 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

Поддержка

Для просмотра документации необходимо авторизоваться на сайте