Main Content

slreportgen.report.Reporter Class

Namespace: slreportgen.report

Superclass for Simulink reporters

Since R2021a

expand all in page

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(Name=Value) sets properties using name-value pairs. You can specify multiple name-value pair arguments in any order.

Properties

expand all

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 is used for this reporter or whose template library contains the template for this reporter

  • DOM document or document part whose template is used for this reporter 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 report. 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.

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.

Data Types: char | string

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.

Methods

expand all

Version History

Introduced in R2021a

See Also

Topics