Simulink.data.dictionary.EnumTypeDefinition class

Пакет: Simulink.data.dictionary
Суперклассы:

Сохраните определение перечислимого типа в словаре данных

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

Описание

Объект Simulink.data.dictionary.EnumTypeDefinition класс задает перечислимый тип данных в словаре данных. Вы храните объект в записи в словаре данных, таким образом, модели, соединенные со словарем, могут использовать определение перечислимого типа.

В базовом рабочем пространстве MATLAB® объекты этого класса сохраняют информацию о перечислимом типе, но не задают тип для использования другими переменными или моделями.

Конструкция

Когда вы используете функциональный importEnumTypes чтобы импортировать определения перечислимых типов к словарю данных, Simulink® создает Simulink.data.dictionary.EnumTypeDefinition объект в словаре для каждого импортированного определения. Словарь хранит каждый объект в отдельной записи.

Конструктор Simulink.data.dictionary.EnumTypeDefinition создает экземпляр этого класса со значениями свойств по умолчанию и одним членом перечисления, который имеет базовое целочисленное значение 0.

Свойства

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

Отметьте, чтобы снабдить префиксом перечисления имя класса в сгенерированном коде в виде true или false.

Если вы задаете true, когда вы генерируете код, идентификатор каждого члена перечисления начинается с имени класса перечисления. Например, класс перечисления LEDcolor с членами перечисления GREEN и RED задает члены перечисления в сгенерированном коде как LEDcolor_GREEN и LEDcolor_RED.

Типы данных: логический

Отметьте, чтобы управлять определением типов в сгенерированном коде в виде 'Auto', 'Imported', или 'Exported'. Таблица описывает поведение сгенерированного кода для каждого значения.

ЗначениеДействие
Auto (значение по умолчанию)

Если вы не задаете свойство Headerfile, экспортируйте определение типов в model_types.h, где model имя модели.

Если вы задаете Headerfile, импортируйте определение типов из заданного заголовочного файла.

Exported

Экспортируйте определение типов в отдельный заголовочный файл.

Если вы не задаете свойство Headerfile, значения по умолчанию имени заголовочного файла к typeH, где type имя типа данных.

Imported

Импортируйте определение типов из отдельного заголовочного файла.

Если вы не задаете свойство Headerfile, значения по умолчанию имени заголовочного файла к typeH, где type имя типа данных.

Член перечисления по умолчанию в виде вектора символов. Задайте DefaultValue как имя члена перечисления вы уже задали.

Когда вы создаете Simulink.data.dictionary.EnumTypeDefinition объект, DefaultValue пустой символьный вектор, '', и Simulink использует первый член перечисления в качестве члена по умолчанию.

Пример: 'enumMember1'

Описание перечислимого типа данных в виде вектора символов. Используйте это свойство объяснить цель типа в сгенерированном коде.

Пример: 'Two possible colors of LED indicator: GREEN and RED.'

Типы данных: char

Имя заголовочного файла, который задает перечислимый тип данных в сгенерированном коде в виде вектора символов. Используйте .h расширение, чтобы задать имя файла.

Если вы не задаете HeaderFile, сгенерированный код использует имя заголовочного файла по умолчанию, которое зависит от значения DataScope свойство.

Пример: 'myTypeIncludeFile.h'

Типы данных: char

Тип данных целочисленных значений, лежащих в основе членов перечисления в виде вектора символов. Сгенерированный код хранит базовые целочисленные значения с помощью типа данных, который вы задаете.

Можно задать один из этих поддерживаемых целочисленных типов:

  • 'int8'

  • 'int16'

  • 'int32'

  • 'uint8'

  • 'uint16'

Чтобы сохранить базовые целочисленные значения в сгенерированном коде с помощью нативного целочисленного типа целевого компьютера, задайте StorageType как пустой символьный вектор, '', который является значением по умолчанию.

Пример: 'int16'

''

Методы

appendEnumeralДобавьте член перечисления в перечислимое определение типов в словаре данных
removeEnumeralУдалите член перечисления из перечислимого определения типов в словаре данных

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Примеры

свернуть все

Создайте объект, который может сохранить определение перечислимого типа. По умолчанию новый тип задает один член перечисления enum1 с базовым целочисленным значением 0.

myColors = Simulink.data.dictionary.EnumTypeDefinition
myColors = 

   Simulink.data.dictionary.EnumTypeDefinition
      enum1

Добавьте некоторые члены перечисления в определение типа.

appendEnumeral(myColors,'Orange',1,'')
appendEnumeral(myColors,'Black',2,'')
appendEnumeral(myColors,'Cyan',3,'')
myColors
myColors = 

   Simulink.data.dictionary.EnumTypeDefinition
      enum1
      Orange
      Black
      Cyan

Удалите член перечисления по умолчанию enum1. Начиная с enum1 первый член перечисления в списке, идентифицируйте его с индексом 1.

removeEnumeral(myColors,1)
myColors
myColors = 

   Simulink.data.dictionary.EnumTypeDefinition
      Orange
      Black
      Cyan

Настройте перечислимый тип путем конфигурирования свойств объекта, представляющего его.

myColors.Description = 'These are my favorite colors.';
myColors.DefaultValue = 'Cyan';
myColors.HeaderFile = 'colorsType.h';

Откройте словарь данных myDictionary_ex_API.sldd и представляйте его с Simulink.data.Dictionary возразите названному myDictionaryObj.

myDictionaryObj = Simulink.data.dictionary.open('myDictionary_ex_API.sldd');

Импортируйте объект, который задает перечислимый тип myColors к словарю.

importFromBaseWorkspace(myDictionaryObj,'varList',{'myColors'});

Альтернативы

Можно использовать Model Explorer, чтобы добавить и изменить перечисленные типы данных, сохраненные в словаре данных.

Смотрите также

Темы

Представленный в R2015a

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