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

Используйте определение класса в файле MATLAB

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

classdef Colors < int8
   enumeration
     Red(0)
     Green(1)
     Blue(2)
   end
end

Генератор кода генерирует этот код:

typedef int8_T Colors;

#define Red      ((Colors)0)
#define Green ((Colors)1)
#define Blue     ((Colors)2)

Используйте функцию Simulink.defineIntEnumType

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

Simulink.defineIntEnumType('Colors',{'Red','Green','Blue'},...
[0;1;2],'StorageType','int8')

Генератор кода генерирует этот код:

typedef int8_T Colors;

#define Red      ((Colors)0)
#define Green ((Colors)1)
#define Blue     ((Colors)2)

Задайте описание

Чтобы задать описание для перечислимого типа данных, включайте этот метод в methods(Static) раздел класса перечисления:

function retVal = getDescription() 
% GETDESCRIPTION  Optional description of the data type.
  retVal = 'description';
end

Замените вектором символов MATLAB description. Сгенерированный код, который задает перечислимый тип, включает заданное описание.

Импортируйте определение типа в сгенерированном коде

Чтобы препятствовать тому, чтобы сгенерированный код задал перечислимый тип данных, который позволяет вам предоставлять определение во внешнем файле, включают эти методы в methods(Static) раздел класса перечисления:

    function retVal = getHeaderFile()
      % GETHEADERFILE Specifies the file that defines this type in generated code.
      % The method getDataScope determines the significance of the specified file.
      retVal = 'imported_enum_type.h';
    end

    function retVal = getDataScope()
      % GETDATASCOPE Specifies whether generated code imports or exports this type.
      % Return one of:
      % 'Auto':     define type in model_types.h, or import if header file specified
      % 'Exported': define type in a generated header file
      % 'Imported': import type definition from specified header file
      % If you do not define this method, DataScope is 'Auto' by default.
      retVal = 'Imported';
    end

Вместо того, чтобы задать тип в model_types.h, который является поведением по умолчанию, сгенерированный код импортирует определение из заданного заголовочного файла с помощью #include оператор как:

#include "imported_enum_type.h"

Генерация кода не создает импортированный заголовочный файл. Необходимо обеспечить заголовочный файл, с помощью имени файла, заданного методом getHeaderFile, это задает перечислимый тип данных.

Чтобы создать перечисление Simulink, которое соответствует вашему существующему перечислению кода С, используйте Simulink.importExternalCTypes функция.

Экспортируйте определение типа в сгенерированном коде

Чтобы сгенерировать отдельный заголовочный файл, который задает перечислимый тип данных, включайте эти методы в methods(Static) раздел класса перечисления:

    function retVal = getDataScope()
      % GETDATASCOPE Specifies whether generated code imports or exports this type.
      % Return one of:
      % 'Auto':     define type in model_types.h, or import if header file specified
      % 'Exported': define type in a generated header file
      % 'Imported': import type definition from specified header file
      % If you do not define this method, DataScope is 'Auto' by default.
      retVal = 'Exported';
    end

    function retVal = getHeaderFile()
      % GETHEADERFILE Specifies the file that defines this type in generated code.
      % The method getDataScope determines the significance of the specified file.
      retVal = 'exported_enum_type.h';
    end

Сгенерированный код экспортирует определение перечислимого типа сгенерированному заголовочному файлу exported_enum_type.h.

Добавьте префиксы в имена классов

По умолчанию перечисляемые значения в сгенерированном коде имеют те же имена, которые они имеют в определении класса перечисления. В качестве альтернативы ваш код может снабдить префиксом каждое перечисляемое значение в классе перечисления с именем класса. Можно использовать этот метод, чтобы предотвратить конфликты идентификатора или улучшить удобочитаемость кода. Чтобы задать добавление префикса имени класса, включайте этот метод в methods(Static) раздел класса перечисления:

    function retVal = addClassNameToEnumNames()
      % ADDCLASSNAMETOENUMNAMES Specifies whether to add the class name
      % as a prefix to enumeration member names in generated code.
      % Return true or false.
      % If you do not define this method, no prefix is added.
      retVal = true;
    end

