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

S-имя-функции

Задает имя целевой S-функции.

Язык

Задает выходной язык для S-функции. Можно принять решение сгенерировать S-функции на C/C++, или можно наследовать образцовые настройки.

S-параметры-функции

Эта таблица показывает параметры целевой S-функции. Каждая строка таблицы соответствует параметру и каждому отображения столбца свойство параметра можно следующим образом:

Создать/Сохранить

Используйте эту кнопку, чтобы сгенерировать исходный код C и исполняемый файл MEX от информации, которую вы ввели в Разработчика S-функции. Если кнопка маркирована Build, S-Function Builder генерирует исходный код и исполняемый файл MEX. Если кнопка маркирована Save, она генерирует только исходный код C. Используйте флажок Save code only на панели Build Info, чтобы переключить функциональность этой кнопки.

Скройтесь/Покажите вкладки редактирования S-функции

Используйте маленькую кнопку в правом нижнем углу панели Parameters/S-Function Name, чтобы свернуть и расширить нижнюю часть диалогового окна S-Function Builder.

Количество дискретных состояний

Количество дискретных состояний в S-функции.

IC дискретных состояний

Начальные условия дискретных состояний в S-функции. Можно ввести значения как список, разделенный запятыми или как вектор (например, [0 1 2]). Количество начальных условий должно равняться количеству дискретных состояний.

Количество непрерывных состояний

Количество непрерывных состояний в S-функции.

Непрерывный IC состояний

Начальные условия непрерывных состояний в S-функции. Можно ввести значения как список, разделенный запятыми или как вектор (например, [0 1 2]). Количество начальных условий должно равняться количеству непрерывных состояний.

Демонстрационный режим

Демонстрационный режим S-функции. Демонстрационный режим определяет длину интервала между временами, когда S-функция обновляет свой вывод. Можно выбрать одну из следующих опций:

Значение шага расчета

Скалярное значение, указывающее на интервал между обновлениями S-функции выходные параметры. Это поле включено, только если вы выбираете Discrete как Sample mode.

Количество PWorks

Количество указателей данных используется S-функцией. PWorks указывает на память за жизненный цикл блока. Например, можно объявить и инициализировать указатель на файл или память в Start, и получить доступ к нему в Outputs, Update и панелях Derivatives, и освободить его в панели Terminate. Код, написанный в этих панелях, вызван mdlStart, mdlOutputs, mdlUpdate, mdlDerivatives и mdlTerminate. Смотрите Скользящее среднее значение в качестве примера с Запуском и Оконечный и Перестановка с помощью Классов Cpp.

Имя порта

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

Размерности

Перечисляет количество размерностей входного сигнала, принятого портом. Чтобы отобразить список поддерживаемых размерностей, нажмите смежную кнопку. Чтобы изменить размерность порта, выберите новое значение из списка. Задайте 1-D, чтобы измерить сигнал динамически, независимо от фактической размерности сигнала.

'Строки'

Задает размер первого (или только) размерность входного сигнала. Задайте -1, чтобы измерить сигнал динамически.

Столбцы

Задает размер второго измерения входного сигнала (только если входной порт принимает 2D сигналы).

Сложность

Задает, принимает ли входной порт действительные или сигналы с комплексным знаком.

Шина

Если входной сигнал к блоку S-Function Builder является шиной, то используйте выпадающее меню в столбце Bus, чтобы выбрать 'on'.

Соедините шиной имя

Шаг 2 S-функций Сборки Автоматически дает вам команду создавать объект шины, если ваш входной сигнал является шиной. В поле, обеспеченном в столбце Bus Name, введите имя шины, которое вы задали при создании объекта шины импорта.

Имя порта

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

Размерности

Перечисляет количество размерностей сигналов, выведенных портом. Чтобы отобразить список поддерживаемых размерностей, нажмите смежную кнопку. Чтобы изменить размерность порта, выберите новое значение из списка. Задайте 1-D, чтобы измерить сигнал динамически, независимо от фактической размерности сигнала.

'Строки'

Задает размер первого (или только) размерность выходного сигнала. Задайте -1, чтобы измерить сигнал динамически.

Столбцы

Задает размер второго измерения выходного сигнала (только если выходы порта 2D сигналы).

Сложность

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

Шина

Если выходной сигнал к блоку S-Function Builder является шиной, то используйте выпадающее меню в столбце Bus, чтобы выбрать 'on'.

Соедините шиной имя

Шаг 2 S-функций Сборки Автоматически дает вам команду создавать объект шины. В поле, обеспеченном в столбце Bus Name, введите имя, которое вы задали при создании объекта шины выходного порта.

'ParameterName'

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

Тип данных

Перечисляет тип данных параметра. Нажмите смежную кнопку, чтобы отобразить список поддерживаемых типов данных. Чтобы изменить тип данных параметров, выберите новый тип из списка.

Сложность

