coder.cstructname

在生成代码中命名 C 结构体类型

全页折叠

语法

coder.cstructname(var,structName)
coder.cstructname(var,structName,'extern','HeaderFile',headerfile)
coder.cstructname(var,structName,'extern','HeaderFile',headerfile,'Alignment',alignment)
outtype = coder.cstructname(intype,structName)
outtype = coder.cstructname(intype,structName,'extern','HeaderFile',headerfile)
outtype = coder.cstructname(intype,structName,'extern','HeaderFile',headerfile,'Alignment',alignment)

说明

coder.cstructname 为生成的或外部定义的、用于 MATLAB® 变量（在生成的代码中表示为结构体）的 C 语言结构体类型命名。

coder.cstructname(var,structName) 为针对 MATLAB 变量 var 生成的 C 语言结构体类型命名。输入 var 可以是结构体或元胞数组。在为函数生成代码时，可在该函数中使用此语法。将 coder.cstructname 放置在定义 var 的语句之后，第一次使用 var 的语句之前。如果 var 是入口（顶层）函数输入参量，请将 coder.cstructname 放在函数的开头且在任何控制流语句之前。

示例

coder.cstructname(var,structName,'extern','HeaderFile',headerfile) 指定用作 var 的 C 结构体类型的名称为 structName，且是在外部文件 headerfileName 中定义的。

可以在不指定头文件的情况下使用 'extern' 选项。但是，最好指定头文件，以便代码生成器在正确的位置生成 #include 语句。

示例

coder.cstructname(var,structName,'extern','HeaderFile',headerfile,'Alignment',alignment) 还指定外部定义的结构体类型 structName 的运行时内存对齐方式。如果您有 Embedded Coder® 并使用自定义代码替换库 (CRL)，请指定对齐方式，以便代码生成器可以匹配要求结构体对齐的 CRL 函数。请参阅Data Alignment for Code Replacement (Embedded Coder)。如果 var 是元胞数组，则无法使用此语法。

outtype = coder.cstructname(intype,structName) 返回一个结构体或一个元胞数组类型对象 outtype，它指定要生成的 C 结构体类型的名称。coder.cstructname 使用输入类型 intype 的属性创建 outtype。然后，它将 TypeName 属性设置为 structName。使用此语法创建可用于 codegen -args 选项的类型对象。在为函数生成代码时，不能在该函数中使用此语法。您不能在 MATLAB Function 模块中使用此语法。

示例

outtype = coder.cstructname(intype,structName,'extern','HeaderFile',headerfile) 返回指定外部定义的 C 结构体类型的名称和位置的类型对象 outtype。代码生成器对类型为 outtype 的变量使用外部定义的结构体类型。您不能在 MATLAB Function 模块中使用此语法。

outtype = coder.cstructname(intype,structName,'extern','HeaderFile',headerfile,'Alignment',alignment) 创建一个还指定 C 结构体类型对齐方式的类型对象 outtype。如果 intype 是 coder.CellType 对象或元胞数组，则无法使用此语法。您不能在 MATLAB Function 模块中使用此语法。

示例

全部折叠

在 MATLAB 函数 myfun 中，为变量 v 的所生成的 C 结构体类型指定名称 MyStruct。

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 中，为结构体 v 所生成的 C 结构体类型指定名称 MyStruct。将名称 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 中，为元胞数组 c 所生成的 C 结构体类型指定名称 myStruct。

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 头文件中定义的结构体类型。

为接受 mycstruct 类型的参数的 mycadd 函数创建 C 头文件 mycadd.h。在头文件中定义类型 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 指定在生成的代码中，结构体具有在 mycadd.h 中定义的 C 类型 mycstruct。 

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));

为函数 mymAdd 生成 C 静态库。

codegen -config:lib mymAdd mycadd.c
生成的头文件 mymadd_types.h 不包含结构体 mycstruct 的定义，因为 mycstruct 是外部类型。

假设入口函数 myFunction 接受结构体参量。要在命令行中指定输入参量的类型，请执行以下操作：

  1. 定义示例结构体 S。

  2. 通过使用 coder.typeof 从 S 创建类型 T。

  3. 使用 coder.cstructname 创建类型 T1，该类型：

    • 具有 T 的属性。

    • 为生成的 C 结构体类型指定名称 myStruct。

  4. 通过使用 -args 选项将类型传递给 codegen。

例如：

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 Function 模块，在仿真目标和代码生成 > 自定义代码窗格中的附加编译信息下，设置包含目录参数。

或者，结合使用 coder.updateBuildInfo 和 'addIncludePaths' 选项。

示例: 'mystruct.h'

生成的或外部定义的结构体的运行时内存对齐。代码生成不支持此参量用于元胞数组或元胞数组类型。

用于创建类型对象的结构体类型对象、元胞数组类型对象、结构体变量或元胞数组变量。

限制

  • 您不能将 coder.cstructname 直接应用于全局变量。要命名用于全局变量的结构体类型，请使用 coder.cstructname 创建命名结构体类型的类型对象。然后，当您运行 codegen 时，指定全局变量具有该类型。请参阅Name C Structure Type to Use with Global Structure Variable (MATLAB Coder)。

  • 对于元胞数组输入，外部定义的结构体的字段名称必须为 f1、f2 等，以此类推。

  • 您无法将 coder.cstructname 直接应用于类属性。

提示

  • 有关代码生成器如何确定结构体字段的 C/C++ 类型的信息，请参阅将 MATLAB 类型映射到生成的代码中的类型 (MATLAB Coder)。

  • 对结构体数组使用 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 对象结合使用。有关元胞数组何时为永久性同构的信息，请参阅Specify Cell Array Inputs at the Command Line (MATLAB Coder)。

    • 当与 coder.CellType 对象结合使用时，coder.cstructname 会创建永久性异构的 coder.CellType 对象。

  • 在具有行优先和列优先数组布局的工程中使用由 coder.cstructname 命名的结构体时，代码生成器会在某些情况下重命名结构体，将 row_ 或 col_ 附加到结构体名称的开头。此重命名为这两个数组布局中使用的类型提供唯一的类型定义。

  • 下列提示仅适用于 MATLAB Function 模块：

    • MATLAB Function 模块输入和输出结构体与总线信号相关联。生成的结构体类型名称来自总线信号名称。请勿使用 coder.cstructname 为输入或输出信号的结构体类型命名。请参阅在 MATLAB Function 模块中创建结构体。

    • 代码生成器会根据标识符命名规则生成结构体类型名称，即使您使用 coder.cstructname 命名结构体类型也是如此。如果您有 Embedded Coder，则可以自定义命名规则。请参阅Construction of Generated Identifiers (Embedded Coder)。

扩展功能

全部展开

C/C++ 代码生成
使用 MATLAB® Coder™ 生成 C 代码和 C++ 代码。

GPU 代码生成
使用 GPU Coder™ 为 NVIDIA® GPU 生成 CUDA® 代码。

版本历史记录

在 R2011a 中推出

另请参阅

主题