Exponenta Banner
exponenta event banner

Simulink.data.dictionary. EnumTypeDefinition

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

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

Описание

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

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

Создание

Синтаксис

Simulink.data.dictionary. EnumTypeDefinition

Описание

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

пример

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

Свойства

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

Флаг для префикса перечислений с именем класса в сгенерированном коде, указанный как true или false.

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

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

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

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

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

При указании Headerfileимпортируйте определение типа данных из указанного файла заголовка.

Exported

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

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

Imported

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

Если свойство не указано Headerfile, имя файла заголовка по умолчанию type.h, где 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Удалить элемент перечисления из определения перечисляемого типа данных в словаре данных

Примеры

свернуть все

Создайте объект, в котором можно сохранить определение перечисляемого типа. По умолчанию новый тип определяет один элемент перечисления 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'});

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

Для добавления и изменения перечисляемых типов данных, хранящихся в словаре данных, можно использовать обозреватель моделей.

См. также

|

Темы

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

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

Поддержка