主要内容

slreportgen.report.CFunction类

包:slreportgen.report

C函数块记者

自从R2021b

描述

使用的对象slreportgen.report.CFunction类报告C函数块。

默认情况下,CFunction对象的报告:

  • 一个表,其中包括描述参数和面具任何自定义参数

  • 一个列表的内容表符号参数

  • 部分定义的C代码输出代码,开始代码,终止代码参数

使用对象属性来排除或修改报告信息。

请注意

使用一个CFunction记者在一份报告中,您必须创建报告使用slreportgen.report.Report类。

slreportgen.report.CFunction类是一个处理类。

类属性

HandleCompatible
真正的

类属性的信息,请参阅类属性

创建

描述

rptr= slreportgen.report.CFunction ()创建一个CFunction对象的默认属性值。你必须指定C函数通过设置块报告对象财产。使用其他属性来指定报告选项。

例子

rptr= slreportgen.report.CFunction (cFunctionBlock)指定了C函数块报告和设置对象财产cFunctionBlock

rptr= slreportgen.report.CFunction (名称=值)使用名称-值参数设置属性。例如,rptr = slreportgen.report。CFunction(Object="slrgex_cfunction/C Function")设置对象财产“slrgex_cfunction / C函数”。您可以指定多个名称参数。

属性

全部展开

金宝appC函数报告,指定这些值之一:

请注意

如果您使用一个发现者C函数块和将结果直接添加到报告中,报告使用的块slreportgen.report.CFunction记者,而不是slreportgen.report.金宝appSimulinkObjectProperties记者。

是否包括一块表参数,指定为真正的。如果此属性真正的,记者生成一个表,其中包括描述参数和面具任何自定义参数,默认情况下。的输出代码,开始代码,终止代码,符号参数不包括在这个表,因为他们是在单独的部分。使用ObjectPropertiesReporter财产的记者指定的参数表包括或自定义表的格式。如果参数是空,记者不生成一个表。

属性:

GetAccess
公共
SetAccess
公共

是否包括使用的符号表C函数块,指定为真正的

属性:

GetAccess
公共
SetAccess
公共

是否包括C代码的输出用于计算C函数块,指定为真正的

属性:

GetAccess
公共
SetAccess
公共

是否包括C代码用于计算的状态C函数块的模拟,指定为真正的

属性:

GetAccess
公共
SetAccess
公共

是否包括初始化时执行的C代码C函数启用了块,指定为真正的。如果此属性真正的,记者在报告中包括条件初始化代码。如果C函数初始化代码块没有定义条件,没有添加到报告中。

属性:

GetAccess
公共
SetAccess
公共

是否包括C函数的C代码块执行终止时,指定为真正的

属性:

GetAccess
公共
SetAccess
公共

格式化程序的C函数块的属性表,指定为一个slreportgen.report.金宝appSimulinkObjectProperties对象。这个属性的默认值是一个空的slreportgen.report.金宝appSimulinkObjectProperties对象。您可以自定义块的外观属性表通过修改默认的属性对象或取代它金宝appSimulinkObjectProperties对象。您可以指定属性显示在这个表使用属性财产的金宝appSimulinkObjectProperties对象。如果属性是空的,记者将自动确定哪些属性来显示基于C功能块参数。

属性:

GetAccess
公共
SetAccess
公共

格式化程序表的符号使用的C函数块,指定为一个mlreportgen.report.BaseTable对象。这个属性的默认值是一个空的BaseTable对象的StyleName属性属性设置为“CFunctionSymbolsTable”。您可以自定义符号表的外观修改默认对象的属性或取代它BaseTable对象。任何的内容添加到标题属性BaseTable对象出现在默认生成表标题在报告中。

属性:

GetAccess
公共
SetAccess
公共

数据类型:

段落标题格式化程序的输出,开始和终止的代码部分报告,指定为一个mlreportgen.dom.Paragraph对象。这个属性的默认值是一个空的对象的StyleName属性属性设置为“CFunctionCodeTitle”。您可以自定义的外观章节标题的代码修改默认对象的属性或通过与另一个替换它对象。添加到任何内容对象在这个属性出现在报告中标题的代码。

属性:

GetAccess
公共
SetAccess
公共

数据类型:

格式化程序的C代码输出,开始和终止的代码部分报告,指定为一个mlreportgen.dom.Preformatted对象。这个属性的默认值是一个空的格式化对象与StyleName属性设置为“CFunctionCode”。您可以自定义的外观C代码修改默认对象的属性或取代它格式化对象。添加到任何内容格式化对象这个属性出现在格式化代码在报告中。

属性:

GetAccess
公共
SetAccess
公共

这个记者的模板,指定其中的一个方面:

  • 特征向量或字符串标量指定路径的文件,其中包含的模板的记者

  • 记者或报告的模板是用于这个记者或模板库中包含的模板的记者

  • DOM文档或文档模板的一部分用于记者或模板库中包含的模板的记者

指定的模板必须是相同的类型作为这个记者是附加的报告。例如,对于一个微软®报告,TemplateSrc必须是一个文字记者模板。如果TemplateSrc属性是空的,这个记者记者使用默认模板输出类型的报告。

属性:

GetAccess
公共
SetAccess
公共

这个记者,模板的名称指定为一个特征向量或字符串标量。这个记者的模板必须在指定的模板的模板库TemplateSrc这个记者的属性。

属性:

GetAccess
公共
SetAccess
公共

这个记者,超链接目标指定为一个特征向量或指定链接目标ID字符串标量,或一个mlreportgen.dom.LinkTarget对象。一个特征向量或字符串转换为一个标量值LinkTarget对象。链接目标立即先于这个记者在输出中报告的内容。

属性:

GetAccess
公共
SetAccess
公共

方法

全部展开

例子

全部折叠

这个示例中生成一个报告,其中包括一个C函数的信息块中使用一个模型。

导入报告API包,所以你不需要使用长,完全限定类名。

进口mlreportgen.report。*进口slreportgen.report。*

创建一个报告。

rpt = slreportgen.report.Report (“输出”,“pdf”);

加载一个模型,一个C函数块。

model_name =“slrgex_cfunction”;cFcnObj =“slrgex_cfunction / C函数”;load_system (model_name);

创建一个记者章。

章=章(cFcnObj);

创建一个C函数块记者。默认情况下,记者包括输出代码,开始代码,终止代码,符号参数,以及任何其他块参数在报告中。的终止代码C函数块的参数在本例中是空的。

rptr = CFunction (cFcnObj);

记者C函数添加到一章,一章。

追加(章,rptr);追加(rpt,章);

关闭并查看报告。

关闭(rpt);close_system (model_name);rptview (rpt);

这是C功能块中的信息报告:

版本历史

介绍了R2021b