slreportgen.report.Reporter Class

Namespace: slreportgen.report

Superclass for Simulink reporters

Description

The slreportgen.report.Reporter class is a superclass for the Simulink^® Report API reporters and custom reporters that you create to report on Simulink models and model elements. The format of a reporter is based on a template.

Note

To use a subclass of slreportgen.report.Reporter in a report, you must create the report using the slreportgen.report.Report class or subclass.

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

reporter = slreportgen.report.Reporter creates an empty Simulink reporter.

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

Properties

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

slreportgen.report.Reporter.createTemplate	Create reporter template
slreportgen.report.Reporter.customizeReporter	Create class derived from slreportgen.report.Reporter class
slreportgen.report.Reporter.getClassFolder	Get location of folder containing slreportgen.report.Reporter class definition file
copy	Create copy of a Simulink reporter object and make deep copies of certain property values
getImpl	Get implementation of reporter

Tips

• Simulink Report Generator may compile a model during report generation, which can prevent MATLAB^® from closing if an error occurs. To uncompile a model that has active reporters, use the close method on the associated report.

Version History

Introduced in R2021a