slreportgen.report.MATLABSystem Class

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

MATLAB System block reporter

Since R2023a

Description

Use an object of the slreportgen.report.MATLABSystem class to report on a Simulink^® MATLAB System block.

By default, a MATLABSystem reporter adds this information to a report:

• Simulink MATLAB System block properties

• A summary of the input and output arguments of the MATLAB System block

• MATLAB System block source code

Note

To use a MATLABSystem reporter in a report, you must create the report using the slreportgen.report.Report class.

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

reporter = slreportgen.report.MATLABSystem creates an empty MATLABSystem reporter based on the default template. Use the Object property to specify the Simulink MATLAB System block.

reporter = slreportgen.report.MATLABSystem(mlSysObj) sets the Object property to the MATLAB System block specified by mlSysObj.

reporter = MATLABSystem(PropertyName=Value) sets MATLABSystem reporter properties using name-value arguments. You can specify multiple name-value arguments in any order.

Properties

Object — MATLAB^® System block

[] (default) | character vector | string scalar | block handle | slreportgen.finder.BlockResult object | slreportgen.finder.DiagramElementResult object

MATLAB System to report, specified as one of these values:

• Character vector or string scalar that contains the path to a MATLAB System block

• Handle to a MATLAB System block

• slreportgen.finder.BlockResult object

• slreportgen.finder.DiagramElementResult object

Note

If you use a finder to find a MATLAB System block and add the result directly to a report, the finder returns an slreportgen.report.MATLABSystem reporter instead of a Simulink object property reporter.

Attributes:

GetAccess	public
SetAccess	public

IncludeObjectProperties — Whether to include object properties

true (default) | 0 (false)

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

• 1 (true) — Include a table of the properties of the MATLAB System block.

• 0 (false) — Omit a table of the properties of the MATLAB System block.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ObjectPropertiesReporter — Object properties reporter

mlreportgen.report.BaseTable object

Object properties reporter, specified as an mlreportgen.report.BaseTable object. The MATLABSystem reporter uses this reporter to create a table of the properties of the MATLAB System block.

To customize the appearance of the object property table and its title, customize the default BaseTable reporter or replace it with a custom version of the BaseTable reporter. To customize the title of the object property table, specify the contents in the Title property of the default or replacement reporter. The content you specify is placed at the front of the default title.

Attributes:

GetAccess	public
SetAccess	public

IncludeArgumentSummary — Whether to Include an argument summary

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

Whether to Include an argument summary, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include a summary table for the input and outputs arguments of the MATLAB Systemblock. By default, the argument summary table includes the name, scope, port, data type, and size for all the input and output arguments.

  Use the ArgumentSummaryProperties property to customize the set of properties to be reported in the summary table.

• 0 (false) — Omit a summary table for the input and outputs arguments of the MATLAB Systemblock.

If true, the report includes a summary table for the input and outputs arguments of the MATLAB Systemblock. By default, the argument summary table includes the name, scope, port, data type, and size for all the input and output arguments.

Use the ArgumentSummaryProperties property to customize the set of properties to be reported in the summary table.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ArgumentSummaryProperties — Argument properties to include

{"Name" "Scope" "Port" "Data Type" "Size" "Complex" Fixed Size"} (default) | cell array of character vectors | string array

Argument properties to include, specified as a cell array of character vectors or a string array.

Specify any combination of these properties:

• Name

• Scope

• Port

• Data Type

• Size

• Complex

• Fixed Size

Attributes:

GetAccess	public
SetAccess	public

ArgumentSummaryReporter — Argument summary reporter

mlreportgen.report.BaseTable object

Argument summary reporter, specified as a mlreportgen.report.BaseTable object. This property specifies the reporter to be used to create the summary table for the input and output arguments of the MATLAB System block. The default value of this property is a mlreportgen.report.BaseTable object. You can customize the appearance of the table by customizing the default reporter or by replacing it with a customized version of the BaseTable reporter. Any content that you specify in the Title property of the default or the replacement reporter will appear before the title in the generated report.

Attributes:

GetAccess	public
SetAccess	public

IncludeArgumentProperties — Whether to Include details for each argument

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

Whether to include a property table with detailed information for each argument, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include a property table with detailed information for each argument

  The argument summary table includes the name, scope, port, data type, and size for all the input and output arguments, as shown below:

  

  Use the ArgumentSummaryProperties property to customize the set of properties to be reported in the summary table.

• 0 (false) — Omit a property table with detailed information for each argument.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ArgumentPropertiesReporter — Argument properties reporter

mlreportgen.report.BaseTable object

Argument properties reporter, specified as an mlreportgen.report.BaseTable object. This property specifies the reporter to be used as the basis to create the property tables for the input and output arguments of the MATLAB System block. The MATLABSystem reporter creates a copy of this reporter for each argument to be reported and uses the copy to report on the properties of the argument. The default value of this property is a mlreportgen.report.BaseTable object. You can customize the appearance of the table by customizing the default reporter or by replacing it with a customized version of the BaseTable reporter. Any content that you specify in the Title property of the default or the replacement reporter will appear before the title in the generated report.

Attributes:

GetAccess	public
SetAccess	public

IncludeSourceCode — Whether to include the source code

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

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

• 1 (true) — Include the source code of the MATLAB System.

• 0 (false) — Omit the source code.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

SourceCodeReporter — Source code reporter

mlreportgen.report.MATLABCode object

Source code reporter, specified as a mlreportgen.report.MATLABCode object. This is the reporter to be used to report and format the source code of the MATLAB System. The default value of this property is an object of MATLABCode reporter type. To customize the code appearance, modify the properties of the default MATLABCode reporter or replace the reporter with a custom reporter.

Attributes:

GetAccess	public
SetAccess	public

SourceCodeTitle — Source code title

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

Source code title, specified as a character vector, string scalar, or an mlreportgen.dom.Paragraph object. SourceCodeTitle specifies a DOM Paragraph object for this reporter to fill with the title content for the MATLAB System source code. The default value of this property is an empty paragraph whose properties specify the appearance of the source code title. By default, the MATLABSystem reporter generates a title from the MATLAB System block name and appends it to the paragraph. The generated title consists of the MATLAB System block name followed by “Source Code”, for example, "Analysis and Plot Source Code." You can customize the title appearance by modifying the properties of the default paragraph object or by replacing it with another paragraph object. The content that you add to the paragraph appears before the title in the generated report.

Attributes:

GetAccess	public
SetAccess	public

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
slreportgen.report.MATLABSystem.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.MATLABSystem.customizeReporter	Create reporter from slreportgen.report.MATLABSystem class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of slreportgen.report.MATLABSystem 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.MATLABSystem.getClassFolder	Get location of folder that contains slreportgen.report.MATLABSystem 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

Report on a MATLAB System Block

Create a report from text file as a paragraph.

Import the report API namespace so that you do not have to use long fully qualified class names.

import slreportgen.report.*

Create a PFD report.

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

Load the model.

model_name = "slrgex_slexLawOfLargeNumbersExample";
mlSysObj = strcat(model_name,"/Analysis and Plot");
load_system(model_name);

Create a chapter.

chapter = mlreportgen.report.Chapter(mlSysObj);

Create a MATLABSystem reporter.

rptr = slreportgen.report.MATLABSystem(mlSysObj);

Add the MATLABSystem reporter to the chapter and chapter to report

append(chapter,rptr);
append(rpt,chapter);

Close and view the report.

close(rpt);
close_system(model_name);
rptview(rpt);

Version History

Introduced in R2023a