Simulink.CodeImporter.Function class

Пакет: Simulink .CodeImporter

Доступ и конфигурирование подробной информации о проанализированных функциях пользовательского кода

Описание

Получите подробную информацию о проанализированных функциях пользовательского кода, полученных из Simulink.CodeImporter или sltest.CodeImporter образец класса. Сконфигурируйте информацию о функциях пользовательского кода для импорта в Simulink^®.

The Simulink.CodeImporter.Function класс является handle класс.

Создание

Один или несколько объектов этого класса создаются автоматически при вызове getFunctions метод объекта класса Simuink.CodeImporter.ParseInfo. A Simulink.CodeImporter.Function создается для каждой функции в проанализированном пользовательском коде, для которого getFunctions вызывается. Не создавать объект класса Simulink.CodeImporter.Function непосредственно.

Свойства

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

`Name` - Имя функции
строковый скаляр

Имя функции, возвращаемое как строковый скаляр.

Пример: "Controller"

Типы данных: string scalar

`CPrototype` - прототип C
строковый скаляр

Прототип C для функции, возвращенный как строковый скаляр.

Пример: "pump_control_bus Controller(real_T Tset, real_T Troom_in);"

Типы данных: string scalar

`PortSpecification` - Спецификация функции порта
`SimulinkPortSpecification` объект

Спецификация порта функции, заданная как объект класса Simulink.CodeImporter.SimulinkPortSpecification.

`IsEntry` - Является ли функция функцией точки входа
логический скаляр

Является ли функция функцией точки входа, возвращается как логический скаляр. Функция точки входа не вызывается другими функциями в пользовательском коде.

`IsDefined` - Задана ли функция
логический скаляр

Задана ли функция, возвращается как логический скаляр. Этот скаляр указывает, содержит ли пользовательский код тело функции, определяющее функцию в дополнение к прототипу функции, заданному в заголовке.

`IsDeterministic` - Является ли функция детерминированной
логический скаляр

Является ли функция детерминированной, задается как логический скаляр. Детерминированная функция всегда производит те же выходы для тех же входных значений. Установка функции как детерминированной позволяет использовать соответствующий C Caller блок в подсистеме For Each и с непрерывным шагом расчета, и оптимизирует использование блока в выполнении условной входной ветви. См. Детерминированные функции.

`IsStub` - Является ли функция упорной
логический скаляр

Является ли функция упорной, возвращается как логический скаляр. Этот скаляр указывает, был ли для модульного теста сгенерирован заглушка для неопределенных символов для функции (Simulink Test™ требуется лицензия).

`ArrayLayout` - размещение массива для функции
`NotSpecified` (по умолчанию) | `ColumnMajor` | `RowMajor` | `Any`

Размещение массива для функции, возвращенный как NotSpecified, ColumnMajor, RowMajor, или Any. Если NotSpecified, затем настройка по умолчанию для пользовательского кода, заданная в FunctionArrayLayout свойство соответствующего SimulinkCode.CustomCode используется объект. В противном случае значение, заданное для функции, переопределяет значение по умолчанию.

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

Методы

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

Общедоступные методы


`gotoDefinition`	Отображение определения функции в MATLAB^® редактор с подсвеченным именем функции. Синтаксис: `fcnobj.gotoDefinition` или `fcnobj.gotoDefinition()`, где `fcnobj` является объектом класса `Function`
`gotoDeclaration`	Отобразите объявление функции в редакторе MATLAB с подсвеченным именем функции. Синтаксис: `fcnobj.gotoDeclaration` или `fcnobj.gotoDeclaration()`, где `fcnobj` является объектом класса `Function`

gotoDefinition

Отображение определения функции в MATLAB^® редактор с подсвеченным именем функции.

Синтаксис: fcnobj.gotoDefinition или fcnobj.gotoDefinition(), где fcnobj является объектом класса Function

gotoDeclaration

Отобразите объявление функции в редакторе MATLAB с подсвеченным именем функции.

