slreportgen.report.Signal Class

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

Signal reporter

Description

Use an object of the slreportgen.report.Signal class to report the properties of a signal.

Signals are the outputs of dynamic systems that are represented by blocks in a Simulink diagram and by the diagram itself. See Signal Basics.

Note

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

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

reporter = slreportgen.report.Signal creates an slreportgen.report.Signal object with default property values. You must specify the signal to report by setting the Object property. Use other properties to customize the information reported and the formatting of the information.

reporter = slreportgen.report.Signal(object) sets the Object property to object.

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

Properties

Object — Block output port representing signal to report

[] (default) | handle

Block output port that represents the signal to report, specified as a handle. The signal reporter reports information about the properties of the output port and the properties of the line connected to the port.

ShowSimulinkSignalObject — Whether to report information about the Simulink.Signal object for this signal

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

Whether to report information about the Simulink.Signal object for this signal, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The signal reporter includes information about the Simulink.Signal object that specifies the attributes of the signal. The properties of the Simulink.Signal object are reported using an mlreportgen.report.MATLABVariable reporter. Use the MATLABVariableReporter property of this signal reporter to customize the appearance of the signal object information. If the signal is not associated with a signal object, nothing is reported.

• 0 (false) — Do not report information about the Simulink.Signal object.

MATLABVariableReporter — Reporter for Simulink.Signal object

mlreportgen.report.MATLABVariable object

Reporter for the Simulink.Signal object that defines the signal being reported, specified as an mlreportgen.report.MATLABVariable object. The default value is an empty MATLABVariable reporter with the DepthLimit property set to 0. The default reporter reports information about the Simulink.Signal object in a single table. To customize the appearance of the reported information, modify the properties of the default MATLABVariable reporter or replace the reporter with a customized MATLABVariable reporter. For example, the following code uses the PropertyFilterFcn property of the MATLABVariable reporter to display only specific properties of the Simulink.Signal object:

filterFcnHandle = @(variableName, variableObject, propertyName) ...
~ismember(propertyName, ["Description", "DataType", "Unit"]);
signalRptr.MATLABVariableReporter.PropertyFilterFcn = filterFcnHandle;

Some properties of signal objects, such as the CoderInfo property, have values that are also objects with properties. To display the properties of properties in separate tables, set the DepthLimit property of the MATLABVariableReporter to an integer that is greater than 0. For example:

signalRptr.MATLABVariableReporter.DepthLimit = 10;

PropertyTable — Signal properties table formatter

mlreportgen.report.BaseTable

Signal properties table formatter, specified as an mlreportgen.report.BaseTable object. The default value of this property is a BaseTable object with the TableStyleName property set to the SignalTable style, which is defined in the default template for a Signal reporter. To customize the appearance of the table, modify the properties of the default BaseTable object or replace the object with your own BaseTable object. If you add content to the Title property of the BaseTable object, the content appears in front of the table title in the generated report.

ShowEmptyValues — Whether to show properties with empty values

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

Choice to show properties with empty values.

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

• 1 (true) — Show properties with empty values in the table.

• 0 (false) — Omit properties with empty values from the table.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

Properties — Signal properties to report

["Name" "Description" "Source" "NonvirtualDestination" "DataType"] (default) | string array | cell array

Signal properties to report, specified as a string array or a cell array of character vectors. Specify any combination of these properties:

• Name

• Description

• Source

• Destination

• NonvirtualDestination

• DataType

• Complexity

• Dimensions

• Min

• Max

• SampleTime

Data Types: char | string | cell

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

Use an slreportgen.report.Signal object to include information about a signal in a report.

Import the MATLAB and Simulink Report API packages so that you do not have to use long, fully qualified class names.

import mlreportgen.report.*
import slreportgen.report.*

Load the vdp model.

model_name = "vdp";
load_system(model_name);

Create a Simulink report.

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

Add a diagram of the model to the report.

append(rpt,slreportgen.report.Diagram(model_name));

Get the port handle for the signal that you want to report.

ph = get_param("vdp/x1","PortHandles");
port = ph.Outport;

Create a chapter for the signal information.

ch = Chapter("x1");

Create a Signal reporter for the signal and append the reporter to the chapter.

signalRptr = slreportgen.report.Signal(port);
append(ch,signalRptr);

Add the chapter to the report. Close and view the report.

append(rpt,ch);
close(rpt);
rptview(rpt);

Version History

Introduced in R2021a