Exponenta Banner

clibgen.EnumDefinition class

Пакет: 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

Enumerants в виде struct enumerant значений и дополнительного C++ комментирует от деталей описания заголовочного файла о enumerant. MATLAB создает Entries от enum class определение в заголовочном файле.

Атрибуты:

GetAccess
public
SetAccess
private

Советы

  • Вы можете должны быть создать перечисляемую стоимость в MATLAB, но имя того значения не может быть допустимым именем MATLAB. Например, имя enumerant может начаться с подчеркивания. Чтобы получить значение на это имя во время выполнения, используйте этот синтаксис 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

Поддержка