Синтаксис: fcnobj.gotoDeclaration или fcnobj.gotoDeclaration(), где fcnobj является объектом класса Function

Примеры

свернуть все

Анализ функций пользовательского кода

Задайте и проанализируйте пользовательский код, а затем запросите информацию о функциях пользовательского кода.

obj = Simulink.CodeImporter;

%% Set library file name and output folder
obj.LibraryFileName = "pumpController";
obj.OutputFolder = ".";

%% Set the custom code to import
obj.CustomCode.InterfaceHeaders = ["pumpController.h"];
obj.CustomCode.IncludePaths = ["./include"];
obj.CustomCode.SourceFiles = ["src/pumpController.c" "src/utils.c"];

%% Parse code
obj.parse;
parseobj = obj.ParseInfo

ans = 

  ParseInfo with properties:

               Success: 1
    AvailableFunctions: ["Controller"    "setFanTempThreshold"    "setPumpTempThreshold"]
        EntryFunctions: ["Controller"    "setFanTempThreshold"    "setPumpTempThreshold"]
        AvailableTypes: "pump_control_bus"
                Errors: []

fcnobj = parseobj.getFunctions(["Controller"])

fcnobj = 

  Function with properties:

                 Name: "Controller"
           CPrototype: "pump_control_bus Controller(real_T Tset, real_T Troom_in);"
    PortSpecification: [1×1 Simulink.CodeImporter.SimulinkPortSpecification]
              IsEntry: 1
            IsDefined: 1
               IsStub: 0
          ArrayLayout: NotSpecified
      IsDeterministic: 0

См. также

Simulink.CodeImporter | Simulink.CodeImporter.CustomCode | Simulink.CodeImporter.Options | Simulink.CodeImporter.ParseInfo | Simulink.CodeImporter.SimulinkPortSpecification

Введенный в R2021a

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

Simulink.CodeImporter.Function class

Описание

Создание

Свойства

`Name` - Имя функции
строковый скаляр

`CPrototype` - прототип C
строковый скаляр

`PortSpecification` - Спецификация функции порта
`SimulinkPortSpecification` объект

`IsEntry` - Является ли функция функцией точки входа
логический скаляр

`IsDefined` - Задана ли функция
логический скаляр

`IsDeterministic` - Является ли функция детерминированной
логический скаляр

`IsStub` - Является ли функция упорной
логический скаляр

`ArrayLayout` - размещение массива для функции
`NotSpecified` (по умолчанию) | `ColumnMajor` | `RowMajor` | `Any`

Методы

Общедоступные методы

Примеры

Анализ функций пользовательского кода

См. также

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

Поддержка

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

Simulink.CodeImporter.Function class

Описание

Создание

Свойства

Name - Имя функции строковый скаляр

CPrototype - прототип C строковый скаляр

PortSpecification - Спецификация функции порта SimulinkPortSpecification объект

IsEntry - Является ли функция функцией точки входа логический скаляр

IsDefined - Задана ли функция логический скаляр

IsDeterministic - Является ли функция детерминированной логический скаляр

IsStub - Является ли функция упорной логический скаляр

ArrayLayout - размещение массива для функции NotSpecified (по умолчанию) | ColumnMajor | RowMajor | Any

Методы

Общедоступные методы

Примеры

Анализ функций пользовательского кода

См. также

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

Поддержка

`Name` - Имя функции
строковый скаляр

`CPrototype` - прототип C
строковый скаляр

`PortSpecification` - Спецификация функции порта
`SimulinkPortSpecification` объект

`IsEntry` - Является ли функция функцией точки входа
логический скаляр

`IsDefined` - Задана ли функция
логический скаляр

`IsDeterministic` - Является ли функция детерминированной
логический скаляр

`IsStub` - Является ли функция упорной
логический скаляр

`ArrayLayout` - размещение массива для функции
`NotSpecified` (по умолчанию) | `ColumnMajor` | `RowMajor` | `Any`