Exponenta Banner
exponenta event banner

coder.cstructname

Имя типа структуры C в сгенерированном коде

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

Синтаксис

coder.cstructname (var, structName)
coder.cstructname (var, structName, «extern», «HeeyFile», файл заголовка)
coder.cstructname (var, structName, «extern», «HeeyFile», файл заголовка, «Alignment», выравнивание)
outtype = coder.cstructname (intype, structName)
outtype = coder.cstructname (intype, structName, «extern», «HeeyFile», файл заголовка)
outtype = coder.cstructname (intype, structName, «extern», «HeeyFile», файл заголовка, «Alignment», выравнивание)

Описание

coder.cstructname называет сгенерированный или внешний тип структуры C для использования в переменных MATLAB ®, которые представлены в виде структур в сгенерированном коде.

пример

coder.cstructname(var,structName) имя типа структуры C, созданного для переменной MATLAB var. Вход var может быть структурой или массивом ячеек. Этот синтаксис используется в функции, на основе которой создается код. Место coder.cstructname после определения var и до первого использования var. Если var - входной аргумент функции начального уровня (верхнего уровня), место coder.cstructname в начале функции, перед любыми операторами потока управления.

пример

coder.cstructname(var,structName,'extern','HeaderFile',headerfile) указывает, что тип структуры C, используемый для var имеет имя structName и определяется во внешнем файле, headerfileName.

Возможно использование 'extern' без указания файла заголовка. Однако рекомендуется указывать файл заголовка так, чтобы генератор кода создавал #include оператор в правильном расположении.

coder.cstructname(var,structName,'extern','HeaderFile',headerfile,'Alignment',alignment) также определяет выравнивание памяти во время выполнения для внешнего типа структуры structName. Если имеется Embedded Coder ® и используются пользовательские библиотеки замены кода (CRL), укажите выравнивание, чтобы генератор кода мог соответствовать функциям CRL, требующим выравнивания для структур. См. раздел Выравнивание данных для замены кода (встроенный кодер).

пример

outtype = coder.cstructname(intype,structName) возвращает объект типа структуры или массива ячеек outtype указывает имя создаваемого типа структуры C. coder.cstructname создает outtype со свойствами типа ввода intype. Затем он устанавливает TypeName свойство для structName. Этот синтаксис используется для создания объекта типа, используемого с codegen -args вариант. Этот синтаксис нельзя использовать в функции, из которой создается код.

Этот синтаксис нельзя использовать в блоке функции MATLAB.

outtype = coder.cstructname(intype,structName,'extern','HeaderFile',headerfile) возвращает объект типа outtype указывает имя и местоположение внешнего типа структуры C. Генератор кода использует внешний тип структуры для переменных с типом outtype.

Этот синтаксис нельзя использовать в блоке функции MATLAB.

outtype = coder.cstructname(intype,structName,'extern','HeaderFile',headerfile,'Alignment',alignment) создает объект типа outtype который также определяет выравнивание типа структуры C.

Этот синтаксис нельзя использовать в блоке функции MATLAB.

Примеры

свернуть все

В функции MATLAB myfun, присвойте имя MyStruct к сгенерированному типу структуры C для переменной v.

function y = myfun()
%#codegen
v = struct('a',1,'b',2);
coder.cstructname(v, 'myStruct');
y = v;
end

Создайте автономный код C. Например, создайте статическую библиотеку.

codegen -config:lib myfun -report

Для просмотра созданного типа структуры откройте codegen/lib/myfun/myfun_types.h или просмотр myfun_types.h в отчете о создании кода. Генерируемый тип структуры C:

typedef struct {
  double a;
  double b;
} myStruct;

В функции MATLAB myfun1, присвойте имя MyStruct к сгенерированному типу структуры C для структуры v. Присвойте имя mysubStruct к типу структуры, созданной для подструктуры v.b.

function y = myfun()
%#codegen
v = struct('a',1,'b',struct('f',3));
coder.cstructname(v, 'myStruct');
coder.cstructname(v.b, 'mysubStruct');
y = v;
end

Созданный тип структуры C mysubStruct является:

typedef struct {
  double f;
} mysubStruct;

Созданный тип структуры C myStruct является:

typedef struct {
  double a;
  mysubStruct b;
} myStruct;

В функции MATLAB myfun2, присвойте имя myStruct к сгенерированному типу структуры C для массива ячеекc.

function z = myfun2()
c = {1 2 3};
coder.cstructname(c,'myStruct')
z = c;

Созданный тип структуры C для c является:

typedef struct {
  double f1;
  double f2;
  double f3;
} myStruct;

Укажите, что структура, передаваемая функции C, имеет тип структуры, определенный в файле заголовка C.

Создание файла заголовка C mycadd.h для функции mycadd который принимает параметр типа mycstruct. Определение типа mycstruct в файле заголовка.

#ifndef MYCADD_H
#define MYCADD_H

typedef struct {
    double f1;
    double f2;
} mycstruct;

double mycadd(mycstruct *s);
#endif

Запишите функцию C mycadd.c.

#include <stdio.h>
#include <stdlib.h>

#include "mycadd.h"

double mycadd(mycstruct *s)
{
  return  s->f1 + s->f2;
}

Запись функции MATLAB mymAdd который передает структуру по ссылке на mycadd. Использовать coder.cstructname чтобы указать, что в сгенерированном коде структура имеет тип C mycstruct, которая определена в mycadd.h. 

function y = mymAdd
%#codegen
s = struct('f1', 1, 'f2', 2);
coder.cstructname(s, 'mycstruct', 'extern', 'HeaderFile', 'mycadd.h');
y = 0;
y = coder.ceval('mycadd', coder.ref(s));

