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

Использование определения класса в файле 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 параметра конфигурации модели, чтобы разрешить дублирование имен представителей перечисления в различных перечисляемых типах во время генерации кода или чтобы сгенерировать ошибку или предупреждающее сообщение. Повторяющиеся имена представителей перечисления можно использовать только в том случае, если два перечисления имеют одинаковые 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 параметр блока отключен, эта функция не отображается в сгенерированном коде.