Задайте возвращаемое значение как true включить добавление префикса имени класса или как false подавить добавление префикса. Если вы задаете true, каждое перечисляемое значение в классе появляется в сгенерированном коде как EnumTypeName_EnumName. Для класса перечисления в качестве примера BasicColors в Перечислимых Типах данных может выглядеть так определение типов в сгенерированном коде:

#ifndef _DEFINED_TYPEDEF_FOR_BasicColors_
#define _DEFINED_TYPEDEF_FOR_BasicColors_

typedef enum {
  BasicColors_Red = 0,            /* Default value */
  BasicColors_Yellow = 1,
  BasicColors_Blue = 2,
} BasicColors;

#endif

Имя класса перечисления BasicColors появляется как префикс для каждого из перечислимых имен.

Управляйте использованием дублирующихся имен элемента перечисления

Когда вы импортируете данные о перечислении от заголовочного файла, можно управлять использованием дублирующихся имен элемента перечисления во время генерации кода. Дублирующиеся имена элемента перечисления улучшают удобочитаемость кода. Используйте параметр конфигурации модели Duplicate enumeration member names (Simulink Coder), чтобы позволить дублирующиеся имена элемента перечисления в различных перечисляемых типах во время генерации кода или сгенерировать ошибку или предупреждающее сообщение. Можно использовать дублирующиеся имена элемента перечисления, только если два перечисления имеют тот же StorageType и имейте эти технические требования:

Например:

typedef int32_T enum {
  Red = 0,
  Yellow = 1,
  Blue = 2,
}A;

typedef int32_T enum {
  Black = 0,
  Yellow = 1,
  White = 2,
}B;

Реализуйте перечислимый тип при помощи enum Блок

Реализовывать определение типа при помощи enum блок:

Когда вы генерируете код, определение типа появляется в enum блок.

#ifndef _DEFINED_TYPEDEF_FOR_BasicColors_
#define _DEFINED_TYPEDEF_FOR_BasicColors_

typedef enum {
  Red = 0,            /* Default value */
  Yellow,
  Blue,
} BasicColors;

#endif

Реализуйте перечислимый тип Используя определенный целочисленный тип

Реализовывать определение типа с помощью typedef оператор и #define макросы:

Когда вы генерируете код, определение типа появляется как typedef оператор и серия #define макросы.

#ifndef _DEFINED_TYPEDEF_FOR_BasicColors_
#define _DEFINED_TYPEDEF_FOR_BasicColors_

typedef int8_T BasicColors;

#define Red ((BasicColors)0)            /* Default value */
#define Yellow ((BasicColors)1)
#define Blue ((BasicColors)2)

#endif

По умолчанию, сгенерированный файл model_types.h содержит определения перечислимого типа.

Безопасный кастинг

Блок Simulink Data Type Conversion принимает сигнал целочисленного типа. Блок преобразует вход в одно из базовых значений перечислимого типа.

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

Включите и отключите безопасный кастинг

Можно включить или отключить безопасный кастинг для перечислений во время генерации кода для блока Simulink Data Type Conversion или блока Stateflow.

Чтобы управлять безопасным кастингом, включите или отключите параметры блоков Saturate on integer overflow. Параметр работает можно следующим образом:

Безопасная функция броска в сгенерированном коде

В этом примере показано, как безопасный бросок функционирует int32_T ET08_safe_cast_to_BasicColors для перечисления BasicColors появляется в сгенерированном коде, когда сгенерировано для 32-битного оборудования.

static int32_T ET08_safe_cast_to_BasicColors(int32_T input)
{
	int32_T output;
	/* Initialize output value to default value for BasicColors (Red) */
	output = 0;
	if ((input >= 0) && (input <= 2)) {
	/* Set output value to input value if it is a member of BasicColors */
		output = input;
	}
	return output;
}

Если параметр Saturate on integer overflow блока отключен, эта функция не появляется в сгенерированном коде.