主要内容

slreportgen.report.DataDictionary类

包:slreportgen.report
超类:slreportgen.report.Reporter

金宝app数据字典的记者

自从R2020b

扩展所有的页面

描述

使用的对象slreportgen.report.DataDictionary类报道一个仿真软件金宝app®数据字典。创建一个DataDictionary对象报告在一个特定的数据字典。或者,使用一个slreportgen.finder.DataDictionaryFinder找到数据字典和使用对象getReporter方法的一个slreportgen.finder.DataDictionaryResult对象来返回结果的记者。

请注意

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

的slreportgen.report.DataDictionary类是一个处理类。

类属性

HandleCompatible
真正的

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

创建

描述

记者= slreportgen.report.DataDictionary ()创建一个DataDictionary记者根据默认模板对象。使用记者属性指定一个数据字典和报告选项。您必须指定报告的数据字典。添加一个空的数据字典记者报告对象产生一个错误。

例子

记者= slreportgen.report.DataDictionary (dictionaryName)创建一个DataDictionary记者对象和设置字典属性指定的数据字典。使用记者属性来指定报告选项。

记者= slreportgen.report.DataDictionary (名称=值)集记者属性使用名称-值对。你可以在任何顺序指定多个参数名称-值对。

属性

全部展开

数据字典来报告,指定为一个特征向量包含文件名或字符串标量MATLAB的字典®路径或一个数据字典的路径和文件名。可以相对或绝对路径。

例子:“sldemo_fuelsys_dd.sldd”

例子:“myDictionaries / myDataDictionary.sldd”

属性:

GetAccess
公共
SetAccess
公共

为每个数据字典条目属性报告在总结表中,指定为字符串数组或单元阵列的特征向量。有效的属性是:

  • 的名字

  • 价值

  • 类

  • LastModified

  • LastModifiedBy

  • 状态

  • 数据源

的价值条目包含的值如果数字标量数据类型,逻辑标量字符串标量,或特征向量。否则,价值条目看到细节。

例子:(“名字”“价值”“类”“LastModified”“LastModifiedBy”“状态”“数据源”]

例子:{“名称”“价值”“类”}

属性:

GetAccess
公共
SetAccess
公共

是否报告设计数据部分的数据字典,指定为真正的或假。

属性:

GetAccess
公共
SetAccess
公共

数据类型:逻辑

是否报告配置部分的数据字典,指定为真正的或假。

属性:

GetAccess
公共
SetAccess
公共

数据类型:逻辑

是否报告其他数据部分的数据字典,指定为真正的或假。

属性:

GetAccess
公共
SetAccess
公共

数据类型:逻辑

是否包括引用的字典词典,这记者报道,指定为真正的或假。的ReferencedDictionaryPolicy属性决定了如何报道引用字典。

属性:

GetAccess
公共
SetAccess
公共

数据类型:逻辑

显示政策报告引用字典,指定这些值之一:

  • “SameTable”——报告引用字典条目在同一个表主字典条目。细节显示在汇总表中出现的顺序。这个值是默认值。

  • “SeparateTables”——做一个单独的表为每个引用的字典。引用字典汇总表后立即显示主要的汇总表。记者引用字典细节显示在主字典记者细节。

  • “列表”——报告引用字典的列表。列表项链接到单独的数据字典记者。工作只有你的链接添加引用字典的记者。出现在列表设计数据部分,后立即字典汇总表。字典汇总表不包括引用字典条目。引用字典条目的细节都没有报告。

属性:

GetAccess
公共
SetAccess
公共

数据字典条目过滤器,指定为一个函数处理,字符串标量,或特征向量。如果你不提供的EntryFilterFcn在报告中,所有条目都包括。

如果你提供一个函数处理,相关的函数必须:

  • 把这些参数:

  • 返回真正的从报告,过滤指定的条目假在报告中包含的条目。

例如,这个代码使用EntryFilterFcn财产,防止报告的条目金宝appSimulink.Parameter对象:

