slreportgen.report.FunctionReference Class

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

Reporter for MATLAB function references

Since R2022a

Description

Use objects of the slreportgen.report.FunctionReference class to report on MATLAB^® function references that are specifically used for calculating parameters in Simulink^® blocks. You can use a FunctionReference object to add these elements to your report:

• A table with details about how the function is referenced by model blocks

• A section with information about the function type

• A section with information about the MATLAB program file (.m) that defines the function

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

You do not create FunctionReference objects explicitly. To create a FunctionReference object, use the getReporter method with an object of the class slreportgen.finder.FunctionReferenceResult.

Properties

Object — MATLAB function to be reported

slreportgen.finder.FunctionReferenceResult object

MATLAB function to be reported, specified as an slreportgen.finder.FunctionReferenceResult object.

Attributes:

GetAccess	public
SetAccess	private

Data Types: slreportgen.finder.FunctionReferenceResult

ParagraphFormatter — Formatter for labels, function file path, and function type text

mlreportgen.dom.Paragraph object

Formatter for labels, function file path, and function type text, specified as an mlreportgen.dom.Paragraph object. This formatter determines the rendering of all labels, function type text, and function file path, if included in the report. To customize the rendering of these elements, customize the existing Paragraph object or assign and customize a new Paragraph object.

Note

If the FunctionFileDisplayPolicy is "code", this property affects only the label of the function code section. Use the MATLABCodeReporter property to customize the appearance of the function code.

Attributes:

GetAccess	public
SetAccess	public

Data Types: mlreportgen.dom.Paragraph

ShowFunctionType — Whether to include function type in report

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

Whether to include the function type in the report, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include the function type in the report.

• 0 (false) — Omit the function type in the report.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

References Table

Properties related to the references table, which contains information about blocks that reference the function.

ShowReferencesTable — Whether to include a references table in the report

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

Whether to include a references table in the report, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include a references table in the report.

• 0 (false) — Omit a references table in the report.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

Title — Title of references table

empty string (default) | character array | string scalar | mlreportgen.dom object

Title of references table, if included in the report, specified as one of the these values:

Value	Description
empty 0x0 string	The default title, in the format <function name> References
character vector or string scalar	Explicit title of table
mlreportgen.dom.Text object	The value of the Content property of the Text object
mlreportgen.dom.InternalLink object	Concatenation of the contents of the objects in the Children property of the InternalLink object
mlreportgen.dom.InternalLink object	Concatenation of the contents of the objects in the Children property of the ExternalLink object

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string | mlreportgen.dom.Text | mlreportgen.dom.InternalLink | mlreportgen.dom.ExternalLink

TableReporter — Formatter for references table

mlreportgen.report.BaseTable object

Formatter of the references table, if included in the report, specified as an mlreportgen.report.BaseTable object. The default value of this property is a BaseTable object with the TableStyleName property set to the FunctionReferenceTable style, which is defined in the default template for a FunctionReference reporter. To customize the references table, customize the existing BaseTable object or assign and customize a new BaseTable object.

Attributes:

GetAccess	public
SetAccess	public

Data Types: mlreportgen.report.BaseTable

Program File

Properties related to the section with information about the MATLAB program file (.m) that defines the referenced function.

ShowFunctionFile — Whether to include information about MATLAB program file

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

Whether to include information about the MATLAB program file, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include information about the MATLAB program file.

• 0 (false) — Omit information about the MATLAB program file.

The value of the FunctionFileDisplayPolicy determines which information about the file to include, the file content or the file path. In effect only for user-defined functions.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

FunctionFileDisplayPolicy — Whether to include content or path of the MATLAB program file

"code" (default) | "text"

Whether to include the content or the path of the MATLAB program file, specified as a logical 1 (true) or 0 (false). When you specify:

• "code" — Include the content of the MATLAB program file.

• "text" — Include the path of the MATLAB program file.

Note

In effect only for user-defined functions.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

MATLABCodeReporter — Formatter of MATLAB program file code

mlreportgen.report.MATLABCode object

Formatter of MATLAB program file code, if included in the report, specified as an mlreportgen.report.MATLABCode object. To customize the format of the code in the report, customize the existing MATLABCode object or assign and customize a new MATLABCode object.

Attributes:

GetAccess	public
SetAccess	public

Data Types: mlreportgen.report.MATLABCode

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.FunctionReference.getDefaultTemplatePath	templatePath = getDefaultTemplatePath(reporterObj,templateType) returns the path of the default template file, of the specified type, for an object of the class FunctionReference, reporterObj.
slreportgen.report.FunctionReference.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.FunctionReference.customizeReporter	Create reporter from slreportgen.report.FunctionReference class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of slreportgen.report.FunctionReference 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.FunctionReference.getClassFolder	Get location of folder that contains slreportgen.report.FunctionReference 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.

Version History

Introduced in R2022a