clibgen.FunctionDefinition 类
命名空间: clibgen
对应于 C++ 包函数的 MATLAB 函数的定义
描述
clibgen.FunctionDefinition
类包含 C++ 头文件中定义的函数的 MATLAB® 定义。
clibgen.FunctionDefinition
类是一个 handle
类。
创建对象
当 MATLAB 对 clibgen.LibraryDefinition
对象调用 addFunction
时,MATLAB 会构造一个 FunctionDefinition
对象。
属性
Description
— 帮助文本
字符串 | 字符向量
最终用户用于描述包函数的帮助文本,指定为字符串或字符向量。发布者可以在库定义文件中修改 Description
属性的值。
示例: C++ 函数 charInput
的 clib.cppSample.charInput
表示。
属性:
GetAccess | public |
SetAccess | public |
DetailedDescription
— C++ 头文件中的帮助文本
字符串 | 字符向量 | 空字符串
最终用户用于描述关于包函数的详细信息的 C++ 头文件中的帮助文本,指定为字符串或字符向量。如果 C++ 注释不包含详细信息,则 DetailedDescription
不会出现在定义文件中。
发布者可以在库定义文件中修改 DetailedDescription
属性的值。如果 DetailedDescription
不为空,则 MATLAB doc
命令会在显示 DetailedDescription
的值之前显示以下句子。
This content is from the external library documentation.
属性:
GetAccess | public |
SetAccess | public |
CPPSignature
— C++ 函数签名
字符串 | 字符向量
C++ 函数签名,指定为字符串或字符向量。MATLAB 根据头文件中的函数定义创建 CPPSignature
。
示例: void intInput(int * ptr,int len)
属性:
GetAccess | public |
SetAccess | private |
DefiningLibrary
— 包含函数的库
clibgen.LibraryDefinition
MATLABName
— MATLAB 中的 C++ 函数名称
字符串 | 字符向量
MATLAB 中的 C++ 函数名称,指定为字符串或字符向量。
属性:
GetAccess | public |
SetAccess | private |
MATLABSignature
— MATLAB 中的函数签名
字符串 | 字符向量
MATLAB 中的函数签名,指定为字符串或字符向量。MATLAB 创建此签名。
属性:
GetAccess | public |
SetAccess | private |
Dependent | true |
Valid
— 定义完整指示符
false
(默认) | true
指示函数定义是否完整,指定为 true
或 false
。
属性:
GetAccess | public |
SetAccess | private |
TemplateUniqueName
— 首选函数名称
字符串 | 字符向量
存在重载函数时从模板派生的函数的首选函数名称,指定为字符串或字符向量。
示例: "clib.libname.task_int_"
属性:
GetAccess | public |
SetAccess | private |
方法
公共方法
defineArgument | 添加 C++ 包函数的输入参量定义 |
defineOutput | 添加 C++ 包函数的输出参量定义 |
validate | 验证函数定义 |
版本历史记录
在 R2019a 中推出
MATLAB 命令
您点击的链接对应于以下 MATLAB 命令:
请在 MATLAB 命令行窗口中直接输入以执行命令。Web 浏览器不支持 MATLAB 命令。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)