slreportgen.report.ModelVariable Class

Namespace: slreportgen.report
Superclasses: slreportgen.report.Reporter

Model variable reporter

Description

Reporter for a Simulink^® model variable.

Note

To use an slreportgen.report.ModelVariable reporter in a report, you must create the report using the slreportgen.report.Report class or subclass.

The slreportgen.report.ModelVariable class is a handle class.

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

You do not create an slreportgen.report.ModelVariable object explicitly. To get the slreportgen.report.ModelVariable object for a found model variable:

• Use the find or next method of the slreportgen.finder.ModelVariableFinder object to get the slreportgen.finder.ModelVariableResult object for the found variable.

• Call the getReporter method of the slreportgen.finder.ModelVariableResult object to get the slreportgen.report.ModelVariable object.

You can customize the reporting of a model variable by setting the properties of the slreportgen.report.ModelVariable object.

Properties

Variable — Simulink.VariableUsage object

Simulink.VariableUsage

The Simulink.VariableUsage object that corresponds to the variable to report on. The object contains the name of the variable, the source of the variable, and the blocks that use the variable. This property is read-only.

Attributes:

GetAccess	public
SetAccess	public

ModelBlockPath — Path of Model block that sets the value of variable

[] | character vector | string scalar

Path of the Model block that sets the variable value, specified as a character vector or a string scalar. Suppose that a referenced model uses a model argument to set a block parameter value. If a model has multiple instances of the referenced model, the model variable finder returns multiple instances of the variable that is associated with the model argument. The ModelBlockPath property uniquely identifies the instance of the variable by providing the path to the model block that set its value. If a variable is not associated with a model argument in a referenced model, the ModelBockPath is empty. For more information about referenced models and instance-specific parameters, see Configure Instance-Specific Values for Block Parameters in a Referenced Model.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

ShowUsedBy — Whether to include blocks that use this variable

1 (true) (default) | 0 (false)

Whether to include a list of blocks that use this variable, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include a list of blocks that use this variable.

• 0 (false) — Omit a list of blocks that use this variable.

If the FormatPolicy property has a value of "Inline Text", the list of blocks is not included in the report, regardless of the value of the ShowUsedBy property.

If the report includes reported content for a block in the Used By list, clicking the hyperlink for the block takes you to the content. See Generate Report of Model Variables, Diagrams, and Blocks.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ShowWorkspaceInfo — Whether to include workspace

1 (true) (default) | 0 (false)

Whether to include the workspace that the variable is resolved in, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include the workspace that the variable is resolved in.

• 0 (false) — Omit the workspace that the variable is resolved in.

If the FormatPolicy property has a value of "Inline Text", the workspace is not included in the report, regardless of the value of the ShowWorkspaceInfo property.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ListFormatter — List formatter

mlreportgen.dom.UnorderedList (default) | mlreportgen.dom.OrderedList

List formatter that formats the generated list, specified as an mlreportgen.dom.UnorderedList object or an mlreportgen.dom.OrderedList object. The default value of this property is an object of mlreportgen.dom.UnorderedList. To customize the list formatting, modify the list object properties or replace the list object with a customized list object that does not contain list items.

Attributes:

GetAccess	public
SetAccess	public

FormatPolicy — Format of variable values

"Auto" (default) | "Table" | "Paragraph" | "Inline Text"

Format of the variable values, specified as one of these values:

• "Auto" — Formats the variable values as a table or a paragraph, depending on the data type of the value.

  Data types formatted as a table include:

  • Cell array

  • Logical array

  • Numeric array

  • MATLAB^® table

  • Simulink object

  • Stateflow^® object

  • Graphics object

  • MATLAB structure or structure array

  • MATLAB object or object array

  Data types formatted as a paragraph include:

  • Cell vector

  • Logical scalar or vector

  • Numeric scalar or vector

  • Character or character array

  • String

  • MATLAB structure vector

  • MATLAB object vector

• "Table" — Formats the variable values in a table. Variables that by default appear as paragraphs are formatted instead as table entries. Variables that are hierarchically structured objects, such as a MATLAB structures, MATLAB objects, Simulink objects, Stateflow objects, or graphics objects, can have properties that are themselves objects. In that case, the hierarchy is flattened and the property value is displayed as a hyperlink to a table of the properties of that object. The object property table also has a hyperlink back to the original table.

• "Paragraph" — Format the variable values as a paragraph. Variables that by default are formatted as tables are flattened and formatted as a paragraph.