Задает, имеет ли параметр действительный или комплексные числа.

Порт

Имя порта. Это поле отображает имя, введенное в панелях Output ports и Input ports. Вы не можете отредактировать это поле.

Тип данных

Тип данных порта. Нажмите смежную кнопку, чтобы отобразить список поддерживаемых типов данных. Чтобы изменить тип данных, выберите различный тип данных из списка.

Остающиеся поля на этой панели включены, только если поле Data Type задает тип данных с фиксированной точкой. Смотрите Задают Типы данных с фиксированной точкой для получения дополнительной информации.

Библиотека/Объект/Исходные файлы

Внешняя библиотека, объектный код и исходные файлы, на которые ссылается пользовательский код, который вы вводите в другом месте в диалоговое окно S-Function Builder. Перечислите каждый файл на отдельной строке. Если файл находится в текущей папке, вы должны задать только имя файла. Если файл находится в другой папке, необходимо задать полный путь файла.

Также можно также использовать это поле, чтобы задать пути поиска файлов для библиотек, объектных файлов, заголовочных файлов и исходных файлов. Для этого введите тег LIB_PATH, INC_PATH или SRC_PATH, соответственно, сопровождаемый путем. Можно сделать столько записей этого вида, сколько вам нужно, но каждый должен находиться на отдельной строке.

Например, считайте Разработчика S-функции проектом, который находится в d:\matlab6p5\work и должен соединиться против следующих файлов:

Следующие записи позволяют Разработчику S-функции найти эти файлы:

SRC_PATH d:\externalsource
LIB_PATH $MATLABROOT\customobjs
LIB_PATH c:\customfolder
customfunctions.lib
userfunctions.obj
freesource.c

Когда этот пример иллюстрирует, можно использовать LIB_PATH, чтобы задать и объект и пути к файлам библиотеки. Можно включать имя библиотеки в объявление LIB_PATH, однако необходимо поместить имя объектного файла в отдельную строку. Тег $MATLABROOT указывает на путь относительно установки MATLAB. Вы включаете несколько записей LIB_PATH на отдельных строках. Пути ищутся в заданном порядке.

Можно также ввести препроцессор (-D) директивы в этом поле, например,

-DDEBUG

Каждая директива должна находиться на отдельной строке.

Включает

Заголовочные файлы, содержащие объявления функций, переменных и макросов, на которые ссылается пользовательский код, который вы вводите в другом месте в диалоговое окно S-Function Builder. Задайте каждый файл на отдельной строке как операторы #include. Используйте скобки, чтобы заключить имена стандарта C заголовочные файлы (например, #include <math.h>). Используйте кавычки, чтобы заключить имена пользовательских заголовочных файлов (например, #include "myutils.h"). Если ваша S-функция использует пользовательский, включают файлы, которые не находятся в текущей папке, необходимо использовать тег INC_PATH в поле Library/Object/Source files, чтобы установить включать путь для Разработчика S-функции к директориям, содержащим включать файлы (см. Библиотеку/Объект/Исходные файлы).

Внешние объявления функции

Объявления внешних функций, не объявленных в заголовочных файлах, перечислены в поле Includes. Поместите каждое объявление по отдельной строке. Разработчик S-функции включает заданные объявления в исходный файл S-функции, что он генерирует. Это позволяет код S-функции, который вычисляет состояния S-функции или выходные параметры, чтобы вызвать внешние функции.

Описание кода

Код для функции mdlOutputs, которая вычисляет вывод S-функции на каждом временном шаге (или хит шага расчета, в случае дискретной S-функции). При генерации исходного кода для S-функции Разработчик S-функции вводит код в этом поле в функции обертки формы

void sfun_Outputs_wrapper(const real_T *u,
						real_T       *y,
						const real_T *xD, /* optional */
						const real_T *xC, /* optional */
						const real_T  *param0, /* optional */
						int_T p_width0 /* optional */
						real_T  *param1 /* optional */
						int_t p_width1 /* optional */
						int_T y_width, /* optional */
						int_T u_width) /* optional */
{

/* Your code inserted here */
}

где sfun является именем S-функции. Разработчик S-функции вставляет вызов этой функции обертки в методе коллбэка mdlOutputs, который она генерирует для вашей S-функции. Механизм Simulink вызывает метод mdlOutputs на каждом шаге времени симуляции (или шаге шага расчета в случае дискретной S-функции), чтобы вычислить S-функцию вывод. Метод mdlOutputs в свою очередь вызывает функцию обертки, содержащую ваш выходной код. Ваш выходной код затем на самом деле вычисляет и возвращает S-функцию вывод.

Метод mdlOutputs передает некоторых или все следующие аргументы к выходной функции обертки.

Эти аргументы разрешают вам вычислять вывод блока как функция его входных параметров и, опционально, его состояний и параметров. Код, который вы вводите в этом поле, может вызвать внешние функции, объявленные в заголовочных файлах или внешних объявлениях на панели Libraries. Это позволяет вам использовать существующий код, чтобы вычислить выходные параметры S-функции.

