slreportgen.report.SimulinkObjectProperties class
Package: slreportgen.report
Simulink object properties reporter
Description
The SimulinkObjectProperties
reporter generates tables that list the
properties and property values of Simulink® objects.
Note
To use a Simulink object properties reporter in a report, you must create the
report using the slreportgen.report.Report
class.
Construction
creates
an empty Simulink object properties reporter. Use the reporter
= SimulinkObjectProperties()Object
property to specify the object to report.
To specify the list of Simulink object properties to include in the generated properties table, use the
Properties
property of the reporter. If you do not specify any
properties, the reporter includes a default set of properties based on the object type.
For example, the property table for a block includes the properties set by its parameter
dialog box.
To customize the format of the generated property table, use the PropertyTable
property.
Note
This reporter compiles the model containing the object to be reported if the model is not already compiled. Compiling the model is necessary to propagate values to properties that are unspecified when the model has not been compiled. The model is uncompiled when you close the report that contains the generated property table.
creates a reporter that generates a table listing the property values of the specified
Simulink object.reporter
= SimulinkObjectProperties(obj
)
sets properties using name-value pairs. You can specify multiple name-value pair
arguments in any order.reporter
= SimulinkObjectProperties(Name=Value
)
Input Arguments
Properties
Methods
createTemplate | Create Simulink object properties reporter template |
customizeReporter | Create custom Simulink object properties class |
getClassFolder | Simulink object properties class definition file location |
Examples
Add Properties Table to Report
Use the SimulinkObjectProperties
reporter to add a properties table
for the slrgex_vdp
model to the
report.
import slreportgen.report.* import mlreportgen.report.* model_name = "slrgex_vdp"; load_system(model_name); rpt = slreportgen.report.Report("output","pdf"); chapter = Chapter(model_name); rptr = SimulinkObjectProperties(model_name); add(chapter, rptr); add(rpt, chapter); close(rpt); close_system(model_name); rptview(rpt);
Specify Object Properties for Report Table
Add a properties table to a report and include properties for a model line segment only.
import slreportgen.report.* import mlreportgen.report.* model_name = "slrgex_vdp"; rpt = slreportgen.report.Report("output","pdf"); chapter = Chapter(model_name); load_system(model_name); ph = get_param("slrgex_vdp/Mu","PortHandles"); outPort = ph.Outport; line = get_param(outPort,"Line"); rptr = SimulinkObjectProperties(line); rptr.Properties = {"Parent","SourcePort","StorageClass"}; add(chapter,rptr); add(rpt,chapter); close(rpt); close_system(model_name); rptview(rpt);