• "Inline Text" — Formats the variable in line with the surrounding text.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

TableReporter — Table reporter

mlreportgen.report.Basetable

Table reporter used to format the value of the variable, specified as an mlreportgen.report.BaseTable object. The default value of this property is a BaseTable object with the TableStyleName property set to the ModelVariableTable style, which is defined in the default template for a ModelVariable reporter.

To customize the appearance of the table, modify the properties of the default table reporter or replace it with a customized table reporter. If you add content to the Title property of the default or customized table reporter, the content appears in front of the table title in the generated report.

Attributes:

GetAccess	public
SetAccess	public

ParagraphFormatter — Paragraph formatter

mlreportgen.dom.Paragraph object

Paragraph formatter to format the value of a model variable, specified as an mlreportgen.dom.Paragraph object. The default value of this property is a BaseTable object with the TableStyleName property set to the ModelVariableParagraph style, which is defined in the default template for a ModelVariable reporter.

To customize the appearance of the paragraph, modify the properties of the mlreportgen.dom.Paragraph object or replace the object with a customized mlreportgen.dom.Paragraph object. If you add content to the default or replacement paragraph object, the content appears in front of the variable content in the generated report.

Attributes:

GetAccess	public
SetAccess	public

TextFormatter — Text formatter

mlreportgen.dom.Text object

Text formatter to format the name and value of the model variable when the text is in line with the surrounding text, specified as an mlreportgen.dom.Text object. To customize the appearance of the text, modify the properties of the default mlreportgen.dom.Text object or replace the object with a customized mlreportgen.dom.Text object. If you add content to the default or replacement text object, the content appears in front of the variable content in the generated report.

Attributes:

GetAccess	public
SetAccess	public

MaxCols — Maximum number of table columns to display

32 (default) | positive integer

Maximum number of table columns to display, specified as a positive integer. For array variables reported using a table, if the number of columns is greater than the value of the MaxCols property, the table is sliced vertically. Slicing divides the table into multiple tables.

Attributes:

GetAccess	public
SetAccess	public

Data Types: int32

DepthLimit — Maximum number of nested levels to report

10 (default) | nonnegative integer

Maximum number of levels to report for a variable that is a structured object or an array of structured objects, specified as a nonnegative integer. Levels less than or equal to the value of DepthLimit are flattened into a sequence of interlinked tables (see the FormatPolicy property). Levels greater than the depth limit are not reported. If you set the DepthLimit property to 0, structured objects are not expanded.

Attributes:

GetAccess	public
SetAccess	public

Data Types: int32

ObjectLimit — Maximum number of nested objects to report

200 (default) | positive integer

Maximum number of objects in an object hierarchy to report, specified as a positive integer.

Attributes:

GetAccess	public
SetAccess	public

Data Types: int32

IncludeTitle — Whether to include title

1 (true) (default) | 0 (false)

Whether to include a title, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include a title containing the variable name and optionally, the data type. By default, the title includes only the name of the variable. To also include the data type of the variable, set the ShowDataType property to true.

• 0 (false) — Omit a title.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

Title — Title of variable to report

[] (default) | character vector | string scalar | mlreportgen.dom.Text object | mlreportgen.dom.InternalLink object | mlreportgen.dom.ExternalLink object

Title of variable to report, specified as a character vector, string scalar, mlreportgen.dom.Text object, mlreportgen.dom.InternalLink object, or mlreportgen.dom.ExternalLink object.

If the FormatPolicy property is set to "Inline Text" and the Title property is set to:

• A DOM object, the formatting specified by the DOM object is ignored

• An mlreportgen.dom.InternalLink or mlreportgen.dom.ExternalLink object, the link text is used for the title, but the title is not a link

In both cases, to format the title, use the TextFormatter property of this ModelVariable reporter.

If you do not specify the Title property, the title is the variable name.

Attributes:

GetAccess	public
SetAccess	public

ShowDataType — Whether to show data type of variable in title

0 (false) (default) | 1 (true)

Whether to show the data type of the variable in the title, specified as a logical 1 (true) or 0 (false). When you specify:.

• 1 (true) — Show the data type of the variable in the title.

• 0 (false) — Omit the data type of the variable in the title

  .

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ShowEmptyValues — Whether to show properties that have empty values

1 (true) (default) | 0 (false)

Whether to show properties that have empty values, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Show properties that have empty values.

• 0 (false) — Omit properties that have empty values.