rpt = slreportgen.report.Report (“MyReport”,“pdf”);ddPath = (“slrgex_fuelsys.sldd”);ch = mlreportgen.report.Chapter (“slrgex_fuelsys.sldd”);rptr = slreportgen.report.DataDictionary (ddPath);filterFcnHandle = @ (entryObject entryValue)…isa (entryValue“金宝appSimulink.Parameter”);rptr。EntryFilterFcn = filterFcnHandle;追加(ch, rptr);追加(rpt, ch);关闭(rpt);rptview (rpt);

如果你提供一个字符串标量或一个特征矢量,它必须包含一个表达式。表达式:

  • 可以使用变量entryObject和entryValue

  • 必须设置变量isFiltered来真正的从报告,过滤指定的条目假在报告中包含的条目

例如,这个代码使用EntryFilterFcn财产,防止报告的条目金宝appSimulink.Bus对象:

rpt = slreportgen.report.Report (“MyReport”,“pdf”);ddPath = (“slrgex_fuelsys.sldd”);ch = mlreportgen.report.Chapter (“slrgex_fuelsys.sldd”);rptr = slreportgen.report.DataDictionary (ddPath);filterStr =“isFiltered = isa (entryValue 金宝appSimulink.Bus);“;rptr。EntryFilterFcn = filterStr;追加(ch, rptr);追加(rpt, ch);关闭(rpt);rptview (rpt);

属性:

GetAccess
公共
SetAccess
公共

格式化程序入口汇总表,指定为一个mlreportgen.report.BaseTable对象。此属性的默认值BaseTable对象的TableStyleName属性设置为DataDictionaryTable风格定义的默认模板DataDictionary记者。定制的外观表,修改默认的属性BaseTable对象或对象换成一个定制的BaseTable记者。如果你添加内容标题属性,表的内容出现在前面标题在生成的报告。

属性:

GetAccess
公共
SetAccess
公共

格式化程序报告中的条目的详细信息的值设计数据和其他数据部分的数据字典,指定为一个mlreportgen.report.MATLABVariable对象。此属性的默认值MATLABVariable对象的默认属性值。自定义条目的外观细节,修改默认的属性MATLABVariable对象或对象替换为你自己的MATLABVariable记者。的变量,位置,LinkTarget的属性MATLABVariable记者将被忽略。

属性:

GetAccess
公共
SetAccess
公共

格式化程序报告的细节条目的值配置部分数据字典,指定为一个slreportgen.report.ModelConfiguration对象。此属性的默认值ModelConfiguration对象的默认属性值。自定义条目的外观细节,修改默认对象的属性或换成你自己的ModelConfiguration对象。的模型和LinkTarget记者的属性将被忽略。

属性:

GetAccess
公共
SetAccess
公共

格式化程序列表引用字典列表中,指定为一个mlreportgen.dom.UnorderedList对象或mlreportgen.dom.OrderedList对象。当使用的格式化程序列表ReferencedDictionaryPolicy属性设置为“列表”。的UnorderedList或OrderedList对象必须不包含列表项。

这个属性的默认值是一个UnorderedList对象的StyleName属性属性设置为DataDictionaryList风格,这定义的默认模板DataDictionary记者。定制的外观列表,修改默认的属性UnorderedList对象或对象替换为你自己的UnorderedList或OrderedList对象。

属性:

GetAccess
公共
SetAccess
公共

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

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

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

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

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

属性:

GetAccess
公共
SetAccess
公共

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

属性:

GetAccess
公共
SetAccess
公共

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

属性:

GetAccess
公共
SetAccess
公共

方法

全部展开

例子

全部折叠

打开生活的脚本

使用的对象slreportgen.report.DataDictionary类报道一个模型数据字典。金宝app

导入MATLAB和Simulink报告API包,所以你不需金宝app要使用长,完全限定类名。

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

创建一个模型报告。金宝app

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

指定使用的数据字典的路径模型slrgex_fuelsys。

ddPath = (“slrgex_fuelsys.sldd”);

创建一个数据字典信息章。

ch =章(“slrgex_fuelsys.sldd”);

创建一个数据字典的记者。

rptr = DataDictionary (ddPath);

附加记者章,这一章。

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

关闭并查看报告。

关闭(rpt);rptview (rpt);

版本历史

介绍了R2020b

另请参阅

||

主题