Создание статической библиотеки C для функции mymAdd.

codegen -config:lib mymAdd mycadd.c
Созданный файл заголовка mymadd_types.h не содержит определения структуры mycstruct потому что mycstruct является внешним типом.

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

  1. Определение примерной структуры S.

  2. Создание типа T от S с помощью coder.typeof.

  3. Использовать coder.cstructname для создания типа T1 что:

    • Имеет свойства T.

    • Имя созданного типа структуры C myStruct.

  4. Передать тип в codegen с помощью -args вариант.

Например:

S = struct('a',double(0),'b',single(0));
T = coder.typeof(S);
T1 = coder.cstructname(T,'myStruct');
codegen -config:lib myFunction -args T1

Кроме того, тип структуры можно создать непосредственно из примера структуры.

S = struct('a',double(0),'b',single(0));
T1 = coder.cstructname(S,'myStruct');
codegen -config:lib myFunction -args T1

Входные аргументы

свернуть все

Структура MATLAB или переменная массива ячеек, которая представлена как структура в сгенерированном коде.

Имя сгенерированного или внешнего типа структуры C, указанного как вектор символов или скаляр строки.

Файл заголовка, содержащий определение типа структуры C, указанное как вектор символа или скаляр строки.

Чтобы указать путь к файлу:

  • Используйте codegen -I параметр или параметр «Дополнительные каталоги включения» на вкладке «Пользовательский код» приложения MATLAB Coder™.

  • Для функционального блока MATLAB на панелях Цель моделирования (Simulation Target) и Создание кода (Code Generation) > Пользовательский код (Custom Code) в разделе Дополнительные сведения о построении установите параметр Включить каталоги (Include directory).

В качестве альтернативы можно использовать coder.updateBuildInfo с 'addIncludePaths' вариант.

Пример: 'mystruct.h'

Выравнивание памяти во время выполнения для сгенерированной или внешней структуры.

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

Ограничения

  • Вы не можете применить coder.cstructname непосредственно к глобальной переменной. Для присвоения имени типу структуры, используемому с глобальной переменной, используйте coder.cstructname для создания объекта типа с именем типа структуры. Затем, когда вы бежите codegenукажите, что глобальная переменная имеет этот тип. См. раздел Наименование типа структуры C для использования с переменной глобальной структуры.

  • Для входов массива ячеек имена полей внешних структур должны быть f1, f2и так далее.

  • Вы не можете применить coder.cstructname непосредственно к свойству класса.

Совет

  • Сведения о том, как генератор кода определяет типы C/C + + полей структуры, см. в разделе Сопоставление типов MATLAB типам в сгенерированном коде.

  • Используя coder.cstructname в массиве структуры задает имя типа структуры базового элемента, а не имя массива. Поэтому вы не можете применить coder.cstructname к элементу структурного массива, а затем применить его к массиву с другим именем типа структуры C. Например, следующий код не разрешен. Второе coder.cstructname пытается задать для имени базового типа значение myStructArrayName, которая конфликтует с ранее указанным именем, myStructName.

    % Define scalar structure with field a 
myStruct = struct('a', 0); 
coder.cstructname(myStruct,'myStructName'); 
% Define array of structure with field a 
myStructArray = repmat(myStruct,4,6); 
coder.cstructname(myStructArray,'myStructArrayName');

  • Применение coder.cstructname к элементу массива структуры дает тот же результат, что и применение coder.cstructname ко всему массиву структуры. Если вы подаете заявку coder.cstructname к элементу массива структуры необходимо обратиться к элементу с помощью одного подстрочного индекса. Например, можно использовать var(1), но не var(1,1). Применение coder.cstructname кому var(:) дает тот же результат, что и применение coder.cstructname кому var или var(n).

  • Гетерогенные массивы ячеек представлены в виде структур в сгенерированном коде. Вот соображения по использованию coder.cstructname с массивами ячеек:

    • В функции, на основе которой создается код, используется coder.cstructname с переменной массива ячеек делает массив ячеек гетерогенным. Поэтому, если массив ячеек является вводом функции точки входа и его тип является постоянно однородным, то нельзя использовать coder.cstructname с массивом ячеек.

    • Используя coder.cstructname с однородным coder.CellType объект intype делает возвращенный объект неоднородным. Поэтому нельзя использовать coder.cstructname с постоянно однородным coder.CellType объект. Сведения о том, когда массив ячеек является постоянно однородным, см. в разделе Указание входов массива ячеек в командной строке.

    • При использовании с coder.CellType объект, coder.cstructname создает coder.CellType объект, который является постоянно неоднородным.

  • При использовании структуры с именем coder.cstructname в проекте с макетами массива «основные строки» и «основные столбцы» генератор кода переименовывает структуру в определенных случаях, добавляя row_ или col_ до начала имени структуры. Это переименование предоставляет уникальные определения типов для типов, используемых в обеих компоновках массива.

  • Эти советы относятся только к функциональным блокам MATLAB:

    • Структуры ввода и вывода функциональных блоков MATLAB связаны с сигналами шины. Сгенерированное имя типа структуры происходит от имени сигнала шины. Не использовать coder.cstructname для присвоения имени типу структуры входных или выходных сигналов. См. раздел Создание структур в функциональных блоках MATLAB (Simulink).

    • Генератор кода создает имена типов структуры в соответствии с правилами именования идентификаторов, даже если тип структуры называется coder.cstructname. При наличии встроенного кодера можно настроить правила именования. См. раздел Построение сгенерированных идентификаторов (встроенный кодер).

См. также

| | |

Темы

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

Документация по кодеру MATLAB

Поддержка