Note

The ShowEmptyValues property applies only to MATLAB object, Simulink object, and Stateflow object variables.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ShowDefaultValues — Whether to show properties that use default values

1 (true) (default) | 0 (false)

Whether to show properties that use the default value, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Show properties that use default values.

• 0 (false) — Omit properties that do not use default values.

Note

The ShowDefaultValues property applies only to MATLAB object, Simulink object, and Stateflow object variables.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

PropertyFilterFcn — Function or expression to filter properties of a reported model variable

[] (default) | function handle | string scalar | character vector

Function or expression to filter the properties of a reported model variable from a report. Specify a function as a function handle. Specify an expression as a character vector or string scalar. This property applies only to a variable that contains an object. If you do not provide PropertyFilterFcn, all properties of the model variable are included in the report.

If you provide a function handle, the associated function must:

• Take these arguments:

  • variableName — Name of the variable being reported

  • variableObject — The variable being reported

  • propertyName — Name of the property of the variable being reported

• Return true to filter the specified property from the report, or false to include the property in the report.

For example, this code prevents the display of the Description and Complexity properties of a Simulink.Parameter object.

import slreportgen.finder.*
import slreportgen.report.*

rpt = slreportgen.report.Report("modelvarrpt","pdf");

model = "sldemo_mdlref_datamngt";
openExample(model); 

finder = slreportgen.finder.ModelVariableFinder(model);

while hasNext(finder)
    result = next(finder);
    varRptr = getReporter(result);
    varRptr.PropertyFilterFcn = @varPropertyFilter;
    add(rpt,varRptr);
end

close(rpt);

close_system(model);
rptview(rpt);

function tf = varPropertyFilter(~, variableObject,propertyName)
if isa(variableObject, "Simulink.Parameter")
    tf = (propertyName == "Description") ||  ...
        (propertyName == "Complexity");
else
    tf = false;
end
end

If you provide a string scalar or a character vector, it must contain an expression. The expression:

• Can use the variables variableName, variableObject, and propertyName

• Must set the variable isFiltered to true to filter the specified property from the report, or false to include the property in the report

For example, this code filters the CoderInfo property of a Simulink.Parameter object from the report.

import slreportgen.finder.*
import slreportgen.report.*

rpt = slreportgen.report.Report("modelvarrpt","pdf");

model = "sldemo_mdlref_datamngt";
openExample(model);

finder = slreportgen.finder.ModelVariableFinder(model);

while hasNext(finder)
    result = next(finder);
    varRptr = getReporter(result);
    
    varRptr.PropertyFilterFcn = "isFiltered = " + ...
        "isa(variableObject, ""Simulink.Parameter"") && " + ...
        "propertyName == ""CoderInfo"";";
    add(rpt,varRptr);
end

close(rpt);
close_system(model);
rptview(rpt);

Attributes:

GetAccess	public
SetAccess	public

NumericFormat — Format or precision used to display noninteger numeric values

"%.2f" (default) | string scalar | character vector | positive integer

Format or precision used to display noninteger numeric values.

Specify the format as a string scalar or a character vector. See the formatSpec argument on the sprintf reference page.

Specify the precision as a positive integer. See the precision argument on the num2str reference page.

Example: "%.2f" displays double values with two digits to the right of the decimal place.

Example: 2 displays a maximum number of two significant digits.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double | char | string

TemplateSrc — Source of template for this reporter

character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified in one of these ways:

• Character vector or string scalar that specifies the path of the file that contains the template for this reporter

• Reporter or report whose template this reporter uses or whose template library contains the template for this reporter

• Document Object Model (DOM) document or document part whose template this reporter uses or whose template library contains the template for this reporter

The specified template must be the same type as the report to which you append this reporter. For example, for a Microsoft^® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true
Dependent	true

TemplateName — Name of template for this reporter

character vector | string scalar

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template specified by the TemplateSrc property of this reporter.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget object. A character vector or string scalar value converts to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