Входные параметры необходимы в выходной функции

Установите этот флажок, если текущие значения S-входных-параметров-функции используются, чтобы вычислить его выходные параметры. Механизм Simulink использует эту информацию, чтобы обнаружить алгебраические циклы, созданные, прямо или косвенно соединяя S-функцию вывод с S-входным-параметром-функции.

Диагностика компиляции

Информация об отображениях как Разработчик S-функции генерирует исходные и исполняемые файлы C.

Покажите шаги компиляции

Регистрируйте каждый шаг сборки в поле Compilation diagnostics.

Создайте debuggable файл MEX

Включайте отладочную информацию в сгенерированный файл MEX.

Включите поддержку покрытия

Сделайте S-Function совместимый с покрытием модели. Для получения дополнительной информации смотрите Покрытие для Пользовательского Кода C/C++ в Моделях Simulink (Simulink Coverage) в документации Simulink Coverage™.

Сгенерируйте обертку TLC

Выбор этой опции позволяет вам генерировать файл TLC. Необходимо сгенерировать файл TLC, если вы запускаете свою модель в Быстром Режиме Accelerator или генерируете код Simulink Coder™ из вашей модели. Кроме того, в то время как это не необходимо для симуляций Режима Accelerator, файл TLC сгенерирует код для S-функции и таким образом заставляет вашу модель запуститься быстрее в Режиме Accelerator.

Сохраните код только

Не создавайте файл MEX из сгенерированного исходного кода.

Включите доступ к SimStruct

Делает SimStruct (S) доступный для функций обертки, которые генерирует Разработчик S-функции. Это позволяет вам использовать макросы SimStruct и функции с вашим кодом в Outputs, Continuous Derivatives и панелях Discrete Updates. Например, с этой включенной опцией, можно использовать макросы, такие как ssGetT в коде, который вычисляет S-функцию выходные параметры:

double t = ssGetT(S);
  if(t < 2 ) {
    y0[0] = u0[0];
  } else {
    y0[0]= 0.0;
  }

Дополнительные методы

Нажмите эту кнопку, чтобы включать дополнительные методы TLC в файл TLC для вашей S-функции. Проверяйте методы, вы хотите добавить и нажать кнопку Close, чтобы включать методы в ваш файл TLC. Для получения дополнительной информации см. Методы Конечного файла Блока (Simulink Coder).

Инициализация настроек S-функции

Панель Initialization задает количество дискретных состояний и их начальных условий, а также устанавливает шаг расчета S-функции. Этот пример содержит два дискретных состояния, каждый инициализированный к 1, и дискретный демонстрационный режим с шагом расчета 1.

Инициализируя входные параметры, Выходные параметры и параметры

Панель Data Properties задает размерности S-входного-параметра-функции и вывода, а также инициализирует матрицы пространства состояний.

Панель Input ports задает один порт S-входного-параметра-функции как 1D вектор с двумя строками.

Панель Output ports так же задает один выходной порт S-функции как 1D вектор с двумя строками.

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

Панель S-function parameters наверху Разработчика S-функции содержит фактические значения для матриц пространства состояний, вводимых как выражения MATLAB. В этом примере каждый параметр пространства состояний является two-two матрицей. Также можно сохранить матрицы пространства состояний в переменных в рабочем пространстве MATLAB и ввести имена переменных в поле Value для каждого параметра.

Определение Выходного метода

Панель Outputs вычисляет S-функцию вывод как функция входных векторов и векторов состояния и матриц пространства состояний. В выходном коде, ссылочные S-параметры-функции с помощью названий параметра, заданных на Data Properties — панель Parameters. Индексируйте в 2D матрицы с помощью скалярного индекса, имея в виду, что S-функции используют основанную на нуле индексацию. Например, чтобы получить доступ к элементу C(2,1) в S-параметре-функции C, используйте C[1] в коде S-функции.

Панель Outputs также выбирает опцию Inputs are needed in the output function (direct feedthrough), поскольку эта модель в пространстве состояний имеет ненулевую матрицу D.

Определение дискретного метода обновления

Панель Discrete Update обновляет дискретные состояния. Как с выходным кодом, используйте S-имена-параметров-функции и индекс в 2D матрицы с помощью скалярного индекса, имея в виду, что S-функции используют основанную на нуле индексацию. Например, чтобы получить доступ к элементу A(2,1) в S-параметре-функции A, используйте A[1] в коде S-функции. Переменная xD хранит окончательные значения дискретных состояний.

Создание примера пространства состояний

Нажмите кнопку Build на Разработчике S-функции, чтобы создать исполняемый файл для этой S-функции. Можно теперь запустить модель и сравнить вывод с исходной дискретной S-функцией пространства состояний, содержавшейся в sfcndemo_dsfunc.