Method	Purpose
getVariableName	Get name of variable from model variable reporter
getVariableValue	Get value of variable from model variable reporter
slreportgen.report.ModelVariable.createTemplate	Create reporter template template = createTemplate(templatePath,templateType) creates a copy of the default template for the report type specified by templateType at the location specified by templatePath. You can use the copied template as a starting point to design a custom reporter template for your report. Input Arguments templatePath — Target path and file name for template file, specified as a character vector or a string scalar. templateType — Template type, specified as "html", "docx", or "pdf" Return Values template — Path and file name of the template copy, returned as a string scalar For more information, see the method for the Reporter class, slreportgen.report.Reporter.createTemplate.
slreportgen.report.ModelVariable.customizeReporter	Create reporter from slreportgen.report.ModelVariable class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of slreportgen.report.ModelVariable at the location specified by classPath. The method copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom reporter class. Input Arguments classPath — Path and name of the new class definition file, specified as a character vector or string scalar Return Values classPathOut — Path and file name of the new class, returned as a string scalar For more information, see the method for the slreportgen.report.Reporter class, slreportgen.report.Reporter.customizeReporter.
slreportgen.report.ModelVariable.getClassFolder	Get location of folder that contains slreportgen.report.ModelVariable class definition file path = getClassFolder returns the path of the folder that contains the class definition file. Return Values path — Class definition file location, returned as a character vector For more information, see the method for the Reporter class, slreportgen.report.Reporter.getClassFolder.
copy	Create copy of reporter object and make deep copies of property values copiedObj = copy(reporterObj) returns a copy of the specified reporter object. The returned copy contains a deep copy of any property value of reporterObj that references a reporter, DOM object, or slreportgen.report.ReporterLayout object.As a result, you can modify the properties of the original or new object without affecting the other object. Input Arguments reporterObj — Reporter object to copy, specified as an object of a reporter class Return Values copiedObj — Copy of reporter, returned as an object of a reporter class For more information, see the method for the slreportgen.report.Reporter class, copy.
getImpl	Get implementation of reporter impl = getImpl(reporter,report) returns the Document Object Model (DOM) object that implements the reporter, reporter, when you append it to the report, report. Note You cannot add content to the reporter after calling this method. Input Arguments reporterObj— Reporter object, specified as an object of slreportgen.report.Reporter or an object of a subclass of slreportgen.report.Reporter report — Report, specified as a mlreportgen.report.Report object Return Values impl — Implementation object, returned as a DOM object. For more information, see the method for the slreportgen.report.Reporter class, getImpl.

Examples

Customize the Formatting of Model Variables in a Report

Customize the formatting of model variables in a report by iterating through the search results and setting properties of the model variable reporter for each result.

Create a report.

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

Create a chapter.

chapter = mlreportgen.report.Chapter();
chapter.Title = "Model Variable Reporter Example";

Load the model.

model_name = "sf_car";
load_system(model_name);

Find the variables in the model.

finder = slreportgen.finder.ModelVariableFinder(model_name);

For each result, get the ModelVariable reporter for the result, customize the formatting of numbers, and add the reporter to the chapter.

while hasNext(finder)
    result = next(finder);
    reporter = getReporter(result);
    reporter.NumericFormat = "%.4f";    
    add(chapter,reporter);
end

Add the chapter to the report.

add(rpt,chapter);

Close the report and open the viewer.

close(rpt);
rptview(rpt);

Generate Report of Model Variables, Diagrams, and Blocks

Generate a report that includes:

• A chapter for the model variables

• A chapter for each model diagram, with a section for the blocks in the diagram

Each block name in the Used By list for a model variable is a hyperlink to the corresponding content reported for the block.

% Create a Report
rpt = slreportgen.report.Report("MyReport","pdf");

% Load the model
model_name = "sf_car";
load_system(model_name);

% Create a Chapter for the Variables
chapter = mlreportgen.report.Chapter();
chapter.Title = "Model Variable Report for the "+model_name+" model";

% Find the variables in the model
finder = slreportgen.finder.ModelVariableFinder(model_name);

% Report on the variables
while hasNext(finder)
    result = next(finder);
    reporter = getReporter(result);
    add(chapter,reporter);
end
add(rpt,chapter);

% Add diagrams to the report
finder = slreportgen.finder.DiagramFinder(model_name);
while hasNext(finder)
    result = next(finder);
    ch = mlreportgen.report.Chapter(result.Name);
    add(ch, result);
    % Add a section for the blocks in the diagram
    sect = mlreportgen.report.Section("Title","Blocks");
    blFinder = slreportgen.finder.BlockFinder(result.Object);
    while hasNext(blFinder)
        blockresult = next(blFinder);
        add(sect,blockresult);
    end
    add(ch,sect);
    add(rpt, ch);
end

% Close and view the report
close(rpt);
rptview(rpt);
close_system(model_name);

Version History

Introduced in R2019b